SCRIPT

Published on June 2016 | Categories: Documents | Downloads: 73 | Comments: 0 | Views: 2616
of x
Download PDF   Embed   Report

Comments

Content

Trademarks and Legal Notices
CAUTIONARY NOTICE TO USERS: This manual 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 manual 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. ABAQUS, Inc. will not be responsible for the accuracy or usefulness of any analysis performed using the ABAQUS Software or the procedures, examples, or explanations in this manual. ABAQUS, Inc. shall not be responsible for the consequences of any errors or omissions that may appear in this manual. ABAQUS, INC. DISCLAIMS ALL EXPRESS OR IMPLIED REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE OF THE CONTENTS OF THIS MANUAL. IN NO EVENT SHALL ABAQUS, INC. OR ITS THIRD-PARTY PROVIDERS BE LIABLE FOR ANY INDIRECT, INCIDENTAL, PUNITIVE, SPECIAL, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, OR LOSS OF BUSINESS INFORMATION) EVEN IF ABAQUS, INC. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. The ABAQUS Software described in this manual is available only under license from ABAQUS, Inc. and may be used or reproduced only in accordance with the terms of such license. This manual and the software described in this manual are subject to change without prior notice. No part of this manual may be reproduced or distributed in any form without prior written permission of ABAQUS, Inc. ©ABAQUS, Inc. 2004. All rights reserved. Printed in the United States of America. U.S. GOVERNMENT USERS: The ABAQUS Software and its documentation are “commercial items,” specifically “commercial computer software” and “commercial computer software documentation,” and consistent with FAR 12.212 and DFARS 227.7202, as applicable, are provided under license to the U.S. Government, with restricted rights. TRADEMARKS The trademarks and service marks (“trademarks) in this manual are the property of ABAQUS, Inc. or third parties. You are not permitted to use these trademarks without the prior written consent of ABAQUS, Inc. or such third parties. The following are trademarks or registered trademarks of ABAQUS, Inc. or its subsidiaries in the United States and/or other countries: ABAQUS, ABAQUS/Standard, ABAQUS/Explicit, ABAQUS/CAE, ABAQUS/Viewer, ABAQUS/Aqua, ABAQUS/Design, ABAQUS/Foundation, and the ABAQUS Logo. Other company, product, and service names may be trademarks or service marks of their respective owners. For additional information, see the Trademark and License Notices in the ABAQUS Version 6.5 Release Notes.

ABAQUS Offices and Representatives

ABAQUS, Inc. Rising Sun Mills 166 Valley Street Providence, RI 02909-2499 Tel: +1 401 276 4400 Fax: +1 401 276 4408 E-mail: [email protected] http://www.abaqus.com

ABAQUS Europe BV Gaetano Martinolaan 95 P. O. Box 1637 6201 BP Maastricht The Netherlands Tel: +31 43 356 6906 Fax: +31 43 356 6908 E-mail: [email protected] Sales, Support, and Services

UNITED STATES ABAQUS Central, Inc. 1440 Innovation Place West Lafayette, IN 47906-1000 Tel: +1 765 497 1373 Fax: +1 765 497 4444 E-mail: [email protected] ABAQUS Erie, Inc. 3601 Green Road, Suite 316 Beachwood, OH 44122 Tel: +1 216 378 1070 Fax: +1 216 378 1072 E-mail: [email protected] ABAQUS South, Inc. 3700 Forums Drive, Suite 101 Flower Mound, TX 75028 Tel: +1 214 513 1600 Fax: +1 214 513 1700 E-mail: [email protected] ARGENTINA KB Engineering S. R. L. Florida 274 - Oficina 35 1005 Buenos Aires Argentina Tel: +54 11 4326 9176/7542 Fax: +54 11 4326 2424 E-mail: [email protected] ABAQUS East, LLC 300 Centerville Road, Suite 209W Warwick, RI 02886-0201 Tel: +1 401 739 3637 Fax: +1 401 739 3302 E-mail: [email protected] ABAQUS Great Lakes, Inc. 14500 Sheldon Road, Suite 160 Plymouth, MI 48170-2408 Tel: +1 734 451 0217 Fax: +1 734 451 0458 E-mail: [email protected] ABAQUS West, Inc. 39221 Paseo Padre Parkway, Suite F Fremont, CA 94538-1611 Tel: +1 510 794 5891 Fax: +1 510 794 1194 E-mail: [email protected] AUSTRALIA Worley Advanced Analysis Level 17, 300 Flinders Street Melbourne, Vic 3000 Tel: +61 3 8612 5132 Fax: +61 3 9205 0573 E-mail: [email protected]

AUSTRIA ABAQUS Austria GmbH Zinckgasse 20-22/2/13 A-1150 Vienna Austria Tel: +43 1 929 16 25-0 Fax: +43 1 929 16 25-20 E-mail: [email protected] CHINA ABAQUS China Room A-2703, Eagle Plaza No. 26 Xiao Yun Rd. Beijing, 100016 P. R. China Tel: +86 01 84580366 Fax: +86 01 84580360 E-mail: [email protected] FRANCE ABAQUS France SAS 7 rue Jean Mermoz, Bat. A 78000 Versailles Tel: +33 01 39 24 15 40 Fax: +33 01 39 24 15 45 E-mail: [email protected] GERMANY (Munich) ABAQUS Deutschland GmbH Sendlinger-Tor-Platz 8 D-80336 München Tel: +49 89 5999 1768 Fax: +49 89 5999 1767 E-mail: [email protected] ITALY ABAQUS Italia s.r.l. Via Domodossola, 17 20145 Milano (MI) Tel: +39 02 39211211 Fax: +39 02 31800064 E-mail: [email protected]

BENELUX ABAQUS Benelux BV Huizermaatweg 576 1276 LN Huizen The Netherlands Tel: +31 35 52 58 424 Fax: +31 35 52 44 257 E-mail: [email protected] CZECH REPUBLIC Synerma s. r. o. Huntirov 58 468 22 Skuhrov Czech Republic Tel: +420 603 145 769 Fax: +420 603 181 944 E-mail: [email protected] GERMANY (Aachen) ABAQUS Deutschland GmbH Theaterstraße 30-32 D-52062 Aachen Tel: +49 241 474010 Fax: +49 241 4090963 E-mail: [email protected] INDIA (Chennai) ABAQUS Engineering India (Pvt.) Ltd. 3M, Prince Arcade 22-A Cathedral Road Chennai, 600 086 Tel: +91 44 28114624 Fax: +91 44 28115087 E-mail: [email protected] JAPAN (Tokyo) ABAQUS, Inc. 3rd Floor, Akasaka Nihon Building 5-24, Akasaka 9-chome, Minato-ku Tokyo, 107-0052 Tel: +81 3 5474 5817 Fax: +81 3 5474 5818 E-mail: [email protected]

JAPAN (Osaka) ABAQUS, Inc. 9th Floor, Higobashi Watanabe Building 6-10, Edobori 1-chome, Nishi-ku Osaka, 550-0002 Tel: +81 6 4803 5020 Fax: +81 6 4803 5021 E-mail: [email protected] MALAYSIA Worley Advanced Analysis 19th Floor, Empire Tower City Square Centre 182 Jalan Tun Razak 50400 Kuala Lumpur Tel: +60 3 2161 2266 Fax: +60 3 2161 4266 E-mail: [email protected] POLAND BudSoft Sp. z o.o. 61-807 Poznań Sw. Marcin 58/64 Tel: +48 61 8508 466 Fax: +48 61 8508 467 E-mail: [email protected] SINGAPORE Worley Advanced Analysis 491B River Valley Road #09-01 Valley Point Singapore, 248373 Tel: +65 6735 8444 Fax: +65 6735 7444 E-mail: [email protected]

KOREA ABAQUS Korea, Inc. Suite 306, Sambo Building 13-2 Yoido-Dong, Youngdeungpo-ku Seoul, 150-010 Tel: +82 2 785 6707 Fax: +82 2 785 6709 E-mail: [email protected] NEW ZEALAND Matrix Applied Computing Ltd. P. O. Box 56-316, Auckland Courier: Unit 2-5, 72 Dominion Road, Mt Eden, Auckland Tel: +64 9 623 1223 Fax: +64 9 623 1134 E-mail: [email protected] RUSSIA, BELARUS & UKRAINE TESIS Ltd. Office 701-703, 18, Unnatov Str. 127083 Moscow, Russia Tel: +7 095 212-44-22 Fax: +7 095 212-42-62 E-mail: [email protected] SOUTH AFRICA Finite Element Analysis Services (Pty) Ltd. Unit 4, The Waverley Wyecroft Road Mowbray 7700 Tel: +27 21 448 7608 Fax: +27 21 448 7679 E-mail: [email protected]

SPAIN Principia Ingenieros Consultores, S.A. Velázquez, 94 E-28006 Madrid Tel: +34 91 209 1482 Fax: +34 91 575 1026 E-mail: [email protected] TAIWAN APIC 11F, No. 71, Sung Chiang Road Taipei, 10428 Tel: +886 02 25083066 Fax: +886 02 25077185 E-mail: [email protected]

SWEDEN ABAQUS Scandinavia FEM-Tech AB Pilgatan 8c SE-72130 Västerås Tel: +46 21 12 64 10 Fax: +46 21 18 12 44 E-mail: [email protected] THAILAND Worley Advanced Analysis 333 Lao Peng Nguan 1 Building 20th Floor Unit B Soi Chaypuang Vibhavadi-Rangsit Road Ladyao, Jatujak Bangkok 10900 Thailand Tel: +66 2 689 3000 Fax: +66 2 618 8109 E-mail: [email protected] UNITED KINGDOM (Cheshire) ABAQUS UK Ltd. The Genesis Centre Science Park South, Birchwood Warrington, Cheshire WA3 7BH Tel: +44 1 925 810166 Fax: +44 1 925 810178 E-mail: [email protected]

TURKEY A-Ztech Ltd. Perdemsac Plaza, Teknoloji Evi Bayar Cad., Gulbahar Sok., No: 17 Kozyatagi 34742 Istanbul TURKIYE Tel: +90 216 361 8850 Fax: +90 216 361 8851 E-mail: [email protected]

Sales Only UNITED STATES ABAQUS East, LLC, Mid-Atlantic Office 114 Zachary Court Forest Hill, MD 21050 Tel: +1 410 420 8587 Fax: +1 410 420 8908 E-mail: [email protected] ABAQUS West, Inc., Southern CA and AZ Office 1100 Irvine Boulevard #248 Tustin, CA 92780 Tel: +1 714 731 5895 Fax: +1 714 242 7002 E-mail: [email protected] FINLAND ABAQUS Finland Oy Tekniikantie 12 FIN-02150 Espoo Tel: +358 9 2517 2973 Fax: +358 9 2517 2200 E-mail: [email protected] UNITED KINGDOM (Kent) ABAQUS UK Ltd. Great Hollanden Business Centre, Unit A Mill Lane, Underriver Sevenoaks, Kent TN15 OSQ Tel: +44 1 732 834930 Fax: +44 1 732 834720 E-mail: [email protected] ABAQUS South, Inc., Southeast Office 484 Broadstone Way Acworth, GA 30101 Tel: +1 770 795 0960 Fax: +1 770 795 7614 E-mail: [email protected] ABAQUS West, Inc., Rocky Mountains Office 6910 Cordwood Ct. Boulder, CO 80301 Tel: +1 303 664 5444 Fax: +1 303 200 9481 E-mail: [email protected] INDIA (Pune) ABAQUS Engineering Analysis Solutions (Pvt.) Ltd. C-9, 3rd Floor Bramha Estate, Kondwa Road Pune-411040 Tel: +91 20 30913739 E-mail: [email protected]

Preface

This section lists various resources that are available for help with using ABAQUS, including technical engineering and systems support, training seminars, and documentation.
Support

ABAQUS, Inc., offers both technical engineering support and systems support for ABAQUS. Technical engineering and systems support are provided through the nearest local support office. You can contact our offices by telephone, fax, electronic mail, the ABAQUS web-based support system, or regular mail. Information on how to contact each office is listed in the front of each ABAQUS manual. The ABAQUS Online Support System (AOSS) is accessible through the MY ABAQUS section of the ABAQUS Home Page (www.abaqus.com). When contacting your local support office, please specify whether you would like technical engineering support (you have encountered problems performing an ABAQUS analysis or creating a model in ABAQUS) or systems support (ABAQUS will not install correctly, licensing does not work correctly, or other hardware-related issues have arisen). The ABAQUS Online Support System has a knowledge database of ABAQUS Answers. The ABAQUS Answers are solutions to questions that we have had to answer or guidelines on how to use ABAQUS. We welcome any suggestions for improvements to the support program or documentation. We will ensure that any enhancement requests you make are considered for future releases. If you wish to file a complaint about the service or products provided by ABAQUS, refer to the ABAQUS Home Page.
Technical engineering support

ABAQUS technical support engineers can assist in clarifying ABAQUS features and checking errors by giving both general information on using ABAQUS and information on its application to specific analyses. If you have concerns about an analysis, we suggest that you contact us at an early stage, since it is usually easier to solve problems at the beginning of a project rather than trying to correct an analysis at the end. Please have the following information ready before calling the technical engineering support hotline, and include it in any written contacts:

• •

Your site identifier, which can be obtained by typing abaqus whereami at your system prompt (or by selecting Help→On Version from the main menu bar in ABAQUS/CAE or ABAQUS/Viewer). The version of ABAQUS that are you using. – The version numbers for ABAQUS/Standard and ABAQUS/Explicit are given at the top of the data (.dat) file. – The version numbers for ABAQUS/CAE and ABAQUS/Viewer can be found by selecting Help→On Version from the main menu bar. – The version numbers for the ABAQUS Interface for MOLDFLOW and the ABAQUS Interface for MSC.ADAMS are output to the screen. – The version number for ABAQUS for CATIA V5 can be found by selecting Help→About ABAQUS for CATIA V5 from the main menu bar in either of the ABAQUS for CATIA V5 workbenches.

i

• • •

The type of computer on which you are running ABAQUS. The symptoms of any problems, including the exact error messages, if any. Workarounds or tests that you have already tried.

When calling for support about a specific problem, any available ABAQUS output files may be helpful in answering questions that the support engineer may ask you. The support engineer will try to diagnose your problem from the model description and a description of the difficulties you are having. The support engineer may need model sketches, which can be sent via fax, e-mail, or regular mail. Plots of the final results or the results near the point that the analysis terminated may also be needed to understand what may have caused the problem. If the support engineer cannot diagnose your problem from this information, you may be asked to supply the input data. The data can be attached to a support incident in the ABAQUS Online Support System. It may also be sent by means of e-mail, tape, disk, or ftp. Please check the ABAQUS Home Page (http://www.abaqus.com) for the media formats that are currently accepted. All support incidents are tracked in the ABAQUS Online Support System. This enables you (as well as the support engineer) to monitor the progress of a particular problem and to check that we are resolving support issues efficiently. To use the ABAQUS Online Support System, you need to register with the system. Visit the MY ABAQUS section of the ABAQUS Home Page for instructions on how to register. If you are contacting us by means outside the AOSS 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 and, thus, give you more efficient support as well as avoid duplication of effort. In addition, please give the receptionist the support engineer’s name if contacting us via telephone or include it at the top of any e-mail correspondence.
Systems support

ABAQUS systems support engineers can help you resolve issues related to the installation and running of ABAQUS, including licensing difficulties, that are not covered by technical engineering support. You should install ABAQUS by carefully following the instructions in the ABAQUS Installation and Licensing Guide. If you are able to complete the installation, please make sure that the product verification procedure was run successfully at the end of the installation procedure. Successful verification for licensed products would indicate that you can run these products on your computer; unsuccessful verification for licensed products indicates problems with the installation or licensing (or both). If you encounter problems with the installation, licensing, or verification, first review the instructions in the ABAQUS Installation and Licensing Guide to ensure that they have been followed correctly. If this does not resolve the problems, consult the ABAQUS Answers database in the ABAQUS Online Support System for information about known installation problems. If this does not address your situation, please create an incident in the AOSS and describe your problem, including the output from abaqus info=support. If you call, mail, e-mail, or fax us about a problem (instead of using the AOSS), please provide the output from abaqus info=support. It is important that you provide as much information as possible about your problem: error messages from an aborted analysis, output from the abaqus info=support command, etc.

ii

ABAQUS Web server

For users connected to the Internet, many questions can be answered by visiting the ABAQUS Home Page on the World Wide Web at http://www.abaqus.com The information available on the ABAQUS Home Page includes:

• • • • • • • •

Link to the AOSS ABAQUS systems information and computer requirements ABAQUS performance data Error status reports ABAQUS documentation price list Training seminar schedule ABAQUS Insights newsletter Technology briefs

Anonymous ftp site

For users connected to the Internet, ABAQUS maintains useful documents on an anonymous ftp account on the computer ftp.abaqus.com. Simply ftp to ftp.abaqus.com. Login as user anonymous, and type your e-mail address as your password. Directions will come up automatically upon login.
Writing to technical support

Address of ABAQUS Headquarters: ABAQUS, Inc. 166 Valley Street Providence, RI 02909, USA Attention: Technical Support Addresses for other offices and representatives are listed in the front of each manual.
Support for academic institutions

Under the terms of the Academic License Agreement we do not provide support to users at academic institutions. Academic users can purchase technical support on an hourly basis. For more information, please see the ABAQUS Home Page or contact your local ABAQUS support office.
Training

All ABAQUS offices offer regularly scheduled public training classes.

iii

The Introduction to ABAQUS seminar covers basic modeling using ABAQUS/CAE and linear and nonlinear applications, such as large deformation, plasticity, contact, and dynamics using ABAQUS/Standard and ABAQUS/Explicit. Workshops provide as much practical experience with ABAQUS as possible. Advanced seminars cover topics of interest to customers with experience using ABAQUS, such as engine analysis, metal forming, fracture mechanics, and heat transfer. We also provide training seminars at customer sites. On-site training seminars can be one or more days in duration, depending on customer requirements. The training topics can include a combination of material from our introductory and advanced seminars. Workshops allow customers to exercise ABAQUS on their own computers. For a schedule of seminars, see the ABAQUS Home Page or call ABAQUS, Inc., or your local ABAQUS representative.
Documentation

The following documentation and publications are available from ABAQUS, unless otherwise specified, in printed form and through the ABAQUS online documentation. For more information on accessing the online books, refer to the discussion of execution procedures in the ABAQUS Analysis User’s Manual.
Modeling and Visualization



ABAQUS/CAE User’s Manual: This reference document for ABAQUS/CAE includes detailed descriptions of how to use ABAQUS/CAE for model generation, analysis, and results evaluation and visualization. ABAQUS/Viewer users should refer to the information on the Visualization module in this manual.

Analysis



ABAQUS Analysis User’s Manual: This volume contains a complete description of the elements, material models, procedures, input specifications, etc. It is the basic reference document for ABAQUS/Standard and ABAQUS/Explicit. Both input file usage and ABAQUS/CAE usage information are provided in this manual.

Examples





This volume contains more than 125 detailed examples designed to illustrate the approaches and decisions needed to perform meaningful linear and nonlinear analysis. Typical cases are large motion of an elastic-plastic pipe hitting a rigid wall; inelastic buckling collapse of a thin-walled elbow; explosive loading of an elastic, viscoplastic thin ring; consolidation under a footing; buckling of a composite shell with a hole; and deep drawing of a metal sheet. It is generally useful to look for relevant examples in this manual and to review them when embarking on a new class of problem. ABAQUS Benchmarks Manual: This online-only volume contains over 250 benchmark problems and standard analyses used to evaluate the performance of ABAQUS; the tests are multiple element tests of simple geometries or simplified versions of real problems. The NAFEMS benchmark problems are included in this manual.
ABAQUS Example Problems Manual:

iv

Training



Getting Started with ABAQUS: This document is a self-paced tutorial designed to help new users become familiar with using ABAQUS/CAE to create solid, shell, and framework models and ABAQUS/Standard or ABAQUS/Explicit to perform static, quasi-static, and dynamic stress analysis simulations. It contains a number of fully worked examples that provide practical guidelines for performing structural analyses with ABAQUS. In addition, three comprehensive tutorials are provided to introduce users familiar with the ABAQUS solver products to the ABAQUS/CAE interface. Getting Started with ABAQUS/Standard: Keywords Version:

• • •

This online-only document is designed to help new users become familiar with the ABAQUS/Standard input file syntax for static and dynamic stress analysis simulations. The ABAQUS/Standard keyword interface is used to model examples similar to those included in Getting Started with ABAQUS.

Getting Started with ABAQUS/Explicit: Keywords Version: This online-only document is designed to help new users become familiar with the ABAQUS/Explicit input file syntax for quasi-static and dynamic stress analysis simulations. The ABAQUS/Explicit keyword interface is used to model examples similar to those included in Getting Started with ABAQUS. Lecture Notes: These notes are available on many topics to which ABAQUS is applied. They are used in the technical seminars that ABAQUS, Inc., presents to help users improve their understanding and usage of ABAQUS (see the “Training” section above for more information about these seminars). While not intended as stand-alone tutorial material, they are sufficiently comprehensive that they can usually be used in that mode. The list of available lecture notes is included in the Documentation Price List.

Documentation Information



Using ABAQUS Online Documentation: This online-only manual contains instructions for viewing and searching the ABAQUS online documentation.

Reference

• • •

ABAQUS Keywords Reference Manual:

This volume contains a complete description of all the input options that are available in ABAQUS/Standard and ABAQUS/Explicit.

ABAQUS Theory Manual: This online-only volume contains detailed, precise discussions of all theoretical aspects of ABAQUS. It is written to be understood by users with an engineering background. ABAQUS Verification Manual: This online-only volume describes more than 12,000 basic test cases, providing verification of each individual program feature (procedures, output options, MPCs, etc.) against exact calculations and other published results. It may be useful to run these problems when learning to use a new capability. In addition, the supplied input data files provide good starting points to check the behavior of elements, materials, etc. Quality Assurance Plan: This document describes the QA procedures followed by ABAQUS. It is a controlled document, provided to customers who subscribe to either the Nuclear QA Program or the Quality Monitoring Service.



v

Update Information



ABAQUS Release Notes: This document contains brief descriptions of the new features available in the latest release of the ABAQUS product line.

Programming



ABAQUS Scripting User’s Manual: This online-only manual provides a description of the ABAQUS Scripting Interface. The manual describes how commands can be used to create and analyze ABAQUS/CAE models, to view the results of the analysis, and to automate repetitive tasks. It also contains information on using the ABAQUS Scripting Interface or C++ as an application programming interface (API) to the output database. ABAQUS Scripting Reference Manual: This online-only manual provides a command reference that lists the syntax of each command in the ABAQUS Scripting Interface. ABAQUS GUI Toolkit User’s Manual: This online-only manual provides a description of the ABAQUS GUI Toolkit. The manual describes the components and organization of the ABAQUS GUI. It also describes how you can customize the ABAQUS GUI to build a particular application. ABAQUS GUI Toolkit Reference Manual:

• • •

This online-only manual provides a command reference that lists the syntax of each command in the ABAQUS GUI Toolkit.

Interfaces

• •

ABAQUS Interface for MSC.ADAMS User’s Manual: This document describes how to use the ABAQUS Interface for MSC.ADAMS, which creates ABAQUS models of MSC.ADAMS components and converts the ABAQUS results into an MSC.ADAMS modal neutral file that can be used by the ADAMS/Flex program. It is the basic reference document for the ABAQUS Interface for MSC.ADAMS. ABAQUS Interface for MOLDFLOW User’s Manual: This document describes how to use the ABAQUS Interface for MOLDFLOW, which creates a partial ABAQUS input file by translating results from a MOLDFLOW polymer processing simulation. It is the basic reference document for the ABAQUS Interface for MOLDFLOW.

Installation and Licensing



ABAQUS Installation and Licensing Guide:

This document describes how to install ABAQUS and how to configure the installation for particular circumstances. Some of this information, of most relevance to users, is also provided in the ABAQUS Analysis User’s Manual.

vi

CONTENTS

CONTENTS

PART I
1. Amplitude commands

PYTHON COMMANDS

Amplitude object BaselineCorrection object DecayAmplitude object EquallySpacedAmplitude object ModulatedAmplitude object PeriodicAmplitude object SmoothStepAmplitude object SolutionDependentAmplitude object TabularAmplitude object
2. Animation commands

1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 1.9

AnimationPlayer object PlayerOptions object AnimationOptions object AVIOptions object ImageAnimationOptions object QuickTimeOptions object ScaleFactorMovieOptions object Session object TimeHistoryMovieOptions object
3. Annotation commands

2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9

Annotation object AnnotationsToPlotArray object Arrow object Text object
4. Assembly commands

3.1 3.2 3.3 3.4

Assembly object Feature object PartInstance object

4.1 4.2 4.3

vii

CONTENTS

5.

Basic geometry commands

Cell object CellArray object Edge object EdgeArray object Face object FaceArray object InterestingPoint object ModelDot object ReferencePoint object Transform object Vertex object VertexArray object
6. Beam Section profile commands

5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.10 5.11 5.12

Profile object ArbitraryProfile object BoxProfile object CircularProfile object GeneralizedProfile object HexagonalProfile object IProfile object LProfile object PipeProfile object RectangularProfile object TProfile object TrapezoidalProfile object
7. Boundary Condition commands

6.1 6.2 6.3 6.4 6.5 6.6 6.7 6.8 6.9 6.10 6.11 6.12

BoundaryCondition object AccelerationBC object AccelerationBCState object AcousticPressureBC object AcousticPressureBCState object BoundaryConditionState object ConcentrationBC object ConcentrationBCState object ConnAccelerationBC object ConnAccelerationBCState object ConnDisplacementBC object ConnDisplacementBCState object

7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 7.9 7.10 7.11 7.12

viii

CONTENTS

ConnVelocityBC object ConnVelocityBCState object DisplacementBC object DisplacementBCState object ElectricPotentialBC object ElectricPotentialBCState object PorePressureBC object PorePressureBCState object SubmodelBC object SubmodelBCState object TemperatureBC object TemperatureBCState object TypeBC object TypeBCState object VelocityBC object VelocityBCState object
8. Canvas commands

7.13 7.14 7.15 7.16 7.17 7.18 7.19 7.20 7.21 7.22 7.23 7.24 7.25 7.26 7.27 7.28

Layer object Viewport object
9. Connector commands

8.1 8.2

Connector object ConnectorBehaviorOption object ConnectorDamage object ConnectorDamping object ConnectorElasticity object ConnectorFailure object ConnectorFriction object ConnectorLock object ConnectorPlasticity object ConnectorProperty object ConnectorStop object TangentialBehavior object
10. Constraint commands

9.1 9.2 9.3 9.4 9.5 9.6 9.7 9.8 9.9 9.10 9.11 9.12

Constraint object Coupling object DisplayBody object EmbeddedRegion object Equation object

10.1 10.2 10.3 10.4 10.5

ix

CONTENTS

RigidBody object ShellSolidCoupling object Tie object
11. CustomKernel module

10.6 10.7 10.8

CommandRegister object RepositorySupport object RegisteredDictionary object RegisteredList object RegisteredTuple object
12. Datum commands

11.1 11.2 11.3 11.4 11.5

Datum object DatumAxis object DatumCsys object DatumPlane object DatumPoint object
13. Display Group commands

12.1 12.2 12.3 12.4 12.5

DisplayGroup object DisplayGroupInstance object DisplayGroupInstanceRepository object Leaf object LeafFromDatums object LeafFromDisplayGroup object LeafFromElementLabels object LeafFromElementSets object LeafFromElementVarRange object LeafFromGeometry object LeafFromInstance object LeafFromInstanceElementLabels object LeafFromInstanceNodeLabels object LeafFromMeshElementLabels object LeafFromMeshNodeLabels object LeafFromMeshSurfaceSets object LeafFromModelElemLabels object LeafFromModelNodeLabels object LeafFromNodeLabels object LeafFromNodeSets object LeafFromNodeVarRange object LeafFromOdbElementMaterials object

13.1 13.2 13.3 13.4 13.5 13.6 13.7 13.8 13.9 13.10 13.11 13.12 13.13 13.14 13.15 13.16 13.17 13.18 13.19 13.20 13.21 13.22

x

CONTENTS

LeafFromOdbElementPick object LeafFromOdbElementSections object LeafFromOdbElementTypes object LeafFromOdbNodePick object LeafFromPartElementLabels object LeafFromPartInstance object LeafFromPartNodeLabels object LeafFromReferencePoint object LeafFromSets object LeafFromSurfaceSets object LeafFromSurfaceVarRange object
14. Display Options commands

13.23 13.24 13.25 13.26 13.27 13.28 13.29 13.30 13.31 13.32 13.33

AssemblyDisplayOptions object BCDisplayOptions object ConstraintDisplayOptions object EngineeringFeatureDisplayOptions object FieldDisplayOptions object GeometryDisplayOptions object GraphicsInfo object GraphicsOptions object InteractionDisplayOptions object LoadDisplayOptions object MeshDisplayOptions object PartDisplayOptions object SymbolDisplayOptions object ViewportAnnotationOptions object
15. Edit mesh commands

14.1 14.2 14.3 14.4 14.5 14.6 14.7 14.8 14.9 14.10 14.11 14.12 14.13 14.14

Assembly object Part object
16. Engineering Feature commands

15.1 15.2

EngineeringFeature object ContourIntegral object Crack object HeatCapacitance object Inertia object NonstructuralMass object PointMassInertia object SpringDashpot object

16.1 16.2 16.3 16.4 16.5 16.6 16.7 16.8

xi

CONTENTS

SpringDashpotToGround object TwoPointSpringDashpot object
17. Feature commands

16.9 16.10

Feature object FeatureOptions object
18. Filter commands

17.1 17.2

Filter object ButterworthFilter object Chebyshev1Filter object Chebyshev2Filter object
19. Field commands

18.1 18.2 18.3 18.4

Field object BondedContact object Concentration object FieldState object GeneralField object GeneralFieldState object Hardening object InitialState object MassFlowRate object MassFlowRateState object PorePressure object PressureStress object PressureStressState object RelativeDensity object SDV object Saturation object SpudPreload object Stress object Temperature object TemperatureState object Velocity object VoidsRatio object
20. History and Field Report commands

19.1 19.2 19.3 19.4 19.5 19.6 19.7 19.8 19.9 19.10 19.11 19.12 19.13 19.14 19.15 19.16 19.17 19.18 19.19 19.20 19.21 19.22

FieldReportOptions object HistoryVariable object OdbFieldVarList object

20.1 20.2 20.3

xii

CONTENTS

OdbModelFieldVarList object writeFieldReport
21. Interaction commands

20.4 20.5

Interaction object ActuatorSensor object ActuatorSensorProp object ActuatorSensorState object CavityRadiation object CavityRadiationState object ConcentratedFilmCondition object ConcentratedFilmConditionState object ConcentratedRadiationToAmbient object ConcentratedRadiationToAmbientState object ContactControl object ContactExp object ContactProperty object ContactPropertyAssignment object Damping object ElasticFoundation object ElasticFoundationState object ElectricalConductance object ExpContactControl object FilmCondition object FilmConditionProp object FilmConditionState object GapHeatGeneration object InteractionProperty object InteractionState object MasterSlaveAssignment object NormalBehavior object Radiation object RadiationToAmbient object RadiationToAmbientState object RegionPairs object SelfContactExp object SelfContactExpState object SelfContactStd object SelfContactStdState object StdContactControl object SurfaceFeatureAssignment object SurfaceOffsetAssignment object

21.1 21.2 21.3 21.4 21.5 21.6 21.7 21.8 21.9 21.10 21.11 21.12 21.13 21.14 21.15 21.16 21.17 21.18 21.19 21.20 21.21 21.22 21.23 21.24 21.25 21.26 21.27 21.28 21.29 21.30 21.31 21.32 21.33 21.34 21.35 21.36 21.37 21.38

xiii

CONTENTS

SurfaceThicknessAssignment object SurfaceToSurfaceContactExp object SurfaceToSurfaceContactStd object SurfaceToSurfaceExpState object SurfaceToSurfaceStdState object TangentialBehavior object ThermalConductance object
22. Job commands

21.39 21.40 21.41 21.42 21.43 21.44 21.45

Job object Message object Queue object
23. Load commands

22.1 22.2 22.3

Load object BodyCharge object BodyChargeState object BodyConcentrationFlux object BodyConcentrationFluxState object BodyCurrent object BodyCurrentState object BodyForce object BodyForceState object BodyHeatFlux object BodyHeatFluxState object BoltLoad object BoltLoadState object ConcCharge object ConcentratedChargeState object ConcConcFlux object ConcentratedConcentrationFluxState object ConcCurrent object ConcCurrentState object ConcPoreFluid object ConcentratedPoreFluidState object ConcentratedForce object ConcentratedForceState object ConcentratedHeatFlux object ConcentratedHeatFluxState object ConnectorForce object ConnectorForceState object ConnectorMoment object

23.1 23.2 23.3 23.4 23.5 23.6 23.7 23.8 23.9 23.10 23.11 23.12 23.13 23.14 23.15 23.16 23.17 23.18 23.19 23.20 23.21 23.22 23.23 23.24 23.25 23.26 23.27 23.28

xiv

CONTENTS

ConnectorMomentState object Gravity object GravityState object HydrostaticFluidFlow object HydrostaticFluidFlowState object InertiaRelief object InertiaReliefState object InwardVolAccel object InwardVolAccelState object LineLoad object LineLoadState object LoadState object Moment object MomentState object PEGLoad object PEGLoadState object PipePressure object PipePressureState object Pressure object PressureState object RotationalBodyForce object RotationalBodyForceState object ShellEdgeLoad object ShellEdgeLoadState object SurfaceCharge object SurfaceChargeState object SurfaceConcentrationFlux object SurfaceConcentrationFluxState object SurfaceCurrent object SurfaceCurrentState object SurfaceHeatFlux object SurfaceHeatFluxState object SurfacePoreFluid object SurfacePoreFluidState object SurfaceTraction object SurfaceTractionState object
24. Load Case commands

23.29 23.30 23.31 23.32 23.33 23.34 23.35 23.36 23.37 23.38 23.39 23.40 23.41 23.42 23.43 23.44 23.45 23.46 23.47 23.48 23.49 23.50 23.51 23.52 23.53 23.54 23.55 23.56 23.57 23.58 23.59 23.60 23.61 23.62 23.63 23.64

LoadCase object
25. Material commands

24.1

Material object

25.1

xv

CONTENTS

AcousticMedium object AnnealTemperature object BiaxialTestData object CapCreepCohesion object CapCreepConsolidation object CapHardening object CapPlasticity object CastIronCompressionHardening object CastIronPlasticity object CastIronTensionHardening object ClayHardening object ClayPlasticity object CombinedTestData object Concrete object ConcreteCompressionDamage object ConcreteCompressionHardening object ConcreteDamagedPlasticity object ConcreteTensionDamage object ConcreteTensionStiffening object Conductivity object ContactArea object Creep object CrushableFoam object CrushableFoamHardening object CycledPlastic object CyclicHardening object Damping object DeformationPlasticity object Density object Depvar object DetonationPoint object Dielectric object Diffusivity object DruckerPrager object DruckerPragerCreep object DruckerPragerHardening object Elastic object ElectricalConductivity object Eos object EosShear object Expansion object FailStrain object

25.2 25.3 25.4 25.5 25.6 25.7 25.8 25.9 25.10 25.11 25.12 25.13 25.14 25.15 25.16 25.17 25.18 25.19 25.20 25.21 25.22 25.23 25.24 25.25 25.26 25.27 25.28 25.29 25.30 25.31 25.32 25.33 25.34 25.35 25.36 25.37 25.38 25.39 25.40 25.41 25.42 25.43

xvi

CONTENTS

FailStress object FailureRatios object GasketMembraneElastic object GasketThicknessBehavior object GasketTransverseShearElastic object Gel object HeatGeneration object Hyperelastic object Hyperfoam object Hypoelastic object Hysteresis object InelasticHeatFraction object JouleHeatFraction object LatentHeat object MohrCoulombHardening object MohrCoulombPlasticity object MoistureSwelling object Ornl object Permeability object Piezoelectric object PlanarTestData object Plastic object PoreFluidExpansion object PorousBulkModuli object PorousElastic object PorousFailureCriteria object PorousMetalPlasticity object Potential object PressureEffect object RateDependent object Ratios object Regularization object SaturationDependence object ShearRetention object ShearTestData object SimpleShearTestData object Solubility object SoretEffect object Sorption object SpecificHeat object Swelling object TensionStiffening object

25.44 25.45 25.46 25.47 25.48 25.49 25.50 25.51 25.52 25.53 25.54 25.55 25.56 25.57 25.58 25.59 25.60 25.61 25.62 25.63 25.64 25.65 25.66 25.67 25.68 25.69 25.70 25.71 25.72 25.73 25.74 25.75 25.76 25.77 25.78 25.79 25.80 25.81 25.82 25.83 25.84 25.85

xvii

CONTENTS

TriaxialTestData object Trs object UniaxialTestData object UserDefinedField object UserMaterial object UserOutputVariables object VelocityDependence object Viscoelastic object Viscous object VoidNucleation object VolumetricTestData object evaluateMaterial
26. Mdb commands

25.86 25.87 25.88 25.89 25.90 25.91 25.92 25.93 25.94 25.95 25.96 25.97

Mdb object Mdb commands
27. Mesh commands

26.1 26.2

Assembly object Part object ElemType object MeshEdge object MeshElement object MeshFace object MeshNode object MeshStats object
28. Messaging commands

27.1 27.2 27.3 27.4 27.5 27.6 27.7 27.8

MonitorMgr object DataObject object
29. Model commands

28.1 28.2

Model object KeywordBlock object
30. Odb commands

29.1 29.2

Odb object FieldLocation object FieldOutput object FieldValue object HistoryOutput object

30.1 30.2 30.3 30.4 30.5

xviii

CONTENTS

HistoryPoint object HistoryRegion object JobData object OdbAssembly object OdbConnector object OdbConnectorProperty object OdbDatumCsys object OdbFrame object OdbInstance object OdbLoadCase object OdbMeshElement object OdbMeshNode object OdbPart object OdbSet object OdbStep object ScratchOdb object SectionCategory object SectionPoint object SectorDefinition object UserData object Odb commands
31. Odb Display commands

30.6 30.7 30.8 30.9 30.10 30.11 30.12 30.13 30.14 30.15 30.16 30.17 30.18 30.19 30.20 30.21 30.22 30.23 30.24 30.25 30.26

OdbDisplay object DefaultOdbDisplay object AttributeColorMap object OdbDisplayOptions object ViewCut object ViewerOptions object
32. Part commands

31.1 31.2 31.3 31.4 31.5 31.6

Part object Feature object AcisFile object
33. 34. Partition commands Path and Probe commands

32.1 32.2 32.3

Path object CurrentProbeValues object NodeQuery object

34.1 34.2 34.3

xix

CONTENTS

ProbeOptions object ProbeReport object SelectedProbeValues object
35. Plot Options commands

34.4 34.5 34.6

BasicOptions object ContourOptions object DeformedShapeOptions object OptionArg object OrientationOptions object SymbolOptions object UndeformedShapeOptions object ViewCutOptions object
36. Plug-in registration commands

35.1 35.2 35.3 35.4 35.5 35.6 35.7 35.8

Kernel plug-in registration commands GUI plug-in registration commands
37. Print commands

36.1 36.2

PrintOptions object EpsOptions object PageSetupOptions object PngOptions object PsOptions object SvgOptions object TiffOptions object
38. Property commands

37.1 37.2 37.3 37.4 37.5 37.6 37.7

Reinforcement object SectionAssignment object Property assignment commands
39. Region commands

38.1 38.2 38.3

Assembly object Part object Region object Set object Surface object
40. Section commands

39.1 39.2 39.3 39.4 39.5

Section object

40.1

xx

CONTENTS

BeamSection object CohesiveSection object CompositeShellSection object GasketSection object GeometryShellSection object HomogeneousShellSection object HomogeneousSolidSection object LayerProperties object MembraneSection object PEGSection object RebarLayers object SectionLayer object ShellSection object SolidSection object SurfaceSection object TransverseShearBeam object TransverseShearShell object TrussSection object
41. Session commands

40.2 40.3 40.4 40.5 40.6 40.7 40.8 40.9 40.10 40.11 40.12 40.13 40.14 40.15 40.16 40.17 40.18 40.19

Session object Color object JournalOptions object NetworkDatabaseConnector object NumberFormat object
42. Sketcher commands

41.1 41.2 41.3 41.4 41.5

Sketch object SketchDimension object SketchGeometry object SketchOptions object SketcherOptions object
43. Step commands (step)

42.1 42.2 42.3 42.4 42.5

Step object AnalysisStep object AnnealStep object BuckleStep object ComplexFrequencyStep object CoupledTempDisplacementStep object CoupledThermalElectricStep object

43.1 43.2 43.3 43.4 43.5 43.6 43.7

xxi

CONTENTS

ExplicitDynamicsStep object FrequencyStep object GeostaticStep object HeatTransferStep object ImplicitDynamicsStep object InitialStep object MassDiffusionStep object ModalDynamicsStep object RandomResponseStep object ResponseSpectrumStep object SoilsStep object StaticLinearPerturbationStep object StaticRiksStep object StaticStep object SteadyStateDirectStep object SteadyStateModalStep object SteadyStateSubspaceStep object SubspaceDynamicsStep object TempDisplacementDynamicsStep object ViscoStep object
44. Step commands (miscellaneous)

43.8 43.9 43.10 43.11 43.12 43.13 43.14 43.15 43.16 43.17 43.18 43.19 43.20 43.21 43.22 43.23 43.24 43.25 43.26 43.27

AdaptiveMeshControl object AdaptiveMeshDomain object CompositeDamping object CompositeDampingComponent object Control object DirectDamping object DirectDampingByFrequency object DirectDampingByFrequencyComponent object DirectDampingComponent object MassScaling object RandomResponseFrequency object RayleighDamping object RayleighDampingByFrequency object RayleighDampingByFrequencyComponent object RayleighDampingComponent object ResponseSpectrumComponent object SolverControl object SteadyStateDirectFrequency object SteadyStateModalFrequency object SteadyStateSubspaceFrequency object

44.1 44.2 44.3 44.4 44.5 44.6 44.7 44.8 44.9 44.10 44.11 44.12 44.13 44.14 44.15 44.16 44.17 44.18 44.19 44.20

xxii

CONTENTS

StructuralDamping object StructuralDampingByFrequency object StructuralDampingByFrequencyComponent object StructuralDampingComponent object
45. Step commands (output)

44.21 44.22 44.23 44.24

DiagnosticPrint object FieldOutputRequest object FieldOutputRequestState object HistoryOutputRequest object HistoryOutputRequestState object IntegratedOutputSection object Monitor object Restart object
46. Text Representation commands

45.1 45.2 45.3 45.4 45.5 45.6 45.7 45.8

textRepr module TextReprOptions object
47. Utility commands

46.1 46.2

SymbolicConstant object Boolean object Repository object BackwardCompatibility object User input commands Status commands Executing commands Method callback command
48. View commands

47.1 47.2 47.3 47.4 47.5 47.6 47.7 47.8

View object
49. XY commands

48.1

XYData object XYCurve object XYCurveOptions object XYPlot object XYPlotOptions object XYReportOptions object Session object writeXYReport

49.1 49.2 49.3 49.4 49.5 49.6 49.7 49.8

xxiii

CONTENTS

PART II
50. 51. Beam Section profile commands Material commands

C++ COMMANDS

Material object AcousticMedium object AnnealTemperature object BiaxialTestData object CapCreepCohesion object CapCreepConsolidation object CapHardening object CapPlasticity object CastIronCompressionHardening object CastIronPlasticity object CastIronTensionHardening object ClayHardening object ClayPlasticity object CombinedTestData object Concrete object ConcreteCompressionDamage object ConcreteCompressionHardening object ConcreteDamagedPlasticity object ConcreteTensionDamage object ConcreteTensionStiffening object Conductivity object ContactArea object Creep object CrushableFoam object CrushableFoamHardening object CycledPlastic object CyclicHardening object Damping object DeformationPlasticity object Density object Depvar object DetonationPoint object Dielectric object Diffusivity object

51.1 51.2 51.3 51.4 51.5 51.6 51.7 51.8 51.9 51.10 51.11 51.12 51.13 51.14 51.15 51.16 51.17 51.18 51.19 51.20 51.21 51.22 51.23 51.24 51.25 51.26 51.27 51.28 51.29 51.30 51.31 51.32 51.33 51.34

xxiv

CONTENTS

DruckerPrager object DruckerPragerCreep object DruckerPragerHardening object Elastic object ElectricalConductivity object Eos object EosShear object Expansion object FailStrain object FailStress object FailureRatios object GasketMembraneElastic object GasketThicknessBehavior object GasketTransverseShearElastic object Gel object HeatGeneration object Hyperelastic object Hyperfoam object Hypoelastic object Hysteresis object InelasticHeatFraction object JouleHeatFraction object LatentHeat object MohrCoulombHardening object MohrCoulombPlasticity object MoistureSwelling object Ornl object Permeability object Piezoelectric object PlanarTestData object Plastic object PoreFluidExpansion object PorousBulkModuli object PorousElastic object PorousFailureCriteria object PorousMetalPlasticity object Potential object PressureEffect object RateDependent object Ratios object Regularization object SaturationDependence object

51.35 51.36 51.37 51.38 51.39 51.40 51.41 51.42 51.43 51.44 51.45 51.46 51.47 51.48 51.49 51.50 51.51 51.52 51.53 51.54 51.55 51.56 51.57 51.58 51.59 51.60 51.61 51.62 51.63 51.64 51.65 51.66 51.67 51.68 51.69 51.70 51.71 51.72 51.73 51.74 51.75 51.76

xxv

CONTENTS

ShearRetention object ShearTestData object SimpleShearTestData object Solubility object SoretEffect object Sorption object SpecificHeat object Swelling object TensionStiffening object TriaxialTestData object Trs object UniaxialTestData object UserDefinedField object UserMaterial object UserOutputVariables object VelocityDependence object Viscoelastic object Viscous object VoidNucleation object VolumetricTestData object
52. Odb commands

51.77 51.78 51.79 51.80 51.81 51.82 51.83 51.84 51.85 51.86 51.87 51.88 51.89 51.90 51.91 51.92 51.93 51.94 51.95 51.96

Odb object FieldBulkData object FieldLocation object FieldOutput object FieldValue object HistoryOutput object HistoryPoint object HistoryRegion object JobData object OdbAssembly object OdbConnector object OdbConnectorProperty object OdbDatumCsys object OdbFrame object OdbInstance object OdbLoadCase object OdbMeshElement object OdbMeshNode object OdbPart object OdbSet object

52.1 52.2 52.3 52.4 52.5 52.6 52.7 52.8 52.9 52.10 52.11 52.12 52.13 52.14 52.15 52.16 52.17 52.18 52.19 52.20

xxvi

CONTENTS

OdbStep object SectionCategory object SectionPoint object SectorDefinition object UserData object Top level commands
53. Property commands

52.21 52.22 52.23 52.24 52.25 52.26

SectionAssignment object
54. Section commands

53.1

Section object BeamSection object CohesiveSection object CompositeShellSection object GasketSection object GeometryShellSection object HomogeneousShellSection object HomogeneousSolidSection object LayerProperties object MembraneSection object PEGSection object RebarLayers object SectionLayer object ShellSection object SolidSection object SurfaceSection object TransverseShearBeam object TransverseShearShell object TrussSection object
55. Infrastructure commands

54.1 54.2 54.3 54.4 54.5 54.6 54.7 54.8 54.9 54.10 54.11 54.12 54.13 54.14 54.15 54.16 54.17 54.18 54.19

BaseException object Repository object RepositoryIterator object Sequence object String object Union object

55.1 55.2 55.3 55.4 55.5 55.6

xxvii

Part I Python commands

BaselineCorrection object

1.

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.

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

1.1.1
name

Members

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

1.2

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

1.2.1

BaselineCorrection(...)

This method creates a BaselineCorrection object.

1–1

BaselineCorrection object

Path

mdb.models[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 the empty sequence.
Return value

A BaselineCorrection object.
Exceptions

RangeError.

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

1.2.3

Members

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

1–2

DecayAmplitude object

1.2.4

Corresponding analysis keywords

*BASELINE CORRECTION

1.3

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

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

1.3.1

DecayAmplitude(...)

This method creates a DecayAmplitude object.
Path

mdb.models[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.

1–3

EquallySpacedAmplitude object

Exceptions

InvalidNameError and RangeError.

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

1.3.3

Members

The DecayAmplitude object has members with the same names and descriptions as the arguments to the DecayAmplitude method.
1.3.4 Corresponding analysis keywords

*AMPLITUDE

1.4

EquallySpacedAmplitude object
The EquallySpacedAmplitude object defines a list of amplitude values at fixed time intervals beginning at a specified value of time.
Access

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

1–4

EquallySpacedAmplitude object

1.4.1

EquallySpacedAmplitude(...)

This method creates an EquallySpacedAmplitude object.
Path

mdb.models[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. begin A Float specifying the time at which the first amplitude data are given. Possible values are nonnegative numbers. The default value is 0.0. data A sequence of Floats specifying the amplitude values.
Optional arguments

smooth A Float specifying the degree of smoothing. Possible values are 0 smoothing 0.5. The default value is SOLVER_DEFAULT specifying the default degree of smoothing as determined by the solver. 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.

1.4.2

setValues(...)

This method modifies the EquallySpacedAmplitude object.

1–5

ModulatedAmplitude object

Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as EquallySpacedAmplitude method, except for the name argument.
Return value

the

arguments

to

the

None
Exceptions

RangeError.

1.4.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.
1.4.4 Corresponding analysis keywords

*AMPLITUDE

1.5

ModulatedAmplitude object
The ModulatedAmplitude object defines a modulated amplitude curve.
Access

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

1.5.1

ModulatedAmplitude(...)

This method creates a ModulatedAmplitude object.

1–6

ModulatedAmplitude object

Path

mdb.models[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.

1.5.2

setValues(...)

This method modifies the ModulatedAmplitude object.
Arguments Required arguments

None.
Optional arguments

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

1–7

PeriodicAmplitude object

Return value

None
Exceptions

RangeError.

1.5.3

Members

The ModulatedAmplitude object has members with the same names and descriptions as the arguments to the ModulatedAmplitude method.
1.5.4 Corresponding analysis keywords

*AMPLITUDE

1.6

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

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

1.6.1

PeriodicAmplitude(...)

This method creates a PeriodicAmplitude object.
Path

mdb.models[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 .

1–8

PeriodicAmplitude object

data A sequence of pairs of Floats specifying
Optional argument

and

pairs.

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.

1.6.2

setValues(...)

This method modifies the PeriodicAmplitude object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the PeriodicAmplitude method, except for the name argument.
Return value

None
Exceptions

RangeError.

1.6.3

Members

The PeriodicAmplitude object has members with the same names and descriptions as the arguments to the PeriodicAmplitude method.
1.6.4 Corresponding analysis keywords

*AMPLITUDE

1–9

SmoothStepAmplitude object

1.7

SmoothStepAmplitude object
The SmoothStepAmplitude object defines an amplitude that ramps up or down smoothly from one data point to another.
Access

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

1.7.1

SmoothStepAmplitude(...)

This method creates a SmoothStepAmplitude object.
Path

mdb.models[name].SmoothStepAmplitude
Required arguments

name A String specifying the repository key. data A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency are positive numbers.
Optional argument

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

A SmoothStepAmplitude object.
Exceptions

InvalidNameError and RangeError.

1.7.2

setValues(...)

This method modifies the SmoothStepAmplitude object.

1–10

SolutionDependentAmplitude object

Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same SmoothStepAmplitude method, except for the name argument.
Return value

as

the

arguments

to

the

None
Exceptions

RangeError.

1.7.3

Members

The SmoothStepAmplitude object has members with the same names and descriptions as the arguments to the SmoothStepAmplitude method.
1.7.4 Corresponding analysis keywords

*AMPLITUDE

1.8

SolutionDependentAmplitude object
The SolutionDependentAmplitude object defines a solution-dependent amplitude for superplastic forming analysis.
Access

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

1.8.1

SolutionDependentAmplitude(...)

This method creates a SolutionDependentAmplitude object.
Path

mdb.models[name].SolutionDependentAmplitude

1–11

SolutionDependentAmplitude object

Required arguments

name A String specifying the repository key. initial A Float specifying the initial amplitude value. Possible values are those between minimum and maximum. The default value is 1. minimum A Float specifying the minimum amplitude value. Possible values are those smaller than maximum and initial. The default value is 0.1. maximum A Float specifying the maximum amplitude value. Possible values are those larger than minimum and initial. The default value is 1000.
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 SolutionDependentAmplitude object.
Exceptions

InvalidNameError and RangeError.

1.8.2

setValues(...)

This method modifies the SolutionDependentAmplitude object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the SolutionDependentAmplitude method, except for the name argument.
Return value

arguments

to

the

None

1–12

TabularAmplitude object

Exceptions

RangeError.

1.8.3

Members

The SolutionDependentAmplitude object has members with the same names and descriptions as the arguments to the SolutionDependentAmplitude method.
1.8.4 Corresponding analysis keywords

*AMPLITUDE

1.9

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

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

1.9.1

TabularAmplitude(...)

This method creates a TabularAmplitude object.
Path

mdb.models[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 A Float specifying the degree of smoothing. Possible values are between 0 and 0.5. The default value is SOLVER_DEFAULT specifying the default degree of smoothing as determined by the solver.

1–13

TabularAmplitude object

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

A TabularAmplitude object.
Exceptions

InvalidNameError and RangeError.

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

1.9.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.
1.9.4 Corresponding analysis keywords

*AMPLITUDE

1–14

AnimationPlayer object

2.
2.1

Animation commands
AnimationPlayer object
The AnimationPlayer object allows an object-based animation to be displayed in the viewport. The AnimationPlayer object has no constructor. ABAQUS creates the animationPlayer member when it creates a Viewport object.
Access

import animation session.viewports[name].animationPlayer

2.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 initial value is UNLIMITED.
Return value

None
Exceptions

If animationType=None: AnimationError: animationType not set If the parent Viewport object’s displayedObject=None: AnimationError: no object to display

2.1.2

stop()

This method stops the animation.

2–1

AnimationPlayer object

Arguments

None.
Return value

None
Exceptions

None.

2.1.3

incrementFrame()

This method increments the animation frame.
Arguments

None.
Return value

None
Exceptions

None.

2.1.4

decrementFrame()

This method decrements the animation frame.
Arguments

None.
Return value

None
Exceptions

None.

2–2

AnimationPlayer object

2.1.5

showFirstFrame()

This method renders the first frame of the animation.
Arguments

None.
Return value

None
Exceptions

None.

2.1.6

showLastFrame()

This method renders the last frame of the animation.
Arguments

None.
Return value

None
Exceptions

None.

2.1.7

setValues(...)

This method modifies the AnimationPlayer object.
Arguments Required arguments

None.
Optional argument

animationType A SymbolicConstant specifying the type of movie to play. Possible values are SCALE_FACTOR, HARMONIC, TIME_HISTORY, and NONE. The initial value is NONE.

2–3

PlayerOptions object

Return value

None
Exceptions

RangeError.

2.1.8

Members

The AnimationPlayer object has the following members: animationType A SymbolicConstant specifying the type of movie to play. Possible values are SCALE_FACTOR, HARMONIC, TIME_HISTORY, and NONE. The initial value is NONE. state A SymbolicConstant specifying the state of the animation player. Possible values are STOP and PLAY. The initial value is STOP. playerOptions A PlayerOptions object.

2.2

PlayerOptions object
The PlayerOptions object is used to store values and attributes associated with an AnimationPlayer object. The PlayerOptions object has no constructor. ABAQUS creates the playerOptions member when it creates the AnimationPlayer object.
Access

import animation session.viewports[name].animationPlayer.playerOptions

2.2.1

setValues(...)

This method modifies the PlayerOptions object.
Arguments Required arguments

None.

2–4

AnimationOptions object

Optional arguments

mode A SymbolicConstant specifying the animation mode. Possible values are PLAY_ONCE, LOOP, and SWING. The initial value is LOOP. frameRate An Int specifying the animation rate in frames/second. Possible values are 1 The initial value is 50. frameRate 100.

frameCounter A Boolean specifying whether to show the frame counter. The initial value is ON.
Return value

None
Exceptions

RangeError.

2.2.2

Members

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

2.3

AnimationOptions object
The ScalefactorMovieOptions and the Time HistoryMovieOptions objects will be merged into this object as described here. The AnimationOptions object is used to store values and attributes associated with ODB animations. The AnimationOptions object has no constructor command. ABAQUS creates the animationOptions member when it creates the OdbDisplay object.
Access

import animation session.viewports[name].odbDisplay.animationOptions

2.3.1

setValues(...)

This method modifies the AnimationOptions object.

2–5

AVIOptions object

Arguments Required arguments

None.
Optional arguments

relativeScaling A SymbolicConstant specifying the relative scaling when the AnimationPlayer’s animationType=SCALE_FACTOR or HARMONIC. Possible values are FULL_CYCLE and HALF_CYCLE. The initial value is HALF_CYCLE. numScaleFactorFrames An Int specifying the number of frames to be used when the AnimationPlayer’s animationType=SCALE_FACTOR or HARMONIC. The initial value is 7. timeHistorySteps A Sequence of Strings specifying the steps to be used when the AnimationPlayer’s animationType=TIME_HISTORY. The initial value is all the steps for the viewport’s current Odb object.
Return value

None
Exceptions

None.

2.3.2

Members

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

2.4

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

2–6

AVIOptions object

2.4.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: Uncompressed format, 8 bits per pixel. RAW32: Uncompressed format, 32 bits per pixel. RLE8: Run length encoded format, 8 bits per pixel.

The initial value is RLE8. sizeDefinition A SymbolicConstant specifying how the width and height of the image are specified. Possible values are SIZE_ON_SCREEN and USER_DEFINED. The initial 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) (1280, 1024). The initial 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.
Return value

None
Exceptions

None.

2–7

ImageAnimationOptions object

2.4.2

Members

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

2.5

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 session.imageAnimationOptions

2.5.1

setValues(...)

This method modifies the ImageAnimationOptions object.
Arguments Required arguments

None.
Optional argument

vpDecorations A Boolean specifying whether to capture the viewport border and title. The initial value is ON.
Return value

None
Exceptions

None.

2.5.2

Members

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

2–8

QuickTimeOptions object

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

2.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: Uncompressed format, 24 bits per pixel. RLE24: Run length encoded format, 24 bits per pixel.

The initial 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 initial 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) (1280, 1024). The initial value is the size of the screen. 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

2–9

ScaleFactorMovieOptions object



screen resolution.

The minimum width and height are normally < 50 pixels.
Return value

None
Exceptions

None.

2.6.2

Members

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

2.7

ScaleFactorMovieOptions object
The ScaleFactorMovieOptions object is used to store values and attributes associated with output database animations. The ScaleFactorMovieOptions object has no constructor. ABAQUS creates the scaleFactorMovieOptions member when it creates the OdbDisplay object.
Access

import animation session.viewports[name].odbDisplay.scaleFactorMovieOptions

2.7.1

setValues(...)

This method modifies the ScaleFactorMovieOptions object.
Arguments Required arguments

None.
Optional arguments

relativeScaling A SymbolicConstant specifying the relative scaling when the AnimationPlayer object’s animationType=SCALE_FACTOR or HARMONIC. Possible values are FULL_CYCLE and HALF_CYCLE. The initial value is HALF_CYCLE.

2–10

Session object

numFrames An Int specifying the number of frames to be used when the AnimationPlayer object’s animationType=SCALE_FACTOR or HARMONIC. The initial value is 7.
Return value

None
Exceptions

None.

2.7.2

Members

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

2.8

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

import animation

2.8.1

playImageAnimation(...)

This method produces a movie player and plays the selected image-based animation.
Arguments Required argument

filename A String specifying the name of the file to animate.
Optional arguments

None.
Return value

None

2–11

Session object

Exceptions

None.

2.8.2

killAllImageAnimations()

This method destroys all movie players created by the playImageAnimation command.
Arguments

None.
Return value

None
Exceptions

None.

2.8.3

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 and QUICKTIME.
Optional argument

canvasObjects A sequence specifying the canvas objects to capture. The default is to capture all canvas objects.
Return value

None
Exceptions

None.

2–12

TimeHistoryMovieOptions object

2.9

TimeHistoryMovieOptions object
The TimeHistoryMovieOptions object is used to store values and attributes associated with output database animations. The TimeHistoryMovieOptions object has no constructor. ABAQUS creates the timeHistoryMovieOptions member when it creates the OdbDisplay object.
Access

import animation session.viewports[name].odbDisplay.timeHistoryMovieOptions

2.9.1

setValues(...)

This method modifies the TimeHistoryMovieOptions object.
Arguments Required arguments

None.
Optional arguments

steps A sequence of Strings specifying the names of the steps to be included in the animation when the animationType member of the AnimationPlayer object is set to TIME_HISTORY. The initial value is the names of all the steps in the current viewport’s Odb object. skipFrequency An Int specifying how often the animation will skip data frames. If skipFrequency=1, the animation will skip every other frame. The first frame is always read. Possible values are skipFrequency 0. The default value is 0 (data are read from every frame).
Return value

None
Exceptions

None.

2.9.2

Members

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

2–13

Annotation object

3.

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

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

3.1.1

bringToFront()

This method brings the Annotation object to the top of the annotation stack.
Arguments

None.
Return value

None
Exceptions

None.

3.1.2

sendToBack()

This method sends the Annotation object to the bottom of the annotation stack.
Arguments

None.

3–1

Annotation object

Return value

None
Exceptions

None.

3.1.3

bringForward()

This method brings the Annotation object one position up in the annotation stack.
Arguments

None.
Return value

None
Exceptions

None.

3.1.4

sendBackward()

This method sends the Annotation object one position down in the annotation stack.
Arguments

None.
Return value

None
Exceptions

None.

3.1.5

moveBefore(...)

This method moves the Annotation object before another object in the same repository.

3–2

Annotation object

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

None.
Return value

None
Exceptions

None.

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

3.1.7

translate(...)

This method translates the Annotation object on the viewport plane.
Arguments Required arguments

None.

3–3

AnnotationsToPlotArray object

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.

3.1.8
name

Members

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

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

3.2.1

plotAnnotation(...)

This method plots an Annotation object in a Viewport.
Path

session.viewports[name].plotAnnotation
Required argument

annotation An Annotation object to plot.

3–4

AnnotationsToPlotArray object

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
Exceptions

None.

3.2.2

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.
Return value

None
Exceptions

None.

3.2.3

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.

3–5

AnnotationsToPlotArray object

Return value

None
Exceptions

None.

3.2.4

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 otherAnnotation object in the AnnotationsToPlotArray sequence after which this object will be moved.
Optional arguments

None.
Return value

None
Exceptions

None.

3.2.5

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.

3–6

AnnotationsToPlotArray object

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.

3.2.6

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

None.
Return value

None
Exceptions

None.

3.2.7

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.

3–7

Arrow object

Optional arguments

None.
Return value

None
Exceptions

None.

3.2.8

Members

The AnnotationsToPlotArray object has no members.

3.3

Arrow object
The Arrow object stores the visual settings and location of an arrow annotation.
Access

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

3.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 initial value is (0,0).

3–8

Arrow object

endPoint A pair of Floats specifying the end point X- and Y-offsets in millimeters from endAnchor. The initial value is (0,0). startAnchor A SymbolicConstant, a Sequence of two Floats specifying the X and Y coordinates given as percentages of the viewport width and height, or a Sequence of three Floats specifying the X, Y and Z coordinates of a point in the model coordinate system. Possible values for the SymbolicConstant are BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, CENTER_LEFT, CENTER, CENTER_RIGHT, TOP_LEFT, TOP_CENTER, and TOP_RIGHT. The initial value is BOTTOM_LEFT. endAnchor A SymbolicConstant, a Sequence of two Floats specifying the X and Y coordinates given as percentages of the viewport width and height, or a Sequence of three Floats specifying the X, Y and Z coordinates of a point in the model coordinate system. Possible values for the SymbolicConstant are BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, CENTER_LEFT, CENTER, CENTER_RIGHT, TOP_LEFT, TOP_CENTER, and TOP_RIGHT. The initial 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, and NONE. The initial 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, FILLED_SQUARE, and NONE. The initial value is FILLED_ARROW. startGap A Float specifying the distance in millimeters between the arrow start point and the arrow start head. The initial value is 0.0. endGap A Float specifying the distance in millimeters between the arrow end point and the arrow end head. The initial value is 0.0. color A String specifying the color of the arrow. Possible values are any valid color. The initial value is “White”. lineStyle A SymbolicConstant specifying the line style of the arrow. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID.

3–9

Arrow object

lineThickness A SymbolicConstant specifying the line thickness of the arrow. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN.
Return value

An Arrow object.
Exceptions

InvalidNameError.

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

None
Exceptions

None.

3.3.3

translateEndPoint(...)

This method translates the end point of the Arrow object on the viewport plane.
Arguments Required arguments

None.

3–10

Text object

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.

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

None
Exceptions

None.

3.3.5

Members

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

3.4

Text object
The Text object stores the text settings and location of a text annotation.

3–11

Text object

Access

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

3.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 initial value is an empty string. offset A pair of Floats specifying the X- and Y-offsets in millimeters of the Text object from anchor. The initial value is (0,0). anchor A SymbolicConstant, a Sequence of two Floats specifying the X and Y coordinates given as percentages of the viewport width and height, or a Sequence of three Floats specifying the X, Y and Z coordinates of a point in the model coordinate system. Possible values for the SymbolicConstant are BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, CENTER_LEFT, CENTER, CENTER_RIGHT, TOP_LEFT, TOP_CENTER, and TOP_RIGHT. The initial value is BOTTOM_LEFT. referencePoint A SymbolicConstant or a Sequence of two Floats specifying the X- and Y-coordinates of the reference point of the Text annotation given as percentages of its width and height. Possible values for the SymbolicConstant are BOTTOM_LEFT, BOTTOM_CENTER, BOTTOM_RIGHT, CENTER_LEFT, CENTER, CENTER_RIGHT, TOP_LEFT, TOP_CENTER, and TOP_RIGHT. The initial value is BOTTOM_LEFT. rotationAngle A Float specifying the amount of rotation in degrees about referencePoint. The initial value is 0.0.

3–12

Text object

color A String specifying the color of the Text object. Possible values are any valid color. The initial value is “White”. font A String specifying the font of the Text object. Possible values are any valid font specification. The initial value is “-*-helvetica-medium-r-normal--12-*”. backgroundStyle A SymbolicConstant specifying the Text object background style. Possible values are MATCH, TRANSPARENT, and OTHER. The initial value is TRANSPARENT. backgroundColor A String specifying the color of the Text object background. Possible values are any valid color. The initial value matches the viewport background. box A Boolean specifying whether the box around the text is shown. The initial 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 initial value is JUSTIFY_LEFT.
Return value

A Text object.
Exceptions

None.

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

3–13

Text object

Exceptions

None.

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

3–14

Assembly object

4.
4.1

Assembly commands
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

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

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

4–1

Assembly object

Exceptions

None.

4.1.3

deleteAllFeatures()

This method deletes all the features in the assembly.
Arguments

None.
Return value

None
Exceptions

None.

4.1.4

deleteFeatures(...)

This method deletes specified features from the assembly.
Arguments Required argument

featureNames A tuple of feature names that will be deleted from the assembly.
Optional arguments

None.
Return value

None
Exceptions

None.

4.1.5

featurelistInfo()

This method prints the name and status of all the features in the feature lists.

4–2

Assembly object

Arguments

None.
Return value

None
Exceptions

None.

4.1.6

getCoordinates(...)

This method returns the coordinates of specified point.
Arguments Required arguments

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.

4.1.7

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.

4–3

Assembly object

entity2 A Vertex, Datum point, MeshNode, or Edge specifying the second entity to which to measure.
Optional arguments

None.
Return value

A Float specifying the calculated distance.
Exceptions

None.

4.1.8

makeDependent(...)

This method converts the specified part instances from independent to dependent part instances.
Arguments Required argument

instances A sequence of Part Instances to convert to dependent part instances.
Optional arguments

None.
Return value

None
Exceptions

None.

4.1.9

makeIndependent(...)

This method converts the specified part instances from dependent to independent part instances.
Arguments Required argument

instances A sequence of Part Instances to convert to independent part instances.
Optional arguments

None.

4–4

Assembly object

Return value

None
Exceptions

None.

4.1.10

projectReferencesOntoSketch(...)

This method projects the specified edges, vertices, and datum points from the assembly onto the specified Sketch object. The edges, vertices, and datum points appear on the Sketch as reference geometry.
Arguments Required argument

sketch The Sketch 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.

4–5

Assembly object

4.1.11

queryAngle(...)

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

None.

4.1.12

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.

4–6

Assembly object

Arguments

None.
Return value

None
Exceptions

None.

4.1.13

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.

4.1.14

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

None.
Return value

None

4–7

Assembly object

Exceptions

None.

4.1.15

resumeAllFeatures()

This method resumes all the suppressed features in the part or assembly.
Arguments

None.
Return value

None
Exceptions

None.

4.1.16

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
Exceptions

None.

4.1.17

resumeLastSetFeatures()

This method resumes the last set of features to be suppressed in the assembly.

4–8

Assembly object

Arguments

None.
Return value

None
Exceptions

None.

4.1.18

saveGeometryCache()

This method caches the current geometry, which improves regeneration performance.
Arguments

None.
Return value

None
Exceptions

None.

4.1.19

setValues(...)

This method modifes 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.

4–9

Assembly object

Return value

None
Exceptions

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

4.1.20

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.

4.1.21

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 ’4.2’ corresponds to ACIS version 4.2. The default value is the current version of ACIS.

4–10

Assembly object

Return value

None
Exceptions

None.

4.1.22

Members

The Assembly object can have the following members: modelName A String specifying the name of the model to which the assembly belongs. isOutOfDate An Int indicating that feature parameters have been modified but that the assembly has not been regenerated. Possible values are 0 and 1. instances A repository of PartInstance objects. datums An array of all Datum objects. features An array of all Feature objects. featuresById An array of all Feature objects. 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. surfaces A repository of the Surface objects that were created on the assembly. For more information, see Chapter 39, “Region commands.” allSurfaces A repository of the Surface objects that were instanced. For more information, see Chapter 39, “Region commands.” allInternalSurfaces A repository of Surface objects created for picked regions. sets A repository of the Set objects that were created on the assembly. allSets A repository of the Set objects that were instanced. For more information, see Chapter 39, “Region commands.”

4–11

Feature object

allInternalSets A repository of Set objects created for picked regions. referencePoints An array of ReferencePoint objects. engineeringFeatures An EngineeringFeature object. regenerateConstraintsTogether A Boolean specifying whether the positioning constraints in the assembly should be regenerated together before regenerating other assembly features.

4.2

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

import assembly

4.2.1

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. flip A Boolean specifying whether the axes are forward aligned (OFF) or reverse aligned (ON).
Optional arguments

None.
Return value

A Feature object.

4–12

Feature object

Exceptions

AbaqusError.

4.2.2

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.

4.2.3

EdgeToEdge(...)

This method moves an instance so that its edge is parallel to an edge of a fixed instance.
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.

4–13

Feature object

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

AbaqusError.

4.2.4

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

4–14

Feature object

Exceptions

AbaqusError.

4.2.5

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

AbaqusError.

4.2.6

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.

4–15

Feature object

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

None.
Return value

A Feature object.
Exceptions

AbaqusError.

4.2.7

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

AbaqusError.

4–16

PartInstance object

4.3

PartInstance object
A PartInstance object is an instance of a Part object.

Access

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

4.3.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 argument

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. dependent A Boolean specifying whether the part instance should be dependent or independent. The default value is OFF indicating that the part instance is independent.

Return value

A PartInstance object.

Exceptions

None.

4–17

PartInstance object

4.3.2

LinearInstancePattern(...)

This method creates multiple PartInstance objects in a linear pattern and puts them into the instances repository.
Path

mdb.models[name].rootAssembly.LinearInstancePattern
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.

4.3.3

RadialInstancePattern(...)

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

4–18

PartInstance object

Path

mdb.models[name].rootAssembly.RadialInstancePattern
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 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.

4.3.4

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 Faces or Edges on the part instance to be moved.

4–19

PartInstance object

fixedList A sequence of Faces or Edges 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.
Exceptions

None.

4.3.5

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.

4.3.6

getPosition()

This method prints the sum of the translations and rotations applied to the PartInstance object.
Arguments

None.

4–20

PartInstance object

Return value

None
Exceptions

None.

4.3.7

getRotation()

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

None.
Return value

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

None.

4.3.8

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.

4.3.9

replace(...)

This method replaces one instance with an instance of another part.

4–21

PartInstance object

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
Exceptions

None.

4.3.10

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.

4–22

PartInstance object

4.3.11

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
Exceptions

None.

4.3.12
name

Members

The PartInstance object can have the following members: 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. analysisType A SymbolicConstant specifying the part type. Possible values are DEFORMABLE_BODY, 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, which was instanced. sets A repository of Set objects created on the part. For more information, see Chapter 39, “Region commands.” surfaces A repository of Surface objects created on the part. For more information, see Chapter 39, “Region commands.”

4–23

PartInstance object

vertices A VertexArray object. edges An EdgeArray object. faces A FaceArray object. cells A CellArray object. datums An array of Datum objects. elements An array of MeshElement objects. elemFaces An array of MeshFace objects. elemEdges An array of element MeshEdge objects. nodes An array of MeshNode objects. referencePoints An array of ReferencePoint objects. geometryValidity A Boolean specifying the validity of the geometry of the instance. partName A String specifying the name of the part from which the instance was created.

4–24

Cell object

5.

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

5.1

Cell object
Cells are volumetric regions of geometry.
Access

import part mdb.models[name].parts[name].cells[i] mdb.models[name].parts[name].sets[name].cells[i] import assembly 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]

5.1.1

getSize()

This method returns a Float indicating the volume of the cell.
Arguments

None.
Return value

A Float.
Exceptions

None.

5.1.2
index

Members

The Cell object has the following members: An Int specifying the index of the cell in the CellArray.

5–1

CellArray object

pointOn A sequence of Floats specifying the X-, Y-, and Z-coordinates of a point located on the cell.

5.2

CellArray object
The CellArray is a sequence of Cell objects.
Access

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

5.2.1

findAt(...)

This method returns the object or objects in the CellArray located at the given coordinates.findAt 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. 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.
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.
Optional arguments

None.
Return value

A Cell object.

5–2

Edge object

Exceptions

None.

5.2.2

Members

The CellArray object has no members.

5.3

Edge object
Edges are linear regions of geometry.
Access

import part 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.allSets[name].edges[i] mdb.models[name].rootAssembly.allSurfaces[name].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]

5.3.1

getSize()

This method returns a Float indicating the length of the edge.
Arguments

None.
Return value

A Float.
Exceptions

None.

5–3

EdgeArray object

5.3.2
index

Members

The Edge object has the following members: An Int specifying the index of the edge in the EdgeArray. pointOn A sequence of Floats specifying the X-, Y-, and Z-cordinates of a point located on the edge.

5.4

EdgeArray object
The EdgeArray is a sequence of Edge objects.
Access

import part 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.allSets[name].edges mdb.models[name].rootAssembly.allSurfaces[name].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

5.4.1

findAt(...)

This method returns the object or objects in the EdgeArray located at the given coordinates. findAt 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. 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.
Arguments Required argument

coordinates A sequence of Floats specifying the X-, Y-, and Z-coordinates of the object to find.

5–4

Face object

findAt returns either is 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 coordinates is a sequence of sequence of Floats, findAt returns a sequence of Edge objects at the given locations.
Optional arguments

None.
Return value

An Edge object.
Exceptions

None.

5.4.2

Members

The EdgeArray object has no members.

5.5

Face object
Faces are surface regions of geometry.
Access

import part mdb.models[name].parts[name].faces[i] mdb.models[name].parts[name].sets[name].faces[i] import assembly mdb.models[name].rootAssembly.allSets[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.sets[name].faces[i]

5.5.1

getCentroid()

This method returns the centroid of a face.
Arguments

None.

5–5

FaceArray object

Return value

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

None.

5.5.2

getSize()

This method returns a Float indicating the area of the face.
Arguments

None.
Return value

A Float.
Exceptions

None.

5.5.3
index

Members

The Face object has the following members: An Int specifying the index of the face in the FaceArray. pointOn A sequence of sequences of Floats indicating 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.

5.6

FaceArray object
The FaceArray is a sequence of Face objects.
Access

import part mdb.models[name].parts[name].faces mdb.models[name].parts[name].sets[name].faces import assembly

5–6

FaceArray object

mdb.models[name].rootAssembly.allSets[name].faces mdb.models[name].rootAssembly.instances[name].faces mdb.models[name].rootAssembly.instances[name].sets[name].faces mdb.models[name].rootAssembly.sets[name].faces

5.6.1

findAt(...)

This method returns the object or objects in the FaceArray located at the given coordinates. findAt 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. 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.
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 the face is a shell, you can use the optional argument normal to check the orientation of the face. 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.

Optional argument

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

A Face object.
Exceptions

None.

5.6.2

Members

The FaceArray object has no members.

5–7

InterestingPoint object

5.7

InterestingPoint object
Interesting points can be located at the following:

• • •

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

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

5–8

Transform object

5.7.2

Members

The InterestingPoint object has no members.

5.8

ModelDot object
The ModelDot object is the abstract base type for the MeshNode, ReferencePoint, and Vertex objects.

5.8.1

Members

The ModelDot object has no members.

5.9

ReferencePoint object
TheReferencePoint 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].referencePoints[i] import assembly mdb.models[name].rootAssembly.instances[name].referencePoints[i] mdb.models[name].rootAssembly.referencePoints[i]

5.9.1

Members

The ReferencePoint object has no members.

5.10

Transform object

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

import part import assembly

5–9

Vertex object

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

5.10.2

Members

The Transform object has no members.

5.11

Vertex object

Vertices are point regions of geometry.
Access

import part mdb.models[name].parts[name].sets[name].vertices[i] mdb.models[name].parts[name].vertices[i] import assembly 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]

5.11.1
index

Members

The Vertex object has the following members: An Int specifying the index of the Vertex in the VertexArray. pointOn A sequence of Floats specifying the X-, Y-, and Z-coordinates of the vertex.

5–10

VertexArray object

5.12

VertexArray object

The VertexArray is a sequence of Vertex objects.
Access

import part mdb.models[name].parts[name].sets[name].vertices mdb.models[name].parts[name].vertices import assembly 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

5.12.1

findAt(...)

This method returns the object or objects in the VertexArray located at the given coordinates. findAt 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.
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 coordinates is a sequence of sequence of Floats, findAt returns a sequence of Vertex objects at the given locations.
Optional arguments

None.
Return value

A Vertex object or a sequence of Vertex objects.
Exceptions

None.

5–11

VertexArray object

5.12.2

Members

The VertexArray object has no members.

5–12

Profile object

6.

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.

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

6.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.
Exceptions

None.

6–1

ArbitraryProfile object

6.1.2
name

Members

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

6.2

ArbitraryProfile object
The ArbitraryProfile object defines the properties of an arbitrary profile.
Access

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

6.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:

• • •

1-coordinate of the first point defining the profile. 2-coordinate of the first point defining the profile. 1–coordinate of the next point defining the profile.

All other sequences in the table specify the following:

6–2

BoxProfile object

• •

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.

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

6.2.3

Members

The ArbitraryProfile object has members with the same names and descriptions as the arguments to the ArbitraryProfile method.
6.2.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=ARBITRARY

6.3

BoxProfile object
The BoxProfile object defines the properties of a box profile.

6–3

BoxProfile object

Access

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

6.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 crosssection library,” Section 15.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.
Optional arguments

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

6–4

CircularProfile object

Return value

A BoxProfile object.
Exceptions

RangeError.

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

6.3.3

Members

The BoxProfile object has members with the same names and descriptions as the arguments to the BoxProfile method.
6.3.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=BOX

6.4

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

import section

6–5

CircularProfile object

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

6.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 15.3.9 of the ABAQUS Analysis User’s Manual.
Optional arguments

None.
Return value

A CircularProfile object.
Exceptions

RangeError.

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

6–6

GeneralizedProfile object

Return value

None
Exceptions

RangeError.

6.4.3

Members

The CircularProfile object has members with the same names and descriptions as the arguments to the CircularProfile method.
6.4.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=CIRC

6.5

GeneralizedProfile object
The GeneralizedProfile object defines the properties of a profile via its area, moment of inertia, etc.
Access

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

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

6–7

GeneralizedProfile object

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 rigidity, . gammaO A Float specifying the sectoral moment, . gammaW A Float specifying the warping constant, .
Optional arguments

.

. .

None.
Return value

A GeneralizedProfile object.
Exceptions

RangeError.

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

6–8

HexagonalProfile object

6.5.3

Members

The GeneralizedProfile object has members with the same names and descriptions as the arguments to the GeneralizedProfile method.
6.5.4 Corresponding analysis keywords

*BEAM GENERAL SECTION, SECTION=GENERAL or NONLINEAR GENERAL

6.6

HexagonalProfile object
The HexagonalProfile object defines the properties of a hexagonal profile.
Access

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

6.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 15.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.

6–9

IProfile object

Return value

A HexagonalProfile object.
Exceptions

RangeError.

6.6.2

setValues(...)

This method modifies the HexagonalProfile object.
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.

6.6.3

Members

The HexagonalProfile object has members with the same names and descriptions as the arguments to the HexagonalProfile method.
6.6.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=HEX

6.7

IProfile object
The IProfile object defines the properties of an I profile.
Access

import section

6–10

IProfile object

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

6.7.1

IProfile(...)

This method creates an IProfile object.
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 15.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.

6–11

LProfile object

6.7.2

setValues(...)

This method modifies the IProfile object.
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.

6.7.3

Members

The IProfile object has members with the same names and descriptions as the arguments to the IProfile method.
6.7.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=I

6.8

LProfile object
The LProfile object defines the properties of a L profile.
Access

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

6.8.1

LProfile(...)

This method creates a LProfile object.

6–12

LProfile object

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

6.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.
Return value

None

6–13

PipeProfile object

Exceptions

RangeError.

6.8.3

Members

The LProfile object has members with the same names and descriptions as the arguments to the LProfile method.
6.8.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=L

6.9

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

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

6.9.1

PipeProfile(...)

This method creates a PipeProfile object.
Path

mdb.models[name].PipeProfile session.odbs[name].PipeProfile
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 15.3.9 of the ABAQUS Analysis User’s Manual. t A Float specifying the wall thickness of the pipe.

6–14

RectangularProfile object

Optional arguments None. Return value

A PipeProfile object.
Exceptions

RangeError.

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

6.9.3

Members

The PipeProfile object has members with the same names and descriptions as the arguments to the PipeProfile method.
6.9.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=PIPE

6.10

RectangularProfile object

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

6–15

RectangularProfile object

Access

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

6.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 15.3.9 of the ABAQUS Analysis User’s Manual. b A positive Float specifying the b dimension of the rectangular profile.
Optional arguments

None.
Return value

A RectangularProfile object.
Exceptions

RangeError.

6.10.2

setValues(...)

This method modifies the RectangularProfile object.
Arguments Required arguments

None.

6–16

TProfile object

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.

6.10.3

Members

The RectangularProfile object has members with the same names and descriptions as the arguments to the RectangularProfile method.
6.10.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=RECT

6.11

TProfile object

The TProfile object defines the properties of a T profile.
Access

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

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

6–17

TProfile object

b A positive Float specifying the b dimension (flange width) of the T profile. For more information, see “Beam cross-section library,” Section 15.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.

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

6–18

TrapezoidalProfile object

6.11.3

Members

The TProfile object has members with the same names and descriptions as the arguments to the TProfile method.
6.11.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=I

6.12

TrapezoidalProfile object

The TrapezoidalProfile object defines the properties of a trapezoidal profile.
Access

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

6.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 15.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.

6–19

TrapezoidalProfile object

Optional arguments

None.
Return value

A TrapezoidalProfile object.
Exceptions

RangeError.

6.12.2

setValues(...)

This method modifies the TrapezoidalProfile object.
Arguments Required arguments

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

6.12.3

Members

The TrapezoidalProfile object has members with the same names and descriptions as the arguments to the TrapezoidalProfile method.
6.12.4 Corresponding analysis keywords

*BEAM SECTION, SECTION=TRAPEZOID

6–20

BoundaryCondition object

7.

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.

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

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

7–1

BoundaryCondition object

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

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

7–2

BoundaryCondition object

7.1.4

resume()

This method resumes the boundary condition that was previously suppressed.
Arguments

None.
Return value

None
Exceptions

None.

7.1.5

suppress()

This method suppresses the boundary condition.
Arguments

None.
Return value

None
Exceptions

None.

7.1.6
name

Members

The BoundaryCondition object can have the following members: 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.

7–3

AccelerationBC object

localCsys A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

7.2

AccelerationBC object
The AccelerationBC object stores the data for an acceleration boundary condition.
Access

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

7.2.1

AccelerationBC(...)

This method creates an AccelerationBC object.
Path

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

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.

7–4

AccelerationBC object

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. 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system. distribution A SymbolicConstant specifying how the load is distributed spatially. UNIFORM and USER_DEFINED. The default value is UNIFORM. Possible values are

Return value

An AccelerationBC object.

Exceptions

None.

7.2.2

setValues(...)

This method modifies the data for an existing AccelerationBC object in the step where it is created.

7–5

AccelerationBC object

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.

7.2.3

setValuesInStep(...)

This method modifies the propagating data for an existing AccelerationBC 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 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.

7–6

AccelerationBCState object

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.

7.2.4
name

Members

The AccelerationBC object can have the following members: 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

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

7–7

AccelerationBCState object

Access

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

7.3.1
a1

Members

The AccelerationBCState object has the following members: 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 1direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED. a2State A SymbolicConstant specifying the propagation state of the acceleration component in the 2direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED. a3State A SymbolicConstant specifying the propagation state of the acceleration component in the 3direction. 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.

7–8

AcousticPressureBC object

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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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:

• • • • • • • • • • • •
7.3.2

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
Corresponding analysis keywords

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

7.4

AcousticPressureBC object
The Acoustic Pressure BC object stores the data for a Acoustic pressure boundary condition.
Access

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

7–9

AcousticPressureBC object

7.4.1

AcousticPressureBC(...)

This method creates a AcousticPressureBC object.
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

magnitude A Float specifying the acoustic pressure magnitude. The default value is 0. The magnitude argument is optional if distribution=USER_DEFINED distribution A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. 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.

7.4.2

setValues(...)

This method modifies the data for an existing AcousticPressureBC object in the step where it is created.

7–10

AcousticPressureBC object

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.

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

None.

7–11

AcousticPressureBCState object

7.4.4
name

Members

The AcousticPressureBC object can have the following members: 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

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

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

7.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

7–12

BoundaryConditionState object

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:

• • • • • • • • • • • •
7.5.2

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
Corresponding analysis keywords

*BOUNDARY (degree of freedom: 8)

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

7.6.1

Members

The BoundaryConditionState object has the following members:

7–13

ConcentrationBC object

amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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:

• • • • • • • • • • • •
7.7

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

ConcentrationBC object
The ConcentrationBC object stores the data for a concentration boundary condition.
Access

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

7.7.1

ConcentrationBC(...)

This method creates a ConcentrationBC object.
Path

mdb.models[name].ConcentrationBC

7–14

ConcentrationBC object

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

magnitude A Float specifying the concentration magnitude. The default value is 0. The magnitude argument is optional if distribution=USER_DEFINED. distribution A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, and USER_DEFINED. 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 ConcentrationBC object.
Exceptions

None.

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

7–15

ConcentrationBC object

Return value

None
Exceptions

None.

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

7.7.4
name

Members

The ConcentrationBC object can have the following members: A String specifying the boundary condition repository key. category A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.

7–16

ConcentrationBCState object

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

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

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

7.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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

7–17

ConnAccelerationBC object

• • • • • • • • •
7.8.2

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
Corresponding analysis keywords

*BOUNDARY (degree of freedom: 8)

7.9

ConnAccelerationBC object
The ConnAccelerationBC object stores the data for a connector acceleration boundary condition.
Access

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

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

7–18

ConnAccelerationBC object

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. distribution A SymbolicConstant specifying how the load is distributed spatially. UNIFORM and USER_DEFINED. The default value is UNIFORM.
Return value

Possible values are

An ConnAccelerationBC object.

7–19

ConnAccelerationBC object

Exceptions

None.

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

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

7–20

ConnAccelerationBC object

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.

7.9.4

Members

The ConnAccelerationBC object can have the following members: connectors A sequence of Strings specifying the names of the connectors to which the boundary condition is applied. 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.

7–21

ConnAccelerationBCState object

localCsys A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

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

Access

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

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

7–22

ConnAccelerationBCState object

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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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

7–23

ConnDisplacementBC object

• • •
7.10.2

MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
Corresponding analysis keywords

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

7.11

ConnDisplacementBC object

The ConnDisplacementBC object stores the data for a connector displacement/rotation boundary condition.
Access

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

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

7–24

ConnDisplacementBC object

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. distribution A SymbolicConstant specifying how the load is distributed spatially. UNIFORM and USER_DEFINED. The default value is UNIFORM. Possible values are

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.

7–25

ConnDisplacementBC object

Exceptions

None.

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

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

7–26

ConnDisplacementBC object

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.

7.11.4

Members

The ConnDisplacementBC object can have the following members: connectors A sequence of Strings specifying the names of the connectors to which the boundary condition is applied. 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.

7–27

ConnDisplacementBCState object

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. 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

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

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

7.12.1
u1

Members

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

7–28

ConnDisplacementBCState object

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. 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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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:

7–29

ConnVelocityBC object

• • • • • • • • • • • •
7.12.2

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
Corresponding analysis keywords

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

7.13

ConnVelocityBC object

The ConnVelocityBC object stores the data for a connector velocity boundary condition.
Access

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

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

7–30

ConnVelocityBC object

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 1direction. 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 2direction. 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 connector’s local 3direction. 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. distribution A SymbolicConstant specifying how the load is distributed spatially. UNIFORM and USER_DEFINED. The default value is UNIFORM. Possible values are

7–31

ConnVelocityBC object

Return value

A ConnVelocityBC object.
Exceptions

None.

7.13.2

setValues(...)

This method modifies the data for an existing ConnVelocityBC 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 ConnVelocityBC method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

7.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 1direction. Possible values for the SymbolicConstant are SET and FREED. v2 A Float or a SymbolicConstant specifying the velocity component in the connector’s local 2direction. Possible values for the SymbolicConstant are SET and FREED.

7–32

ConnVelocityBC object

v3 A Float or a SymbolicConstant specifying the velocity component in the connector’s local 3direction. 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. 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.

7.13.4

Members

The ConnVelocityBC object can have the following members: connectors A sequence of Strings specifying the names of the connectors to which the boundary condition is applied. 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.

7–33

ConnVelocityBCState object

localCsys A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

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

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

7.14.1
v1

Members

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

7–34

ConnVelocityBCState object

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. 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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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

7–35

DisplacementBC object

7.14.2

Corresponding analysis keywords

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

7.15

DisplacementBC object

The DisplacementBC object stores the data for a displacement/rotation boundary condition.
Access

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

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

u1 A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 1direction. 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 2direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.

7–36

DisplacementBC object

u3 A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 3direction. 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. distribution A SymbolicConstant specifying how the load is distributed spatially. UNIFORM and USER_DEFINED. The default value is UNIFORM. Possible values are

localCsys A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system. 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 DisplacementBC object.

7–37

DisplacementBC object

Exceptions

None.

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

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

7–38

DisplacementBC object

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.

7.15.4
fixed

Members

The DisplacementBC object can have the following members: 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.

7–39

DisplacementBCState object

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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

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

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

7.16.1
u1

Members

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

7–40

DisplacementBCState object

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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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

7–41

ElectricPotentialBC object

• • • •
7.16.2

PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
Corresponding analysis keywords

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

7.17

ElectricPotentialBC object

The ElectricPotentialBC object stores the data for an electrical potential boundary condition.
Access

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

7.17.1

ElectricPotentialBC(...)

This method creates a ElectricPotentialBC object.
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

magnitude A Float specifying the electrical potential magnitude. The default value is 0. The magnitude argument is optional if distribution=USER_DEFINED. distribution A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

7–42

ElectricPotentialBC object

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.

7.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 ElectricPotentialBC method, except for the name and createStepName arguments.
Return value

to

the

None
Exceptions

None.

7.17.3

setValuesInStep(...)

This method modifies the propagating data for an existing ElectricPotentialBC object in the specified step.

7–43

ElectricPotentialBC object

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

Exceptions

None.

7.17.4
name

Members

The ElectricPotentialBC object can have the following members: 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

7–44

ElectricPotentialBCState object

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

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

7.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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

7–45

PorePressureBC object

• • •
7.18.2

MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
Corresponding analysis keywords

*BOUNDARY (degree of freedom: 8)

7.19

PorePressureBC object

The PorePressureBC object stores the data for a pore pressure boundary condition.
Access

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

7.19.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. region A Region object specifying the region to which the boundary condition is applied.
Optional arguments

magnitude A Float specifying the pore pressure magnitude. The default value is 0. The magnitude argument is optional if distribution=USER_DEFINED. distribution A SymbolicConstant specifying how the load is distributed spatially. UNIFORM, and USER_DEFINED. The default value is UNIFORM. Possible values are

7–46

PorePressureBC object

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.

7.19.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.
Return value

None
Exceptions

None.

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

7–47

PorePressureBCState object

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.

7.19.4
name

Members

The PorePressureBC object can have the following members: 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

7.20

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 PorePressureCState object has no constructor or methods.

7–48

PorePressureBCState object

Access

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

7.20.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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:

• • • • • • • • • • • •
7.20.2

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
Corresponding analysis keywords

*BOUNDARY (degree of freedom: 8)

7–49

SubmodelBC object

7.21

SubmodelBC object

The SubmodelBC object stores the data for a submodel boundary condition.

Access

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

7.21.1

SubmodelBC(...)

This method creates a SubmodelBC object.

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.

7–50

SubmodelBC object

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. The default value is an empty string, indicating that the entire global model will be searched. 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. 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system. 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. The default value is 0, indicating that the solution from the last increment will be used. The globalIncrement argument is applicable only for linear perturbation steps. 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.

7.21.2

setValues(...)

This method modifies the data for an existing SubmodelBC object in the step where it is created.

7–51

SubmodelBC object

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.

7.21.3

setValuesInStep(...)

This method modifies the propagating data for an existing SubmodelBC 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

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. The default value is 0, indicating that the solution from the last increment will be used. The globalIncrement argument is applicable only for linear perturbation steps and if fixed=OFF.

7–52

SubmodelBC object

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.

7.21.4

Members

The SubmodelBC object can have the following members: 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. The default value is an empty string, indicating that the entire global model will be searched. 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. 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. 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

7–53

SubmodelBCState object

7.22

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

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

7.22.1
dof

Members

The SubmodelBCState object has the following members: A sequence of Ints specifying the degrees of freedom to which the boundary condition is applied. dofState A SymbolicConstant specifying the propagation state of the dof 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. 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 A Float specifying the thickness of the center zone size around the shell midsurface. The default value is None.

7–54

TemperatureBC object

centerZoneSizefState A SymbolicConstant specifying the propagation state of the centerZoneSize member. Possible values are SET and UNCHANGED. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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:

• • • • • • • • • • • •
7.22.2

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
Corresponding analysis keywords

*SUBMODEL *BOUNDARY, SUBMODEL

7.23

TemperatureBC object

The TemperatureBC object stores the data for a temperature boundary condition.
Access

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

7–55

TemperatureBC object

7.23.1

TemperatureBC(...)

This method creates a TemperatureBC object.
Path

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

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. distribution A SymbolicConstant specifying how the load is distributed spatially. UNIFORM, and USER_DEFINED. 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

Possible values are

A TemperatureBC object.
Exceptions

None.

7–56

TemperatureBC object

7.23.2

setValues(...)

This method modifies the data for an existing TemperatureBC 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 TemperatureBC method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

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

7–57

TemperatureBCState object

Return value

None
Exceptions

None.

7.23.4
name

Members

The TemperatureBC object can have the following members: 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

7.24

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

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

7.24.1

Members

The TemperatureBCState object has the following members: magnitude A Float specifying the temperature magnitude.

7–58

TypeBC object

magnitudeState A SymbolicConstant specifying the propagation state of the temperature magnitude. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED. dof A sequence of Ints specifying the degrees of freedom to which the boundary condition is applied. dofState A SymbolicConstant specifying the propagation state of the dof member. Possible values are SET and UNCHANGED. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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:

• • • • • • • • • • • •
7.24.2

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
Corresponding analysis keywords

*BOUNDARY (degree of freedom: 11 for solids; 11, 12, etc. for shells)

7.25

TypeBC object

The TypeBC object stores the data for several types of predefined boundary conditions that are commonly used in stress/displacement analyses.

7–59

TypeBC object

Access

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

7.25.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.
Exceptions

None.

7.25.2

PinnedBC(...)

This method creates a pinned TypeBC object.
Path

mdb.models[name].PinnedBC

7–60

TypeBC object

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.

7.25.3

XsymmBC(...)

This method creates a TypeBC object that specifies symmetry about the X-axis.
Path

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

7–61

TypeBC object

Return value

A TypeBC object.
Exceptions

None.

7.25.4

YsymmBC(...)

This method creates a TypeBC object that specifies symmetry about the Y-axis.
Path

mdb.models[name].Yf ’submodelsymmBC
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.

7.25.5

ZsymmBC(...)

This method creates a TypeBC object that specifies symmetry about the Z-axis.
Path

mdb.models[name].ZsymmBC

7–62

TypeBC object

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.

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

7–63

TypeBC object

Return value

A TypeBC object.
Exceptions

None.

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

7.25.8

ZasymmBC(...)

This method creates a TypeBC object that specifies antisymmetry about the Z-axis.
Path

mdb.models[name].ZasymmBC

7–64

TypeBC object

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.

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

7–65

TypeBC object

Return value

None
Exceptions

None.

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

7.25.11

Members

The TypeBC object can have the following members: 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. name A String specifying the boundary condition repository key.

7–66

TypeBCState object

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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

7.26

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

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

7.26.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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:

7–67

VelocityBC object

• • • • • • • • • • • •
7.26.2

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
Corresponding analysis keywords

*BOUNDARY, TYPE=XSYMM, YSYMM, ZSYMM, XASYMM, YASYMM, ZASYMM, PINNED, or ENCASTRE

7.27

VelocityBC object

The VelocityBC object stores the data for a velocity boundary condition.
Access

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

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

7–68

VelocityBC object

region A Region object specifying the region to which the boundary condition 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. 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system. distribution A SymbolicConstant specifying how the load is distributed spatially. UNIFORM and USER_DEFINED. The default value is UNIFORM.
Return value

Possible values are

A VelocityBC object.

7–69

VelocityBC object

Exceptions

None.

7.27.2

setValues(...)

This method modifies the data for an existing VelocityBC 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 VelocityBC method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

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

7–70

VelocityBC object

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

7.27.4
name

Members

The VelocityBC object can have the following members: 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 A DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system.

7–71

VelocityBCState object

7.28

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

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

7.28.1
v1

Members

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

7–72

VelocityBCState object

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. amplitude A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference. 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:

• • • • • • • • • • • •
7.28.2

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
Corresponding analysis keywords

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

7–73

Layer object

8.

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.

8.1

Layer object
Objects can be superimposed by displaying them in different layers of a viewport.
Access

session.viewports[name].layers[name]

8.1.1

Layer(...)

This method creates a Layer object in the Layer repository.
Path

session.viewports[name].Layer
Required argument

name A String specifying the repository key.
Optional arguments

None.
Return value

A Layer object.
Exceptions

None.

8.1.2

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 Part, Assembly, Sketch, Odb, or XYPlot object or None specifying the object to be displayed.

8–1

Viewport object

view A View 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.

8.2

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]

8.2.1

Viewport(...)

This method creates a Viewport object with the specified origin and dimensions.
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 width The default width is 200 mm. height A Float specifying the height in millimeters of the viewport. This height includes the title bar. Possible values are height 30 mm. The default height is 135 mm. 30 mm.

8–2

Viewport object

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. If titleStyle=CUSTOM, customTitleString will be used. If titleStyle=SYSTEM, a system-generated string will be used. The default value is SYSTEM. customTitleString A String specifying the viewport title when titleStyle=CUSTOM. The default value is the empty string.
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 >= 30 If height is out of range: RangeError: height must be a Float >= 30

8.2.2

bringToFront()

This method moves the Viewport object to the front.
Arguments

None.
Return value

None

8–3

Viewport object

Exceptions

None.

8.2.3

makeCurrent()

This method makes the Viewport object the current viewport.
Arguments

None.
Return value

None
Exceptions

None.

8.2.4

maximize()

This method maximizes the Viewport object to fill the drawing area.
Arguments

None.
Return value

None
Exceptions

None.

8.2.5

minimize()

This method minimizes the Viewport object to appear as an abbreviated title bar.
Arguments

None.

8–4

Viewport object

Return value

None
Exceptions

None.

8.2.6

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.
Return value

None
Exceptions

None.

8.2.7

restore()

This method restores a maximized or minimized Viewport object to its previous size and location.
Arguments

None.
Return value

None

8–5

Viewport object

Exceptions

None.

8.2.8

sendToBack()

This method moves the Viewport object to the back.
Arguments

None.
Return value

None
Exceptions

None.

8.2.9

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 Part, Assembly, Sketch, Odb, or XYPlot object or None. If displayedObject=None, ABAQUS displays an empty viewport. displayMode A SymbolicConstant specifying the display mode of the viewport. Possible values are SINGLE (display a single displayedObject) or OVERLAY (allow 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.

8–6

Viewport object

viewManipLayers A SymbolicConstant specifying which layer or layers will be controlled by the view manipulation tools when displayMode=OVERLAY. Possible values are ALL or CURRENT. 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.

8.2.10

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 (display a single displayedObject) or OVERLAY (allow 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 or CURRENT. 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.

8–7

Viewport object

windowState A SymbolicConstant specifying the current state of a viewport. Possible values are NORMAL, MAXIMIZED, and MINIMIZED. 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. 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. 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. animationConnect A Boolean specifying whether an animation is connected to the viewport. displayedObject A Part, Assembly, Sketch, Odb, or XYPlot object or None. If displayedObject=None, ABAQUS displays an empty viewport. layers A repository of Layer objects. The key to the repository is a String specifying the name of the layer. view A View 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. animationPlayer An AnimationPlayer object. viewportAnnotationOptions A ViewportAnnotationOptions object. annotationsToPlot An AnnotationsToPlotArray object.

8–8

Connector object

9.

Connector commands
A connector describes the relative motions between two points. A connector also describes the behavior associated with the relative motion.

9.1

Connector object
The Connector object defines the points and orientations for which motion will be permitted or constrained.
Access

import interaction mdb.models[name].connectors[name]

9.1.1

Connector(...)

This method creates a Connector object.
Path

mdb.models[name].Connector
Required arguments

name A String specifying the name of the connector. property A String specifying the connector property. point1 A ModelDot object specifying the first connection point or the SymbolicConstant GROUND. point2 A ModelDot specifying the second connection point or the SymbolicConstant GROUND.
Optional arguments

orientation1 A DatumCsys object specifying the local directions for point 1 of the connector. The orientation1 argument is ignored for connection type LINK. The orientation1 argument is optional for connection types ALIGN, AXIAL, BEAM, CARTESIAN, JOIN, ROTATION, and WELD. For all other connection types, or combinations with any other connection type, the orientation1 argument is required.

9–1

Connector object

orientation2 A DatumCsys object specifying the local directions for point 2 of the connector. The orientation2 argument is not allowed for connection types CARTESIAN, JOIN, LINK, RADIAL-THRUST, SLIDE-PLANE, and SLOT. The orientation2 argument is optional for all other connection types or combinations of connection types.
Return value

A Connector object
Exceptions

ValueError and TextError.

9.1.2

setValues(...)

This method modifies the Connector object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the Connector method, except for the name argument.
Return value

None
Exceptions

ValueError.

9.1.3

Members

The Connector object has members with the same names and descriptions as the arguments to the Connector method.
9.1.4 Corresponding analysis keywords

*ELEMENT, TYPE=CONN2D, *ELEMENT, TYPE=CONN3D, *CONNECTOR SECTION

9–2

ConnectorDamage object

9.2

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 interaction mdb.models[name].connectorProperties[name].behaviorOptions[i]

9.2.1

Members

The ConnectorBehaviorOption object has the following member: 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.

9.3

ConnectorDamage object
The ConnectorDamage object defines damage behavior for one or more components of a connector’s relative motion.
Access

import interaction mdb.models[name].connectorProperties[name].behaviorOptions[i]

9.3.1

ConnectorDamage(...)

This method creates a connector damage behavior option for a ConnectorProperty object.
Path

mdb.models[name].connectorProperties[name].ConnectorDamage
Required arguments

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.

9–3

ConnectorDamage object

initiationTable A sequence of sequences of Floats. Items in the initiationTable data are described below.
Optional arguments

criterion A SymbolicConstant indicating 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. initiationDependencies An Int specifying the number of field variable dependencies for the initiation data. The default value is 0. evolution A Boolean specifying whether damage evolution data will be used. The default value is ON. evolutionType A SymbolicConstant indicating the type of damage evolution to be specified. Possible values are MOTION and ENERGY. The default value is MOTION. This argument is only applicable when evolution=ON. softening A SymbolicConstant indicating the damage evolution law to be specified. Possible values are LINEAR, EXPONENTIAL, and TABULAR. The default value is LINEAR. This argument is only applicable when evolution=ON and when evolutionType=MOTION. useAffected A Boolean that indicates 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 only applicable when 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 only applicable when evolution=ON and useAffected=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 only applicable when evolution=ON. evolutionTemperature A Boolean specifying whether the evolution data depend on temperature. The default value is OFF. This argument is only applicable when evolution=ON. evolutionDependencies An Int specifying the number of field variable dependencies for the evolution data. The default value is 0. This argument is only applicable when evolution=ON.

9–4

ConnectorDamage object

evolutionTable A sequence of sequences of Floats. Items in the evolutionTable data are described below. This argument is only applicable when evolution=ON. 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 specifed. 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: 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 specifed. 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. 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 criterion=PLASTIC_MOTION. Otherwise, post-initiation (displacement/rotation) at ultimate failure.

at ultimate failure if constitutive relative motion

9–5

ConnectorDamage object

• • • • • • • • • • • • • • • • • • • • •

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

9–6

ConnectorDamping object

9.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.
Return value

None
Exceptions

ValueError.

9.3.3

Members

The ConnectorDamage object has members with the same names and descriptions as the arguments to the ConnectorDamage method.
9.3.4 Corresponding analysis keywords

*CONNECTOR DAMAGE INITIATION, *CONNECTOR DAMAGE EVOLUTION

9.4

ConnectorDamping object
The ConnectorDamping object defines damping behavior for one or more components of a connector’s relative motion.
Access

import interaction mdb.models[name].connectorProperties[name].behaviorOptions[i]

9.4.1

ConnectorDamping(...)

This method creates a connector damping behavior option for a ConnectorProperty object.

9–7

ConnectorDamping object

Path

mdb.models[name].connectorProperties[name].ConnectorDamping
Required arguments

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. table A sequence of sequences of Floats. Items in the table data are described below.
Optional arguments

behavior A SymbolicConstant indicating if the damping behavior is linear or nonlinear. Possible values are LINEAR and NONLINEAR. The default value is LINEAR. coupling A SymbolicConstant indicating if the damping behavior is coupled between the connectors’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. The default value is UNCOUPLED. dependencies An Int specifying the number of field variable dependencies. The default value is 0. independentComponents A sequence of Ints giving the list of independent components that are included in the definition of the connector damping data. This argument is applicable only when 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. 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 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.

9–8

ConnectorDamping object

• • • • • • •

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

9–9

ConnectorElasticity object

Return value

A ConnectorDamping object.
Exceptions

ValueError and TextError.

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

9.4.3

Members

The ConnectorDamping object has members with the same names and descriptions as the arguments to the ConnectorDamping method.
9.4.4 Corresponding analysis keywords

*CONNECTOR DAMPING

9.5

ConnectorElasticity object
The ConnectorElasticity object defines elastic behavior for one or more components of a connector’s relative motion.

9–10

ConnectorElasticity object

Access

import interaction mdb.models[name].connectorProperties[name].behaviorOptions[i]

9.5.1

ConnectorElasticity(...)

This method creates a connector elasticity behavior option for a ConnectorProperty object.

Path

mdb.models[name].connectorProperties[name].ConnectorElasticity
Required argument

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

behavior A SymbolicConstant indicating if the elastic behavior is linear, nonlinear, or rigid. Possible values are LINEAR, NONLINEAR, and RIGID. The default value is LINEAR. coupling A SymbolicConstant indicating if 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. The default value is UNCOUPLED. This argument is not applicable when behavior=RIGID. dependencies An Int specifying the number of field variable dependencies. The default value is 0. This argument is not applicable when behavior=RIGID. independentComponents A sequence of Ints giving the list of independent components that are included in the definition of the connector elasticity data. This argument is applicable only when 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. temperatureDependency A Boolean specifying whether the behavior data depend on temperature. The default value is OFF. This argument is not applicable when behavior=RIGID.

9–11

ConnectorElasticity object

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 when behavior=RIGID. table A sequence of sequences of Floats. Items in the table data are described below. This argument is not applicable when behavior=RIGID. Table data If behavior=LINEAR and coupling=UNCOUPLED, then each sequence of the table data specifies the following:

• • • • • • • • • • • •

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

9–12

ConnectorElasticity object

• • • • • • •

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 ConnectorElasticity object.
Exceptions

ValueError and TextError.

9.5.2

setValues(...)

This method modifies the ConnectorElasticity object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues ConnectorElasticity method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

ValueError.

9.5.3

Members

The ConnectorElasticity object has members with the same names and descriptions as the arguments to the ConnectorElasticity method.

9–13

ConnectorFailure object

9.5.4

Corresponding analysis keywords

*CONNECTOR ELASTICITY

9.6

ConnectorFailure object
The ConnectorFailure object defines failure criteria for one or more components of a connector’s relative motion.
Access

import interaction mdb.models[name].connectorProperties[name].behaviorOptions[i]

9.6.1

ConnectorFailure(...)

This method creates a connector failure behavior option for a ConnectorProperty object.
Path

mdb.models[name].connectorProperties[name].ConnectorFailure
Required argument

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

releaseComponent An Int or the SymbolicConstant ALL. 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 A Float specifying the lower bound for the connector’s relative position for all specified components. The default is to not specify a lower bound. maxMotion A Float specifying the upper bound for the connector’s relative position for all specified components. The default is to not specify an upper bound. minForce A Float specifying the lower bound of the force or moment in the directions of the specified components at which locking occurs. The default is to not specify a lower bound.

9–14

ConnectorFailure object

maxForce A Float specifying the upper bound of the force or moment in the directions of the specified components at which locking occurs. The default is to not specify an upper bound.

Return value

A ConnectorFailure object.

Exceptions

ValueError and TextError.

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

9.6.3

Members

The ConnectorFailure object has members with the same names and descriptions as the arguments to the ConnectorFailure method.
9.6.4 Corresponding analysis keywords

*CONNECTOR FAILURE

9–15

ConnectorFriction object

9.7

ConnectorFriction object
The ConnectorFriction object defines Coulomb-like or hysteretic friction behavior for one or more components of a connector’s relative motion.
Access

import interaction mdb.models[name].connectorProperties[name].behaviorOptions[i]

9.7.1

ConnectorFriction(...)

This method creates a connector friction behavior option for a ConnectorProperty object. Depending upon the arguments provided, the friction behavior can be Coulomb-like or hysteretic in nature.
Path

mdb.models[name].connectorProperties[name].ConnectorFriction
Required argument

frictionModel A SymbolicConstant indicating the desired frictional response model. PREDEFINED and USER_CUSTOMIZED.
Optional arguments

Possible values are

tangentDirection 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. The tangentDirection argument applies only when frictionModel=USER_CUSTOMIZED. stickStiffness 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. componentType A SymbolicConstant specifying the type of the independentComponents. Possible values are POSITION, MOTION, or NO_INDEP_COMPS. The default value is NO_INDEP_COMPS. 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 when frictionModel=USER_CUSTOMIZED. Only available components can be specified.

9–16

ConnectorFriction object

slipDependency A Boolean specifying whether the table data depend on accumulated slip. The default value is OFF. The slipDependency argument applies only when frictionModel=USER_CUSTOMIZED. temperatureDependency A Boolean specifying whether the table data depend on temperature. The default value is OFF. The temperatureDependency argument applies only when frictionModel=USER_CUSTOMIZED. dependencies An Int specifying the number of field variable dependencies. The default value is 0. The dependencies argument applies only when frictionModel=USER_CUSTOMIZED. table A sequence of sequences of Floats. 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. 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.

9–17

ConnectorFriction object

Return value

A ConnectorFriction object.
Exceptions

ValueError and TextError.

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

9.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. 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.
9.7.4 Corresponding analysis keywords

*CONNECTOR FRICTION, *FRICTION

9–18

ConnectorLock object

9.8

ConnectorLock object
The ConnectorLock object defines locking criteria for one or more available components of a connector’s relative motion.
Access

import interaction mdb.models[name].connectorProperties[name].behaviorOptions[i]

9.8.1

ConnectorLock(...)

This method creates a connector lock behavior option for a ConnectorProperty.
Path

mdb.models[name].connectorProperties[name].ConnectorLock
Required argument

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

lockingComponent An Int or the SymbolicConstant ALL. 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 A Float specifying the lower bound for the connector’s relative position for all specified components. The default is to not specify a lower bound. maxMotion A Float specifying the upper bound for the connector’s relative position for all specified components. The default is to not specify an upper bound. minForce A Float specifying the lower bound of the force or moment in the directions of the specified components at which locking occurs. The default is to not specify a lower bound. maxForce A Float specifying the upper bound of the force or moment in the directions of the specified components at which locking occurs. The default is to not specify an upper bound.

9–19

ConnectorPlasticity object

Return value

A ConnectorLock object.
Exceptions

ValueError and TextError.

9.8.2

setValues(...)

This method modifies the ConnectorLock object.
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.

9.8.3

Members

The ConnectorLock object has members with the same names and descriptions as the arguments to the ConnectorLock method.
9.8.4 Corresponding analysis keywords CONNECTOR LOCK *

9.9

ConnectorPlasticity object
The ConnectorPlasticity object defines plastic behavior for one or more components of a connector’s relative motion.
Access

import interaction

9–20

ConnectorPlasticity object

mdb.models[name].connectorProperties[name].behaviorOptions[i]

9.9.1

ConnectorPlasticity(...)

This method creates a connector plasticity behavior option for a ConnectorProperty object.
Path

mdb.models[name].connectorProperties[name].ConnectorPlasticity
Required argument

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

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 indicating the type of isotropic hardening to be specified. Possible values are TABULAR and EXPONENTIAL_LAW. The default value is TABULAR. This argument is only applicable when isotropic=ON. isotropicTemperature A Boolean specifying whether the isotropic data depend on temperature. The default value is OFF. This argument is only applicable when isotropic=ON. isotropicDependencies An Int specifying the number of field variable dependencies for the isotropic data. The default value is 0. This argument is only applicable when isotropic=ON. isotropicTable A sequence of sequences of Floats. Items in the isotropicTable data are described below. This argument is only applicable when 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 indicating 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 only applicable when kinematic=ON. kinematicTemperature A Boolean specifying whether the kinematic data depend on temperature. The default value is OFF. This argument is only applicable when kinematic=ON.

9–21

ConnectorPlasticity object

kinematicDependencies An Int specifying the number of field variable dependencies for the kinematic data. The default value is 0. This argument is only applicable when kinematic=ON. kinematicTable A sequence of sequences of Floats. Items in the kinematicTable data are described below. This argument is only applicable when kinematic=ON. 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. 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.

9–22

ConnectorPlasticity object

• • • • • • • • • • • •

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.

9.9.2

setValues(...)

This method modifies the ConnectorPlasticity object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues ConnectorPlasticity method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

ValueError.

9–23

ConnectorProperty object

9.9.3

Members

The ConnectorPlasticity object has members with the same names and descriptions as the arguments to the ConnectorPlasticity method.
9.9.4 Corresponding analysis keywords

*CONNECTOR PLASTICITY, *CONNECTOR HARDENING

9.10

ConnectorProperty object

A ConnectorProperty object describes the connection type and the behavior of a connector.
Access

import interaction mdb.models[name].connectorProperties[name]

9.10.1

ConnectorProperty(...)

This method creates a ConnectorProperty object and its associated behavior options.
Path

mdb.models[name].ConnectorProperty
Required arguments

name A String specifying the name of the connector property. assembledType A SymbolicConstant specifying the assembled connection type. Possible values are

• • • • • • • • •

BEAM CVJOINT CYLINDRICAL HINGE PLANAR TRANSLATOR UJOINT WELD NONE

9–24

ConnectorProperty object

You cannot include the assembledType argument if translationalType or rotationalType are given a value other than NONE. At least one of the arguments assembledType, translationalType, or rotationalType must be given a value other than NONE. rotationalType A SymbolicConstant specifying the basic rotational connection type. Possible values are:

• • • • • • • • •

ALIGN CARDAN CONSTANT_VELOCITY EULER FLEXION_TORSION REVOLUTE ROTATION UNIVERSAL NONE

You cannot include the rotationalType argument if assembledType is given a value other than NONE. At least one of the arguments assembledType, translationalType, or rotationalType must be given an value other than NONE. translationalType A SymbolicConstant specifying the basic translational connection type. Possible values are:

• • • • • • • •

AXIAL CARTESIAN JOIN LINK RADIAL_THRUST SLIDE_PLANE SLOT NONE

You cannot include the translationalType argument if assembledType is given a value other than NONE. At least one of the arguments assembledType, translationalType, or rotationalType must be given an value other than NONE.
Optional arguments

integration A SymbolicConstant specifying the time integration scheme to use for analysis. Possible values are IMPLICIT or EXPLICIT. The integration argument is applicable only to an ABAQUS/Explicit analysis.

9–25

ConnectorProperty object

u1ReferenceLength A Float value specifying the reference length associated with constitutive response for the first component of relative motion. u2ReferenceLength A Float value specifying the reference length associated with constitutive response for the second component of relative motion. u3ReferenceLength A Float value specifying the reference length associated with constitutive response for the third component of relative motion. ur1ReferenceAngle A Float value specifying the reference angle in degrees associated with constitutive response for the fourth component of relative motion. ur2ReferenceAngle A Float value specifying the reference angle in degrees associated with constitutive response for the fifth component of relative motion. ur3ReferenceAngle A Float value specifying the reference angle in degrees associated with constitutive response for the sixth component of relative motion.
Return value

A ConnectorProperty object.
Exceptions

ValueError and TextError.

9.10.2

setValues(...)

This method modifies the ConnectorProperty object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the ConnectorProperty method, except for the name argument.
Return value

None

9–26

ConnectorStop object

Exceptions

ValueError.

9.10.3

Members

The ConnectorProperty object has members with the same names and descriptions as the arguments to the ConnectorProperty method. In addition, the ConnectorProperty object can have the following member: behaviorOptions An array of ConnectorBehaviorOption objects.
9.10.4 Corresponding analysis keywords

*CONNECTOR SECTION, *CONNECTOR BEHAVIOR, *CONNECTOR CONSTITUTIVE REFERENCE

9.11

ConnectorStop object

The ConnectorStop object defines connector stops for one or more components of a connector’s relative motion.
Access

import interaction mdb.models[name].connectorProperties[name].behaviorOptions[i]

9.11.1

ConnectorStop(...)

This method creates a connector stop behavior option for a ConnectorProperty object.
Path

mdb.models[name].connectorProperties[name].ConnectorStop
Required argument

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.

9–27

ConnectorStop object

Optional arguments

minMotion A Float specifying the lower bound for the connector’s relative position for all specified components. The default is to not specify a lower bound. maxMotion A Float specifying the upper bound for the connector’s relative position for all specified components. The default is to not specify an upper bound.
Return value

A ConnectorStop object.
Exceptions

ValueError and TextError.

9.11.2

setValues(...)

This method modifies the ConnectorStop object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the ConnectorStop method.
Return value

None
Exceptions

ValueError.

9.11.3

Members

The ConnectorStop object has members with the same names and descriptions as the arguments to the ConnectorStop method.
9.11.4 Corresponding analysis keywords

*CONNECTOR STOP

9–28

TangentialBehavior object

9.12

TangentialBehavior object

The TangentialBehavior object specifies tangential behavior for a connector friction behavior option.
Access

import interaction mdb.models[name].connectorProperties[name].behaviorOptions[i].tangentialBehavio

9.12.1

TangentialBehavior(...)

This method creates a TangentialBehavior object.
Path

mdb.models[name].connectorProperties[name].behaviorOptions[i].TangentialBehavio
Required argument

table A sequence of sequences of Floats. Items in the table data are described below.
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 A Float specifying the friction coefficient shear stress limit. The default value is None, specifying no upper limit.

9–29

TangentialBehavior object

maximumElasticSlip This argument applies only to ABAQUS/Standard analyses. A SymbolicConstant specifying the method for modifying the allowable elastic slip. Possible values are FRACTION and ABSOLUTE_DISTANCE. The default value is FRACTION. fraction This argument applies only to ABAQUS/Standard analyses. A Float specifying the ratio of the allowable maximum elastic slip to a characteristic model dimension. absoluteDistance This argument applies only to ABAQUS/Standard analyses. A Float specifying the absolute magnitude of the allowable elastic slip.
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.

9–30

TangentialBehavior object

Exceptions

None.

9.12.2

setValues(...)

This method modifies the TangentialBehavior object.
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.

9.12.3

Members

The TangentialBehavior object has members with the same names and descriptions as the arguments to the TangentialBehavior method.
9.12.4 Corresponding analysis keywords

*FRICTION

9–31

Coupling object

10.

Constraint commands
The Constraint commands define constraints between regions of the model.

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

10.1.1
name

Members

The Constraint object has the following member: A String specifying the constraint repository key.

10.2

Coupling object

The Coupling object defines a constraint between a group of coupling nodes located on a region and a reference point.
Access

import interaction mdb.models[name].constraints[name]

10.2.1

Coupling(...)

This method creates a Coupling object.
Path

mdb.models[name].Coupling

10–1

Coupling object

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. The default value is KINEMATIC.
Optional arguments

localCsys A DatumCsys object specifing the initial orientation of the local coordinate system for the coupling’s degrees of freedom. The default value is None, indicating that the coupling is defined in the global coordinate system. 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. 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.

10–2

Coupling object

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.

10.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
Exceptions

None.

10.2.3

Members

The Coupling object has members with the same names and descriptions as the arguments to the Coupling method.

10–3

DisplayBody object

10.2.4

Corresponding analysis keywords

*COUPLING

10.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.
Access

import interaction mdb.models[name].constraints[name]

10.3.1

DisplayBody(...)

This method creates a DisplayBody object.
Path

mdb.models[name].DisplayBody
Required arguments

name A String specifying the constraint repository key. instance A PartInstance object specifying the part instance that is to be used for display only. controlPoints A sequence of ModelDot objects 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

None

10–4

EmbeddedRegion object

Exceptions

None.

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

10.3.3

Members

The DisplayBody object has members with the same names and descriptions as the arguments to the DisplayBody method.
10.3.4 Corresponding analysis keywords

*DISPLAY BODY

10.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.
Access

import interaction mdb.models[name].constraints[name]

10–5

EmbeddedRegion object

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

absoluteTolerance A Float specifying the absolute value by which a node on the embedded region may lie outside the host region. The default value is 0.0, indicating that the fractionalTolerance value will be used. 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. weightFactorTolerance A Float specifying a small value below which the weighting factors will be zeroed out. The default value is 10–6 .
Return value

An EmbeddedRegion object.
Exceptions

None.

10.4.2

setValues(...)

This method modifies the EmbeddedRegion object.

10–6

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

10.4.3

Members

The EmbeddedRegion object has members with the same names and descriptions as the arguments to the EmbeddedRegion method.
10.4.4 Corresponding analysis keywords

*EMBEDDED ELEMENT

10.5

Equation object

The Equation object defines a linear multi-point constraint between a set of degrees of freedom.
Access

import interaction mdb.models[name].constraints[name]

10.5.1

Equation(...)

This method creates an Equation object.
Path

mdb.models[name].Equation

10–7

Equation object

Required arguments

name A String specifying the constraint repository key. terms A tuple of tuples specifying a coefficient, Set name, degree of freedom, and coordinate system ID. The coordinate system ID is optional.
Optional arguments

None.
Return value

An Equation object.
Exceptions

If terms does not contain more than one entry: Equation must have two or more terms.

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

10.5.3

Members

The Equation object has members with the same names and descriptions as the arguments to the Equation method.

10–8

RigidBody object

10.5.4

Corresponding analysis keywords

*EQUATION

10.6

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

import interaction mdb.models[name].constraints[name]

10.6.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 A Region object specifying the elements constrained to the movement of the reference point. The default value is None. tieRegion A Region object specifying the nodes tied to the movement of the reference point. The default value is None. pinRegion A Region object specifying the nodes pinned to the movement of the reference point. The default value is None. surfaceRegion A Region object specifying the analytic surface constrained to the movement of the reference point. The default value is None.

10–9

RigidBody object

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

None
Exceptions

None.

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

10.6.3

Members

The RigidBody object has members with the same names and descriptions as the arguments to the RigidBody method.
10.6.4 Corresponding analysis keywords

*RIGID BODY

10–10

ShellSolidCoupling object

10.7

ShellSolidCoupling object

The ShellSolidCoupling object defines two surfaces to be tied together for the duration of a simulation.
Access

import interaction mdb.models[name].constraints[name]

10.7.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 positionTolerance argument applies only when positionToleranceMethod=SPECIFIED. The default value is 0. Note: ABAQUS will not constrain nodes on the solid face region outside the position tolerance. 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.

10–11

Tie object

Return value

None
Exceptions

None.

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

10.7.3

Members

The ShellSolidCoupling object has members with the same names and descriptions as the arguments to the ShellSolidCoupling method.
10.7.4 Corresponding analysis keywords

*SHELL TO SOLID COUPLING

10.8

Tie object

The Tie object defines two surfaces to be tied together for the duration of a simulation.
Access

import interaction

10–12

Tie object

mdb.models[name].constraints[name]

10.8.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. positionTolerance A Float specifying the position tolerance. The positionTolerance argument applies only when positionToleranceMethod=SPECIFIED. The default value is 0. Note: Nodes on the slave surface outside the position tolerance will NOT be tied. 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.

10–13

Tie object

constraintEnforcement A SymbolicConstant specifying the method used to determine the constraint enforcement. 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

None
Exceptions

None.

10.8.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
Exceptions

None.

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

10–14

Tie object

Return value

None
Exceptions

None.

10.8.4

Members

The Tie object has members with the same names and descriptions as the arguments to the Tie method.
10.8.5 Corresponding analysis keywords

*TIE

10–15

CommandRegister object

11.

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.6 of the ABAQUS GUI Toolkit User’s Manual.

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

11.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.
Arguments

None.

Return value

A CommandRegister object.

11–1

RepositorySupport object

Exceptions

None.

11.1.2

Members

The CommandRegister object has no members.

11.2

RepositorySupport object

The RepositorySupport class derives from CommandRegister and 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.
Access

import customKernel mdb.customData session.customData

11.2.1

RepositorySupport()

This method creates a RepositorySupport object.
Arguments

None.
Return value

A RepositorySupport object.
Exceptions

None.

11.2.2

Repository(...)

This method installs a repository on the class. The repository is an instance of a RegisteredDictionary class. Refer to “RegisteredDictionary object,” Section 11.3 for details on its methods.

11–2

RegisteredDictionary object

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.

11.2.3

Members

The RepositorySupport object has no members.

11.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.
Access

import customKernel

11.3.1

RegisteredDictionary(...)

This method creates a RegisteredDictionary object.

11–3

RegisteredDictionary object

Path

RegisteredDictionary
Arguments

None.
Return value

A RegisteredDictionary object.
Exceptions

None.

11.3.2

Methods

The RegisteredDictionary object supports the same methods as a Python dictionary. In addition, the RegisteredDictionary object supports the changeKey method.

11.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. toName A String or an integer specifying the new name for the key.
Optional arguments

None.
Return value

None
Exceptions

None.

11–4

RegisteredList object

11.3.4

Members

The RegisteredDictionary object has no members.

11.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.
Access

import customKernel

11.4.1

RegisteredList()

This method creates a RegisteredList object.
Path

RegisteredList
Arguments

None.
Return value

A RegisteredList object.
Exceptions

None.

11.4.2

Methods

The RegisteredList object supports the same methods as a standard Python list object.

11.4.3

Members

The RegisteredList object has no members.

11–5

RegisteredTuple object

11.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.
Access

import customKernel

11.5.1

RegisteredTuple(...)

This method creates a RegisteredTuple object.
Path

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

11.5.2

Methods

The RegisteredTuple object supports the same methods as a standard Python tuple object.

11.5.3

Members

The RegisteredTuple object has no members.

11–6

DatumAxis object

12.

Datum commands
Datum commands return Feature objects and inherit the methods of Feature objects; for more details, see Chapter 17, “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.

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

12.1.1

Members

The Datum object has no members.

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

12–1

DatumPlane object

12.2.1

Members

The DatumAxis object has no members.

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

12.3.1
origin

Members

The DatumCsys object can have the following members: A DatumPoint object indicating the origin of the coordinate system. axis1 A DatumAxis object indicating the 1-direction of the coordinate system. axis2 A DatumAxis object indicating the 2-direction of the coordinate system. axis3 A DatumAxis object indicating the 3-direction of the coordinate system.

12.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.
Access

import part mdb.models[name].parts[name].datums[i]

12–2

DatumPoint object

import assembly mdb.models[name].rootAssembly.datums[i] mdb.models[name].rootAssembly.instances[name].datums[i]

12.4.1

Members

The DatumPlane object has no members.

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

12.5.1

Members

The DatumPoint object has no members.

12–3

DisplayGroup object

13.
13.1

Display Group commands
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 import visualization session.viewports[name].odbDisplay.displayGroup import part session.viewports[name].partDisplay.displayGroup

13.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.
Exceptions

InvalidNameError.

13–1

DisplayGroup object

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

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

13–2

DisplayGroup object

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

13.1.5

remove(...)

This method removes the specified items from the display group.
Arguments Required argument

leaf A Leaf object specifying the items to remove from the display group.
Optional arguments

None.
Return value

None
Exceptions

None.

13.1.6

replace(...)

This method replaces the contents of the display group with the specified items.

13–3

DisplayGroupInstance object

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.

13.1.7
name

Members

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

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

13–4

DisplayGroupInstance object

session.viewports[name].assemblyDisplay.displayGroupInstances[name] import visualization session.viewports[name].odbDisplay.displayGroupInstances[name] import part session.viewports[name].partDisplay.displayGroupInstances[name]

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

13.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.
Exceptions

None.

13–5

DisplayGroupInstance object

13.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 argument specifying whether you can change the odbDisplayOptions on the DisplayGroupInstance object.

Return value

None

Exceptions

None.

13.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. odbDisplayOptions An OdbDisplayOptions object. This member is available only for DisplayGroupInstance objects that are members of the DisplayGroupInstance repository member of the OdbDisplay object.

13–6

DisplayGroupInstanceRepository object

13.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].odbDisplay.displayGroupInstances

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

13.3.2

Members

The DisplayGroupInstanceRepository object has no members.

13–7

Leaf object

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

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

13.4.2

Members

The Leaf object has members with the same names and descriptions as the arguments to the Leaf method.

13–8

LeafFromDisplayGroup object

13.5

LeafFromDisplayGroup object

The LeafFromDisplayGroup object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset import displayGroupOdbToolset

13.5.1

LeafFromDisplayGroup(...)

This method creates a Leaf object from a sequence of Display Group objects.
Path

LeafFromDisplayGroup
Required argument

displayGroup A sequence of DisplayGroup objects.
Optional arguments

None.
Return value

A LeafFromDisplayGroup object.
Exceptions

None.

13.5.2

Members

The LeafFromDisplayGroup object has members with the same names and descriptions as the arguments to the LeafFromDisplayGroup method. 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.

13–9

LeafFromElementLabels object

13.6

LeafFromElementLabels object

The LeafFromElementLabels object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

13.6.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 expressions specifying element labels. The expression can be any of the following:

• • •
None.

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

Return value

A LeafFromElementLabels object.
Exceptions

None.

13–10

LeafFromElementSets object

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

13.7

LeafFromElementSets object

The LeafFromElementSets object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

13.7.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.
Exceptions

None.

13–11

LeafFromElementVarRange object

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

13.8

LeafFromElementVarRange object

The LeafFromElementVarRange object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

13.8.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 a large negative number. maximumRange A Float specifying the maximum value for the variable range. The default value is a large positive number. insideRange A Boolean specifying the method used to evaluate the range. The default value is ON indicating that the range falls inside the specified minimum and maximum values.

13–12

LeafFromGeometry object

Return value

A LeafFromElementVarRange object.
Exceptions

None.

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

13.9

LeafFromGeometry object

The LeafFromGeometry object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset

13.9.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.
Path

LeafFromGeometry
Required arguments

None.
Optional arguments

edgeSeq A sequence of geometry edges.

13–13

LeafFromInstance object

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.

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

13.10

LeafFromInstance object

The LeafFromInstance object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset

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

13–14

LeafFromInstanceElementLabels object

Optional arguments

None.
Return value

A LeafFromInstance object.
Exceptions

If an invalid argument is passed to this method: Cannot define empty leaf.

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

13.11

LeafFromInstanceElementLabels object

The LeafFromInstanceElementLabels object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset

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

13–15

LeafFromInstanceNodeLabels object

Optional arguments

None.
Return value

A LeafFromInstanceElementLabels object.
Exceptions

None.

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

13.12

LeafFromInstanceNodeLabels object

The LeafFromInstanceNodeLabels object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset

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

13–16

LeafFromMeshElementLabels object

Optional arguments None. Return value

A LeafFromInstanceNodeLabels object.
Exceptions

None.

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

13.13

LeafFromMeshElementLabels object

The LeafFromMeshElementLabels object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset

13.13.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 MeshSequence objects specifying elements.

13–17

LeafFromMeshNodeLabels object

Optional arguments

None.
Return value

A LeafFromMeshElementLabels object.
Exceptions

None.

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

13.14

LeafFromMeshNodeLabels object

The LeafFromMeshNodeLabels object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset

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

nodetSeq A sequence of MeshSequence objects specifying nodes.

13–18

LeafFromMeshSurfaceSets object

Optional arguments

None.
Return value

A LeafFromMeshNodeLabels object.
Exceptions

None.

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

13.15

LeafFromMeshSurfaceSets object

The LeafFromMeshSurfaceSets object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset

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

13–19

LeafFromModelElemLabels object

Return value

A LeafFromMeshSurfaceSets object.
Exceptions

None.

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

13.16

LeafFromModelElemLabels object

The LeafFromModelElemLabels object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

13.16.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 expressions specifying 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.

13–20

LeafFromModelNodeLabels object

• •
None.

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

Return value

A LeafFromModelElemLabels object.
Exceptions

None.

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

13.17

LeafFromModelNodeLabels object

The LeafFromModelNodeLabels object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

13.17.1

LeafFromModelNodeLabels(...)

This method creates a Leaf object from a sequence of node labels spanning several part instances.
Path

LeafFromModelNodeLabels

13–21

LeafFromNodeLabels object

Required argument

nodeLabels A sequence of expressions specifying 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:

• • •
None.

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

Return value

A LeafFromModelNodeLabels object.
Exceptions

None.

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

13.18

LeafFromNodeLabels object

The LeafFromNodeLabels object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

13–22

LeafFromNodeSets object

13.18.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 expressions specifying node labels. The expression can be any of the following:

• • •
None.

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

Return value

A LeafFromNodeLabels object.
Exceptions

None.

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

13.19

LeafFromNodeSets object

The LeafFromNodeSets object is a subtype of the Leaf object and 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.

13–23

LeafFromNodeVarRange object

Access

import displayGroupOdbToolset

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

None.
Return value

A LeafFromNodeSets object.
Exceptions

None.

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

13.20

LeafFromNodeVarRange object

The LeafFromNodeVarRange object is a subtype of the Leaf object and 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.

13–24

LeafFromNodeVarRange object

Access

import displayGroupOdbToolset

13.20.1

LeafFromNodeVarRange(...)

This method creates a Leaf object from nodes with values lying in a variable range.
Path

LeafFromNodeVarRange
Required arguments

None.
Optional arguments

minimumRange A Float specifying the minimum value for the variable range. The default value is a large negative number. maximumRange A Float specifying the maximum value for the variable range. The default value is a large positive number. insideRange A Boolean specifying the method used to evaluate the range. The default value is ON indicating that the range falls inside the specified minimum and maximum values.
Return value

A LeafFromNodeVarRange object.
Exceptions

None.

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

13–25

LeafFromOdbElementMaterials object

13.21

LeafFromOdbElementMaterials object

The LeafFromOdbElementMaterials object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

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

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

13–26

LeafFromOdbElementPick object

13.22

LeafFromOdbElementPick object

The LeafFromOdbElementPick object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

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

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

13–27

LeafFromOdbElementSections object

13.23

LeafFromOdbElementSections object

The LeafFromOdbElementSections object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

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

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

13–28

LeafFromOdbElementTypes object

13.24

LeafFromOdbElementTypes object

The LeafFromOdbElementTypes object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

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

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

13–29

LeafFromOdbNodePick object

13.25

LeafFromOdbNodePick object

The LeafFromOdbNodePick object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

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

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

13–30

LeafFromPartElementLabels object

13.26

LeafFromPartElementLabels object

The LeafFromPartElementLabels object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset

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

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

13–31

LeafFromPartInstance object

13.27

LeafFromPartInstance object

The LeafFromPartInstance object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

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

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

13–32

LeafFromPartNodeLabels object

13.28

LeafFromPartNodeLabels object

The LeafFromPartNodeLabels object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset

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

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

13–33

LeafFromSets object

13.29

LeafFromSets object

The LeafFromSets object is a subtype of the Leaf object and 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.
Access

import displayGroupMdbToolset

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

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

13–34

LeafFromSurfaceSets object

13.30

LeafFromSurfaceSets object

The LeafFromSurfaceSets object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

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

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

13–35

LeafFromSurfaceVarRange object

13.31

LeafFromSurfaceVarRange object

The LeafFromSurfaceVarRange object is a subtype of the Leaf object and 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.
Access

import displayGroupOdbToolset

13.31.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 a large negative number. maximumRange A Float specifying the maximum value for the variable range. The default value is a large positive number. insideRange A Boolean specifying the method used to evaluate the range. The default value is ON indicating that the range falls inside the specified minimum and maximum values.
Return value

A LeafFromSurfaceVarRange object.
Exceptions

None.

13–36

LeafFromSurfaceVarRange object

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

13–37

AssemblyDisplayOptions object

14.
14.1

Display Options commands
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

14.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 initial 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 initial value is “Initial.” renderStyle A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are WIREFRAME, HIDDEN, SHADED, and FILLED. The initial value is WIREFRAME. mesh A Boolean specifying whether the mesh is shown. The initial value is OFF. loads A Boolean specifying whether loads are shown. The initial value is OFF. bcs A Boolean specifying whether boundary conditions are shown. The initial value is OFF.

14–1

AssemblyDisplayOptions object

interactions A Boolean specifying whether interactions are shown. The initial value is OFF. constraints A Boolean specifying whether constraints are shown. The initial value is OFF. connectors A Boolean specifying whether connectors are shown. The initial value is OFF. fields A Boolean specifying whether fields and initial conditions are shown. The initial 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 initial value is an empty sequence. engineeringFeatures A Boolean specifying whether engineering features are shown. The initial value is OFF.
Return value

None
Exceptions

RangeError.

14.1.2
bcs

Members

The AssemblyDisplayOptions object can have the following members: A Boolean specifying whether boundary conditions are shown. connectors A Boolean specifying whether connectors are shown. constraints A Boolean specifying whether constraints are shown. engineeringFeatures A Boolean specifying whether to display engineering features. fields A Boolean specifying whether fields and initial conditions are shown. interactions A Boolean specifying whether interactions are shown. loads A Boolean specifying whether loads are shown.

14–2

BCDisplayOptions object

mesh A Boolean specifying whether the mesh is shown. renderStyle A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are WIREFRAME, HIDDEN, SHADED, and FILLED. step A String specifying the step for which objects are to be displayed. Possible values are any valid step name. visibleInstances A sequence of Strings specifying the names of the instances that are visible in the viewport. 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. fieldOptions A FieldDisplayOptions object. geometryOptions A GeometryDisplayOptions object. interactionOptions An InteractionDisplayOptions object. loadOptions A LoadDisplayOptions object. meshOptions A MeshDisplayOptions object. symbolOptions A SymbolDisplayOptions object.

14.2

BCDisplayOptions object

The BCDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when

14–3

BCDisplayOptions object

session.viewports[name].assemblyDisplay.bcs=ON 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

14.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 initial value is ON. velocity A Boolean specifying whether velocity symbols are shown. The initial value is ON. acceleration A Boolean specifying whether acceleration symbols are shown. The initial value is ON. symmetry A Boolean specifying whether symmetry symbols are shown. The initial value is ON. antiSymmetry A Boolean specifying whether anti- symmetry symbols are shown. The initial value is ON. temperature A Boolean specifying whether temperature symbols are shown. The initial value is ON. porePressure A Boolean specifying whether pore pressure symbols are shown. The initial value is ON. fluidCavityPressure A Boolean specifying whether fluid cavity pressure symbols are shown. The initial value is ON. acousticPressure A Boolean specifying whether acoustic pressure symbols are shown. The initial value is ON. electricPotential A Boolean specifying whether electric potential symbols are shown. The initial value is ON. concentration A Boolean specifying whether concentration mass diffusion symbols are shown. The initial value is ON.

14–4

ConstraintDisplayOptions object

encastre A Boolean specifying whether encastre symbols are shown. The initial value is ON. pinned A Boolean specifying whether pinned symbols are shown. The initial value is ON.
Return value

None
Exceptions

None.

14.2.2

Members

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

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

14.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 initial value is ON.

14–5

EngineeringFeatureDisplayOptions object

tieConstraint A Boolean specifying whether tie constraint symbols are shown. The initial value is ON. rigidBodyConstraint A Boolean specifying whether rigid body constraint symbols are shown. The initial value is ON. displayBodyConstraint A Boolean specifying whether display body constraint symbols are shown. The initial value is ON. couplingConstrain A Boolean specifying whether coupling constraint symbols are shown. The initial value is ON.
Return value

None
Exceptions

None.

14.3.2

Members

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

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

14.4.1

setValues(...)

This method modifies the EngineeringFeatureDisplayOptions object.

14–6

FieldDisplayOptions object

Arguments Required arguments

None.
Optional arguments

pointMassInertia A Boolean specifying whether point mass inertia symbols are shown. The initial value is ON. nonstructuralMass A Boolean specifying whether nonstructural mass symbols are shown. The initial value is ON. heatCapacitance A Boolean specifying whether heat capacitance symbols are shown. The initial value is ON. contourIntegral A Boolean specifying whether contour integral symbols are shown. The initial value is ON. springToGround A Boolean specifying whether spring-to-ground symbols are shown. The initial value is ON. twoPointSpring A Boolean specifying whether two-point spring symbols are shown. The initial value is ON.
Return value

None
Exceptions

RangeError.

14.4.2

Members

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

14.5

FieldDisplayOptions object

The FieldDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when session.viewports[name].assemblyDisplay.fields=ON The FieldDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

14–7

FieldDisplayOptions object

Access

session.viewports[name].assemblyDisplay.fieldOptions

14.5.1

setValues(...)

This method modifies the FieldDisplayOptions object.
Arguments Required arguments

None.
Optional arguments

temperatureField A Boolean specifying whether temperature field symbols are shown. The initial value is ON. velocityField A Boolean specifying whether translational velocity symbols are shown. The initial value is ON. generalField A Boolean specifying whether general field symbols are shown. The initial value is ON. stressField A Boolean specifying whether stress field symbols are shown. The initial value is ON. hardeningField A Boolean specifying whether hardening field symbols are shown. The initial value is ON.

Return value

None

Exceptions

RangeError.

14.5.2

Members

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

14–8

GeometryDisplayOptions object

14.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].partDisplay.geometryOptions

14.6.1

setValues(...)

This method modifies the GeometryDisplayOptions object.
Arguments Required arguments

None.
Optional arguments

ambientColor A sequence of three Ints specifying the color of the ambient light in the scene. Possible values are 0 ambientColor 255. The first integer is for red, the second for green, and the third for blue. For example, yellow is represented by: (255,255,0) The initial value is grey, represented by (63, 63, 63). geometryEdgesInShaded A Boolean specifying whether geometry edges are displayed in shaded mode. The initial value is ON. geometryHiddenEdges A Boolean specifying whether geometry hidden edges are displayed (dotted) in hidden line mode. The initial value is OFF. geometrySilhouetteEdges A Boolean specifying whether geometry silhouette edges are displayed. The initial value is ON. datumAxes A Boolean specifying whether datum axes are shown. The initial value is ON. datumCoordSystems A Boolean specifying whether datum coordinate systems are shown. The initial value is ON.

14–9

GeometryDisplayOptions object

datumPlanes A Boolean specifying whether datum planes are shown. The initial value is ON. materialShininess An Int specifying the reflective property of the surface of the object with respect to specular lighting. Possible values are 0 materialShininess 128, going from matte to mirror-like. The initial value is 40. referencePointLabels A Boolean specifying whether referencePoint labels are shown. The initial value is ON. referencePointSymbols A Boolean specifying whether referencePoint symbols are shown. The initial value is ON. shoulderDiffuseIntensity An Int specifying the diffuse property of the directional lights in the scene. Possible values are 0 shoulderDiffuseIntensity 100. The initial value is 70. shoulderSpecularIntensity An Int specifying the specular property of the directional lights in the scene. Possible values are 0 shoulderSpecularIntensity 100. The initial value is 60. specularColor A sequence of three Ints specifying the color of the directional lights in the scene. Possible values are 0 specularColor 255. The first integer is for red, the second for green, and the third for blue. For example, yellow is represented by: (255,255,0) The intial value is white, represented by (255, 255, 255).

Return value

None

Exceptions

RangeError.

14.6.2

Members

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

14–10

GraphicsInfo object

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

14.7.1

Members

The GraphicsInfo object has the following members: 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. glVersion A tuple consisting of an Int specifying the OpenGL major version number, an Int specifying the OpenGL minor version number, and a String specifying any additional information. glxServerVendor A String on the server side specifying the glx developer . glxServerVersion A tuple consisting of an Int specifying the glx major version number, an Int specifying the glx minor version number, and a String specifying any additional information. glxClientVendor A String on the client side specifying the glx developer. glxClientVersion A tuple consisting of an Int specifying the glx major version number, an Int specifying the glx minor version number, and String specifying any additional information.

14–11

GraphicsOptions object

14.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 DefaultGraphicsOptions 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.
Access

session.defaultGraphicsOptions session.graphicsOptions

14.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 initial 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

14–12

GraphicsOptions object

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. Display lists operate only when graphicsDriver=OPEN_GL. The initial value is ON. Display lists control an optimization for graphics. When displayLists=ON, every drawing operation is recorded in a list that can be quickly replayed if necessary. This results in faster drawing on most systems but requires extra memory to record each drawing operation. Display lists are never used in the Visualization module, and this argument has no effect. highlightMethodHint A sequence of SymbolicConstants specifying a hint used to modify the highlight method. Possible values are: HARDWARE_OVERLAY The best graphics performance is achieved using hardware overlay, but not all systems and graphics adapters support hardware overlay. XOR The XOR technique uses a boolean pixel operation to simulate the drawing operations but can produce different colors depending on the the color of the underlying pixels. SOFTWARE_OVERLAY The software overlay method simulates the effect of hardware overlay. BLEND 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: image will be rendered in wireframe. AS_IS: image will be rendered as is.

14–13

GraphicsOptions object

The initial 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 signficant loss of performance. autoFitAfterRotate A Boolean specifying whether the model is automatically resized to fit the viewport after each view rotation. The initial 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 initial 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 initial 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 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 ABAQUS 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 initial value is ON.

14–14

GraphicsOptions object

vertexArraysInDisplayLists A Boolean specifying if the vertexArrays setting should temporarily be set to OFF when building a display list. The initial 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. directRendering A Boolean specifying how ABAQUS renders 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 initial 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 a hardware overlay plane will be used if one is available. The initial value is ON. When hardwareOverlay=OFF, the HARDWARE_OVERLAY highlight method will not be available. Turning off hardware overlay is necessary only if viewports display a solid color and will not display your model. The hardwareOverlay member is used only when you first start ABAQUS/CAE; you cannot configure hardwareOverlay during a session. floatingPointExceptions A Boolean specifying whether floating point exceptions generated by a graphics adapter should be ignored. The initial value is ON. Some graphics adapters produce floating point exceptions that are safe to ignore; but, by default, ABAQUS aborts when a floating point exception is thrown. Setting this value to OFF will cause ABAQUS to ignore floating point exceptions generated when producing a display. textureMapping A Boolean specifying whether textures will be used to display contour plots. The initial value is ON. Turning off texture mapping is necessary only if viewports will not correctly display a contour plot of your model.

14–15

GraphicsOptions object

backgroundStyle A SymbolicConstant specifying the background style to be used for all viewport windows. Possible values are SOLID and GRADIENT. 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. The initial value is SOLID. 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. options 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.

14.8.2

Members

The GraphicsOptions object can have the following members: 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 initial 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

14–16

GraphicsOptions object

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. Display lists operate only when graphicsDriver=OPEN_GL. The initial value is ON. Display lists control an optimization for graphics. When displayLists=ON, every drawing operation is recorded in a list that can be quickly replayed if necessary. This results in faster drawing on most systems but requires extra memory to record each drawing operation. Display lists are never used in the Visualization module, and this argument has no effect. highlightMethodHint A sequence of SymbolicConstants specifying a hint used to modify the highlight method. Possible values are: HARDWARE_OVERLAY The best graphics performance is achieved using hardware overlay, but not all systems and graphics adapters support hardware overlay. XOR The XOR technique uses a boolean pixel operation to simulate the drawing operations but can produce different colors depending on the the color of the underlying pixels. SOFTWARE_OVERLAY The software overlay method simulates the effect of hardware overlay. BLEND 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: image will be rendered in wireframe. AS_IS: image will be rendered as is.

14–17

GraphicsOptions object

The initial 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 signficant loss of performance. autoFitAfterRotate A Boolean specifying whether the model is automatically resized to fit the viewport after each view rotation. The initial 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 initial 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 initial 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 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. printPolygonOffsetSlop 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 ABAQUS 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 initial value is ON.

14–18

GraphicsOptions object

vertexArraysInDisplayLists A Boolean specifying if the vertexArrays setting should temporarily be set to OFF when building a display list. The initial 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. directRendering A Boolean specifying how ABAQUS renders 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 initial 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 a hardware overlay plane will be used if one is available. The initial value is ON. When hardwareOverlay=OFF, the HARDWARE_OVERLAY highlight method will not be available. Turning off hardware overlay is necessary only if viewports display a solid color and will not display your model. The hardwareOverlay member is used only when you first start ABAQUS/CAE; you cannot configure hardwareOverlay during a session. floatingPointExceptions A Boolean specifying whether floating point exceptions generated by a graphics adapter should be ignored. The initial value is ON. Some graphics adapters produce floating point exceptions that are safe to ignore; but, by default, ABAQUS aborts when a floating point exception is thrown. Setting this value to OFF will cause ABAQUS to ignore floating point exceptions generated when producing a display. textureMapping A Boolean specifying whether textures will be used to display contour plots. The initial value is ON. Turning off texture mapping is necessary only if viewports will not correctly display a contour plot of your model.

14–19

InteractionDisplayOptions object

backgroundStyle A SymbolicConstant specifying the background style to be used for all viewport windows. Possible values are SOLID and GRADIENT. If backgroundStyle is set to SOLID, the viewport background will appear as a solid color as specified by backgroundColor. If backgroundStyle is set to 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. The initial value is SOLID. 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 is set to GRADIENT. The initial color is black. A list of valid color strings is in the colors map in the session object. 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. options 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.

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

14–20

InteractionDisplayOptions object

14.9.1

setValues(...)

This method modifies the InteractionDisplayOptions object.
Arguments Required arguments

None.
Optional arguments

surfaceContact A Boolean specifying whether surface contact symbols are shown. The initial value is ON. selfContact A Boolean specifying whether self contact symbols are shown. The initial value is ON. elasticFoundation A Boolean specifying whether elastic foundation symbols are shown. The initial value is ON. actuatorSensor A Boolean specifying whether actuator/sensor symbols are shown. The initial value is ON. radiationAmbient A Boolean specifying whether surface radiation-to-ambient symbols are shown. The initial value is ON. filmCondition A Boolean specifying whether surface film condition symbols are shown. The initial value is ON. concentratedRadiationToAmbient A Boolean specifying whether concentrated radiation-to-ambient symbols are shown. The initial value is ON. concentratedFilmCondition A Boolean specifying whether concentrated film condition symbols are shown. The initial value is ON.
Return value

None
Exceptions

RangeError.

14.9.2

Members

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

14–21

LoadDisplayOptions object

14.10

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

14.10.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 initial value is ON. moment A Boolean specifying whether moment symbols are shown. The initial value is ON. pressure A Boolean specifying whether pressure symbols are shown. The initial value is ON. pipePressure A Boolean specifying whether pipe pressure symbols are shown. The initial value is ON. bodyForce A Boolean specifying whether body force symbols are shown. The initial value is ON. lineLoad A Boolean specifying whether line load symbols are shown. The initial value is ON. gravity A Boolean specifying whether gravity symbols are shown. The initial value is ON. boltLoad A Boolean specifying whether bolt load symbols are shown. The initial value is ON. pegLoad A Boolean specifying whether PEG load symbols are shown. The initial value is ON.

14–22

LoadDisplayOptions object

connectorForce A Boolean specifying whether connector force symbols are shown. The initial value is ON. connectorMoment A Boolean specifying whether connector moment symbols are shown. The initial value is ON. inertiaRelief A Boolean specifying whether inertia relief symbols are shown. The initial value is ON. rotationalIntertiaLoad A Boolean specifying whether rotational inertia load symbols are shown. The initial value is ON. bodyHeatFlux A Boolean specifying whether body heat flux symbols are shown. The initial value is ON. surfaceHeatFlux A Boolean specifying whether surface heat flux symbols are shown. The initial value is ON. concentratedHeatFlux A Boolean specifying whether concentrated heat flux symbols are shown. The initial value is ON. concentratedPoreFluid A Boolean specifying whether concentrated pore fluid symbols are shown. The initial value is ON. surfacePoreFluid A Boolean specifying whether surface pore fluid symbols are shown. The initial value is ON. hydroFluidFlow A Boolean specifying whether hydro fluid flow symbols are shown. The initial value is ON. concentratedCharge A Boolean specifying whether concentrated charge symbols are shown. The initial value is ON. concentratedCurrent A Boolean specifying whether concentrated current symbols are shown. The initial value is ON. surfaceCharge A Boolean specifying whether surface charge symbols are shown. The initial value is ON. surfaceCurrent A Boolean specifying whether surface current symbols are shown. The initial value is ON. bodyCharge A Boolean specifying whether body charge symbols are shown. The initial value is ON. bodyCurrent A Boolean specifying whether body current symbols are shown. The initial value is ON. inwardVolAccel A Boolean specifying whether inward volume acceleration symbols are shown. The initial value is ON. bodyConcentrationFlux A Boolean specifying whether body concentration flux symbols are shown. The initial value is ON.

14–23

MeshDisplayOptions object

surfaceConcentrationFlux A Boolean specifying whether surface concentration flux symbols are shown. The initial value is ON. concentratedConcentrationFlux A Boolean specifying whether concentrated concentration flux symbols are shown. The initial value is ON.
Return value

None
Exceptions

RangeError.

14.10.2

Members

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

14.11

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].partDisplay.meshOptions

14.11.1

setValues(...)

This method modifies the MeshDisplayOptions object.
Arguments Required arguments

None.

14–24

MeshDisplayOptions object

Optional arguments

nodeLabels A Boolean specifying whether node labels are shown. The initial value is OFF. elementLabels A Boolean specifying whether element labels are shown. The initial value is OFF. meshVisibleEdges A SymbolicConstant specifying how the mesh’s edges are drawn. Possible values are:

• • • • •

ALL: show all edges. EXTERIOR: show only exterior edges. FEATURE: show edges determined by featureAngle. FREE: show only free edges. NONE: do not display any edges.

The initial value is EXTERIOR. featureAngle A Float specifying the angle in degrees to be used in calculating a feature edge plot. Possible values are 0 featureAngle 90. The initial value is 20°. meshEdgesInShaded A Boolean specifying whether mesh edges are displayed in shaded mode. The initial 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. The default value is OFF. This argument is ignored in partDisplay. seeds A Boolean specifying whether seeds are shown. The initial value is OFF. This argument is ignored in partDisplay.
Return value

None
Exceptions

RangeError.

14.11.2

Members

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

14–25

PartDisplayOptions object

14.12

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

import part session.viewports[name].partDisplay

14.12.1

setValues(...)

This method modifies the PartDisplayOptions object.
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 initial 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 initial value is an empty sequence. engineeringFeatures A Boolean specifying whether engineering features are shown. The initial value is OFF.
Return value

None
Exceptions

RangeError.

14.12.2

Members

The PartDisplayOptions object can have the following members:

14–26

SymbolDisplayOptions object

engineeringFeatures A Boolean specifying whether to display engineering features. mesh A Boolean specifying whether the mesh should be displayed. renderStyle A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are WIREFRAME, HIDDEN, and SHADED. 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.

14.13

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

14.13.1

setValues(...)

This method modifies the SymbolDisplayOptions object.
Arguments Required arguments

None.

14–27

ViewportAnnotationOptions object

Optional arguments

otherSymbolSize An Int specifying the size of the scalar attribute symbols . Possible values are 1 scalarSymbolSize 30. The initial value is 6. arrowSymbolSize An Int specifying the size of the vector and tensor attribute symbols . Possible values are 1 vectorSymbolSize 30. The initial 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 initial 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 initial 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.
Return value

None
Exceptions

None.

14.13.2

Members

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

14.14

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.

14–28

ViewportAnnotationOptions object

Access

session.defaultViewportAnnotationOptions session.viewports[name].viewportAnnotationOptions

14.14.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 initial 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 initial value is (6, 12). triadColor A String specifying the color of the view orientation triad. Possible values are any valid color. The initial value is “White.” triadLabels A SymbolicConstant specifying how the view orientation triad is labeled. Possible values are

• •

NUMBERS: label axes 1, 2, 3. LETTERS: label axes X, Y, Z.

The initial value is NUMBERS. triadFont A String specifying the font of the view orientation triad labels. Possible values are any valid font. The initial value is “-*-helvetica-bold-r-normal--12-*”. legend A Boolean specifying whether the legend is shown. The initial value is ON. legendMinMax A Boolean specifying whether the minimum and maximum values for X–Y and contour plots are shown. The initial value is OFF. legendBox A Boolean specifying whether the box around the legend is shown. The initial value is ON.

14–29

ViewportAnnotationOptions object

legendDecimalPlaces An Int specifying the number of decimal places to display in the legend. Possible values are 0 legendDecimalPlaces 9. The initial 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 initial value is (2, 98). legendFont A String specifying the font of the legend labels. Possible values are any valid font. The initial value is “-*-courier-medium-r-*-*-*-80-*-*-*-*-iso8859-1”. legendTextColor A String specifying the color of the legend. Possible values are any valid color. The initial value is “White.” legendBackgroundStyle A SymbolicConstant specifying the legend background style. Possible values are MATCH, TRANSPARENT, and OTHER. The initial 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 initial value is ON. titleBox A Boolean specifying whether the box around the title block is shown. The initial 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 initial value is (13, 20). titleFont A String specifying the font of the title. Possible values are any valid font. The initial value is “-*-courier-medium-r-*-*-*-80-*-*-*-*-iso8859-1”. titleTextColor A String specifying the color of the title. Possible values are any valid color. The initial value is “White.” titleBackgroundStyle A SymbolicConstant specifying the title block background style. Possible values are MATCH, TRANSPARENT, and OTHER. The initial value is TRANSPARENT. The default color when OTHER is specified is the background color (black). titleBackgroundColor A String specifying the color of the title block background. Possible values are any valid color. The initial value matches the viewport background.

14–30

ViewportAnnotationOptions object

state A Boolean specifying whether the state block is shown. The initial value is ON. stateBox A Boolean specifying whether the box around the state block is shown. The initial 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 initial value is (13, 12). stateFont A String specifying the font of the state label. Possible values are any valid font. The initial 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 initial value is “White.” stateBackgroundStyle A SymbolicConstant specifying the state block background style. Possible values are MATCH, TRANSPARENT, and OTHER. The initial 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.
Return value

None
Exceptions

RangeError.

14.14.2

Members

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

14–31

Assembly object

15.

EDIT MESH COMMANDS
Edit mesh commands are used to edit an orphan mesh part or part instance or an ABAQUS native mesh.

15.1

Assembly object

The following commands operate on Assembly objects. For more information about the Assembly object, see “Assembly object,” Section 4.1.
Access

import meshEdit

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

15.1.2

combineElement(...)

This method combines two triangular elements of a part instance.

15–1

Assembly object

Arguments Required argument

elements A sequence of triangular MeshElement objects specifying the elements to combine.
Optional arguments

None.
Return value

None
Exceptions

None.

15.1.3

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 new first-coordinate value. If unspecified and offset1 is also unspecified, the existing value will be left unchanged. coordinate2 A Float specifying the new second-coordinate value. If unspecified and offset2 is also unspecified, the existing value will be left unchanged. coordinate3 A Float specifying the new third-coordinate value. If unspecified and offset3 is also unspecified, the existing value will be left unchanged. offset1 A Float specifying an offset to apply to the first-coordinate value of the specified nodes. offset2 A Float specifying an offset to apply to the second-coordinate value of the specified nodes. offset3 A Float specifying an offset to apply to the third-coordinate value of the specified nodes.

15–2

Assembly object

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

15.1.4

splitElement(...)

This method splits a quadrilateral element of a part instance into two triangular elements.
Arguments Required argument

elements A sequence of quadrilateral MeshElement objects specifying the element to split.
Optional arguments

None.
Return value

None
Exceptions

None.

15.1.5

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.

15–3

Part object

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.

15.1.6

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.
Return value

None
Exceptions

None.

15.2

Part object

The following commands operate on Part objects. For more information about the Part object, see “Part object,” Section 32.1.
Access

import meshEdit

15–4

Part object

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

15.2.2

cleanMesh(...)

This method is used to perform automated mesh cleanup operations on an orphan mesh part.
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

15–5

Part object

Exceptions

None.

15.2.3

collapseMeshEdge(...)

This method collapeses 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.

15.2.4

combineElement(...)

This method combines two triangular elements of an orphan mesh part or an ABAQUS native mesh.
Arguments Required argument

elements A sequence of triangular MeshElement objects specifying the elements to combine.
Optional arguments

None.
Return value

None

15–6

Part object

Exceptions

None.

15.2.5

deleteElement(...)

This method deletes the given elements from an orphan mesh part.
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.

15.2.6

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

15–7

Part object

Exceptions

None.

15.2.7

editNode(...)

This method changes the coordinates of the given nodes on an orphan mesh part or on an ABAQUS native mesh.
Arguments Required argument

nodes A sequence of MeshNode objects or a Set object containing nodes.
Optional arguments

coordinate1 A Float specifying the new first-coordinate value. If unspecified and offset1 is also unspecified, the existing value will be left unchanged. coordinate2 A Float specifying the new second-coordinate value. If unspecified and offset2 is also unspecified, the existing value will be left unchanged. coordinate3 A Float specifying the new third-coordinate value. If unspecified and offset3 is also unspecified, the existing value will be left unchanged. offset1 A Float specifying an offset to apply to the first-coordinate value of the specified nodes. offset2 A Float specifying an offset to apply to the second-coordinate value of the specified nodes. offset3 A Float specifying an offset to apply to the third-coordinate value 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 geoemtry. 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

15–8

Part object

Exceptions

A coordinate and an offset may not both be specified for the same coordinate component.

15.2.8

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:
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 linear triangular elements.
Return value

None
Exceptions

None.

15.2.9

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.

15–9

Part object

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

15.2.10

mergeNodes(...)

Merge the nodes of an orphan mesh part.
Arguments Required argument

nodes A sequence of Node objects specifying the nodes to merge.

15–10

Part object

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.
Return value

None
Exceptions

None.

15.2.11

mergeNodes(...)

Merge two nodes of an orphan mesh part.
Arguments Required argument

node1 A Node object specifying the first node to merge. node2 A Node 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.
Return value

None
Exceptions

None.

15.2.12

orientElements(...)

This method orients the stack direction of elements in a continuum shell or gasket mesh.

15–11

Part object

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.

15.2.13

removeElementSize()

This method removes the global element size from an orphan mesh part.
Arguments

None.
Return value

None
Exceptions

None.

15.2.14

setElementSize(...)

This method sets the global element size for an orphan mesh part.
Arguments Required argument

size A Float specifying the desired element size.

15–12

Part object

Optional arguments

None.
Return value

None
Exceptions

None.

15.2.15

splitElement(...)

This method splits a quadrilateral element of an orphan mesh part or an ABAQUS native mesh into two triangular elements.
Arguments Required argument

elements A sequence of quadrilateral MeshElement objects specifying the element to split.
Optional arguments

None.
Return value

None
Exceptions

None.

15.2.16

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.

15–13

Part object

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.

15.2.17

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.

15–14

EngineeringFeature object

16.

Engineering Feature commands
A specific type of engineering feature object is designed for each type of engineering feature.

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

16.1.1

createSeamCrack(...)

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.

16.1.2

deleteSeamCrack(...)

This method deletes a seam crack.

16–1

ContourIntegral object

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.

16.1.3

Members

The EngineeringFeature object can have the following members: inertias A repository of Inertia objects. cracks A repository of Crack objects. springDashpots A repository of SpringDashpot objects.

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

16–2

ContourIntegral object

16.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 Region object or a tuple of region objects specifying the crack-front region to which the contour integral is applied. crackTip A Region object or a tuple of region objects specifying the crack-tip region to which the contour integral is applied. 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 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 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.” crackNormal A tuple of tuples of Floats consisting of two points specifying a vector that describes the crack normal direction. Each point is defined by a tuple of two or three coordinates indicating its

16–3

ContourIntegral object

position. This argument is required only when extensionDirectionMethod=CRACK_NORMAL. The default value is an empty tuple. qVectors A tuple of tuples of tuples of Floats consisting of vectors specifying 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 tuple. 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.

16.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
Exceptions

None.

16–4

HeatCapacitance object

16.2.3

Members

The ContourIntegral object has members with the same names and descriptions as the arguments to the ContourIntegral method.
16.2.4 Corresponding analysis keywords

*CONTOUR INTEGRAL

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

16.3.1
name

Members

The Crack object has the following member: A String specifying the repository key.

16.4

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]

16–5

HeatCapacitance object

16.4.1

HeatCapacitance(...)

This method creates a HeatCapacitance object. The HeatCapacitance object is derived from the Inertia 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. The items in the table data are 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:

• • • • •

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.

16.4.2

setValues(...)

This method modifies the HeatCapacitance object.

16–6

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

16.4.3

Members

The HeatCapacitance object has members with the same names and descriptions as the arguments to the HeatCapacitance method.
16.4.4 Corresponding analysis keywords

*HEATCAP

16.5

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]

16.5.1
name

Members

The Inertia object has the following member: A String specifying the repository key.

16–7

NonstructuralMass object

16.6

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]

16.6.1

NonstructuralMass(...)

This method creates a NonstructuralMass object.
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 distribution argument applies only when units=TOTAL_MASS. The default value is MASS_PROPORTIONAL.
Return value

A NonstructuralMass object.

16–8

PointMassInertia object

Exceptions

None.

16.6.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.
Return value

None
Exceptions

None.

16.6.3

Members

The NonstructuralMass object has members with the same names and descriptions as the arguments to the NonstructuralMass method.
16.6.4 Corresponding analysis keywords

*NONSTRUCTURAL MASS

16.7

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

16–9

PointMassInertia object

mdb.models[name].rootAssembly.engineeringFeatures.inertias[name]

16.7.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, i22 A Float specifying the rotary inertia about the local 2-axis, i33 A Float specifying the rotary inertia about the local 3-axis, i12 A Float specifying the product of inertia, i13 A Float specifying the product of inertia, i23 A Float specifying the product of inertia, . The default value is 0.0. localCsys A DatumCsys object specifying the local coordinate system for the rotary inertia. The default value is None, indicating that the rotary inertia data are defined in the global coordinate system. 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. . The default value is 0.0. . The default value is 0.0. . The default value is 0.0. . The default value is 0.0. . The default value is 0.0.

16–10

SpringDashpot object

Return value

A PointMassInertia object.
Exceptions

None.

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

16.7.3

Members

The PointMassInertia object has members with the same names and descriptions as the arguments to the PointMassInertia method.
16.7.4 Corresponding analysis keywords

*MASS, *ROTARY INERTIA

16.8

SpringDashpot object

The SpringDashpot object is the abstract base type for the SpringDashpotToGround and TwoPointSpringDashpot objects.

16–11

SpringDashpotToGround object

Access

import part mdb.models[name].parts[name].engineeringFeatures.springDashpots[name] import assembly mdb.models[name].rootAssembly.engineeringFeatures.springDashpots[name]

16.8.1
name

Members

The SpringDashpot object has the following member: A String specifying the repository key.

16.9

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]

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

16–12

SpringDashpotToGround object

Optional arguments

orientation A DatumCsys object specifying the local directions for the spring and/or dashpot. The default value is None, indicating that the spring and/or dashpot data are defined in the global coordinate system. springBehavior A Boolean specifying whether to apply spring behavior to the selected points. The default value is OFF; however, 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; however, 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.

16.9.2

setValues(...)

This method modifies the SpringDashpotToGround object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as SpringDashpotToGround method, except for the name argument.
Return value

the

arguments

to

the

None

16–13

TwoPointSpringDashpot object

Exceptions

None.

16.9.3

Members

The SpringDashpotToGround object has members with the same names and descriptions as the arguments to the SpringDashpotToGround method.
16.9.4 Corresponding analysis keywords

*ELEMENT, TYPE=SPRING1; *ELEMENT, TYPE=DASHPOT1; *SPRING; *DASHPOT

16.10

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]

16.10.1

TwoPointSpringDashpot(...)

This method creates a TwoPointSpringDashpot object.
Path

mdb.models[name].parts[name].engineeringFeatures.TwoPointSpringDashpot mdb.models[name].rootAssembly.engineeringFeatures.TwoPointSpringDashpot
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.

16–14

TwoPointSpringDashpot object

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 or 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 A DatumCsys object specifying the local directions for the spring and/or dashpot. The default value is None, indicating that the spring and/or dashpot data are defined in the global coordinate system. 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; however, 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; however, 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.
Return value

A TwoPointSpringDashpot object.
Exceptions

None.

16.10.2

setValues(...)

This method modifies the TwoPointSpringDashpot object.

16–15

TwoPointSpringDashpot object

Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as TwoPointSpringDashpot method, except for the name argument.
Return value

the

arguments

to

the

None
Exceptions

None.

16.10.3

Members

The TwoPointSpringDashpot object has members with the same names and descriptions as the arguments to the TwoPointSpringDashpot method.
16.10.4 Corresponding analysis keywords

TYPE=SPRINGA; TYPE=SPRING2; *ELEMENT, *ELEMENT, TYPE=DASHPOTA; *ELEMENT, TYPE=DASHPOT2; *SPRING; *DASHPOT

*ELEMENT,

16–16

Feature object

17.

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 32, “Part commands.” The commands that create Feature objects in only therootAssembly object are described in Chapter 4, “Assembly commands.” The commands that create Feature objects on both the Part and the rootAssembly objects are described here.

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

17.1.1

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.

17–1

Feature object

Return value

A Feature object.
Exceptions

AbaqusError.

17.1.2

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

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.3

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

17–2

Feature object

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

AbaqusError.

17.1.4

DatumAxisByPrincipalAxis(...)

This method creates a Feature object and a DatumAxis object along one of the three principal axes.
Path

mdb.models[name].rootAssembly.DatumAxisByPrincipalAxis 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

AbaqusError.

17.1.5

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.

17–3

Feature object

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

AbaqusError.

17.1.6

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.

17–4

Feature object

angle A Float specifying the angle in degrees to rotate the line.
Optional arguments

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.7

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

AbaqusError.

17–5

Feature object

17.1.8

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

AbaqusError.

17.1.9

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.

17–6

Feature object

Exceptions

AbaqusError.

17.1.10

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. point2 A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point.
Optional arguments

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.11

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.

17–7

Feature object

Optional argument

name A String specifying the repository key.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.12

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.
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, Interesting Point, 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 repository key.
Return value

A Feature object.

17–8

Feature object

Exceptions

AbaqusError.

17.1.13

DatumCsysByThreePoints(...)

This method creates a Feature object and a DatumCsys object from three points.
Path

mdb.models[name].rootAssembly.DatumCsysByThreePoints mdb.models[name].parts[name].DatumCsysByThreePoints
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 exlusive. 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 exlusive. 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 exlusive. 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 exlusive. One of them must be specified.
Optional argument

name A String specifying the repository key.

17–9

Feature object

Return value

A Feature object.
Exceptions

AbaqusError.

17.1.14

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.
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 repository key.
Return value

A Feature object.
Exceptions

AbaqusError.

17–10

Feature object

17.1.15

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. offset A Float specifying the offset from the plane.
Optional arguments

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.16

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.

17–11

Feature object

offset A Float specifying the offset from the plane.
Optional arguments

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.17

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

AbaqusError.

17.1.18

DatumPlaneByRotation(...)

This method creates a Feature object and a DatumPlane object by rotating a plane about the specified axis through the specified angle.

17–12

Feature object

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. angle A Float specifying the angle in degrees to rotate the plane.
Optional arguments

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.19

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.

17–13

Feature object

Return value

A Feature object.
Exceptions

AbaqusError.

17.1.20

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

AbaqusError.

17.1.21

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

17–14

Feature object

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

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.22

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

AbaqusError.

17–15

Feature object

17.1.23

DatumPointByCoordinate(...)

This method creates a Feature object and a DatumPoint object at the point defined by the specified coordinates.
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.

17.1.24

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.

17–16

Feature object

Exceptions

None.

17.1.25

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.

17.1.26

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. edge1 A straight Edge or a Datum object representing a datum axis.

17–17

Feature object

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

AbaqusError.

17.1.27

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

AbaqusError and RangeError.

17–18

Feature object

17.1.28

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 A straight Edge, an ElementEdge or a Datum object representing a datum axis.
Optional arguments

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.29

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

point A Vertex, an InterestingPoint, a MeshNode, or a Datum object representing a datum point. face A planar Face object. Note: Other types of planes, such as Datum planes, are not supported.

17–19

Feature object

Optional arguments

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.30

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

17–20

Feature object

Exceptions

If the sketchUpEdge is parallel to the sketchPlane: Up direction is parallel to plane normal

17.1.31

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

AbaqusError.

17.1.32

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.

17–21

Feature object

extendFace A planar, cylindrical, conical, or spherical Face object.
Optional arguments

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.33

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

17–22

Feature object

Exceptions

AbaqusError.

17.1.34

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 corner points must not coincide.
Optional arguments

len(cornerPoints)

5. The

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.35

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.

17–23

Feature object

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

AbaqusError.

17.1.36

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

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.37

PartitionCellByPlanePointNormal(...)

This method partitions one or more cells using a plane defined by a point and a normal direction.

17–24

Feature object

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

AbaqusError.

17.1.38

PartitionCellByPlaneThreePoints(...)

This method partitions one or more cells using a plane defined by three points.
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.

17–25

Feature object

Optional arguments

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.39

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

AbaqusError.

17.1.40

PartitionEdgeByDatumPlane(...)

This method partitions an edge where it intersects with a datum plane.

17–26

Feature object

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

AbaqusError.

17.1.41

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.

17–27

Feature object

Exceptions

AbaqusError.

17.1.42

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.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.43

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.

17–28

Feature object

Return value

A Feature object.
Exceptions

None.

17.1.44

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

AbaqusError.

17–29

Feature object

17.1.45

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

AbaqusError.

17.1.46

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

17–30

Feature object

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.

17.1.47

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.

17–31

Feature object

17.1.48

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

None.
Return value

A Feature object.
Exceptions

None.

17.1.49

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 sequenc eof 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.

17–32

Feature object

Optional arguments

None.
Return value

A Feature object.
Exceptions

AbaqusError.

17.1.50

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 Sketch 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

AbaqusError.

17–33

Feature object

17.1.51

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

faces A sequenc eof 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 Sketch 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

AbaqusError.

17.1.52

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.

17–34

Feature object

Path

mdb.models[name].parts[name].PartitionFaceBySketchRefPoint mdb.models[name].rootAssembly.PartitionFaceBySketchRefPoint
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 Sketch 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

AbaqusError.

17.1.53

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

17–35

Feature object

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 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 Sketch object specifying the partition.
Optional arguments

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

AbaqusError.

17.1.54

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

None.

17–36

Feature object

instanceName Used internally by the input file writer.
Return value

A Feature Object.
Exceptions

None.

17.1.55

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.

17.1.56

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.

17–37

Feature object

17.1.57

setValues(...)

This method modifies the Feature object.
Arguments Required arguments

None.
Optional arguments

None. 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 Sketch 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

AbaqusError.

17–38

FeatureOptions object

17.1.58

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

None.
Return value

None
Exceptions

None.

17.1.59
name

Members

The Feature object has the following member: A String specifying the repository key.

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

17.2.1

setValues(...)

This method modifies the FeatureOptions object for the specified model.

17–39

FeatureOptions object

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

17.2.2

Members

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

17–40

ButterworthFilter object

18.

Filter commands
Filter commands are used to create real-time filters of output request data.

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

18.1.1
name

Members

The Filter object has the following members: A String specifying the repository key. cutoffFrequency A Float specifying the attenuation point of the filter.

18.2

ButterworthFilter object

The ButterworthFilter object defines a Butterworth type filter.
Access

import filter mdb.models[name].filters[name]

18.2.1

ButterworthFilter(...)

This method creates a ButterworthFilter object.
Path

mdb.models[name].ButterworthFilter

18–1

ButterworthFilter object

Required arguments

name A String specifying the repository key. cutoffFrequency A Float specifying the attenuation point of the filter.
Optional arguments

None.
Return value

A ButterworthFilter object.
Exceptions

InvalidNameError and RangeError.

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

18.2.3

Members

The ButterworthFilter object has members with the same names and descriptions as the arguments to the ButterworthFilter method.
18.2.4 Corresponding analysis keywords

*FILTER

18–2

Chebyshev1Filter object

18.3

Chebyshev1Filter object

The Chebyshev1Filter object defines a Chebyshev type 1 filter.
Access

import filter mdb.models[name].filters[name]

18.3.1

Chebyshev1Filter(...)

This method creates a Chebyshev1Filter object.
Path

mdb.models[name].Chebyshev1Filter
Required arguments

name A String specifying the repository key. cutoffFrequency A Float specifying the attenuation point of the filter.
Optional argument

rippleFactor A Float specifying the amount of allowable ripple in the filter. The default value is 20.0.
Return value

A Chebyshev1Filter object.
Exceptions

InvalidNameError and RangeError.

18.3.2

setValues(...)

This method modifies the Chebyshev1Filter object.
Arguments Required arguments

None.

18–3

Chebyshev2Filter object

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
Exceptions

RangeError.

18.3.3

Members

The Chebyshev1Filter object has members with the same names and descriptions as the arguments to the Chebyshev1Filter method.
18.3.4 Corresponding analysis keywords

*FILTER

18.4

Chebyshev2Filter object

The Chebyshev2Filter object defines a Chebyshev type 2 filter.
Access

import filter mdb.models[name].filters[name]

18.4.1

Chebyshev2Filter(...)

This method creates a Chebyshev2Filter object.
Path

mdb.models[name].Chebyshev2Filter
Required arguments

name A String specifying the repository key. cutoffFrequency A Float specifying the attenuation point of the filter.

18–4

Chebyshev2Filter object

Optional argument

rippleFactor A Float specifying the amount of allowable ripple in the filter. The default value is 0.05.
Return value

A Chebyshev2Filter object.
Exceptions

InvalidNameError and RangeError.

18.4.2

setValues(...)

This method modifies the Chebyshev2Filter object.
Arguments Required arguments

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

18.4.3

Members

The Chebyshev2Filter object has members with the same names and descriptions as the arguments to the Chebyshev2Filter method.
18.4.4 Corresponding analysis keywords

*FILTER

18–5

Field object

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 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 base object for the objects in the field repository. The methods and members of the Field object are common to all objects derived from Field. An instance of any Field object can be obtained through the field repository of the Model object. An instance of any FieldState object can be obtained through the field repository of the Step object.
Access

import load mdb.models[name].fields[name]

19.1.1

move(...)

This method moves a specific FieldState object from one step to a different step.
Arguments Required arguments

fromStepName A String specifying the name of the step from which the FieldState object is moved. toStepName A String specifying the name of the step to which the FieldState object is moved.
Optional arguments

None.
Return value

None
Exceptions

TextError.

19–1

Field object

19.1.2

resume()

This method resumes the field that was previously suppressed.
Arguments

None.
Return value

None
Exceptions

None.

19.1.3

suppress()

This method suppresses the field.
Arguments

None.
Return value

None
Exceptions

None.

19.1.4
name

Members

The Field object can have the following members: A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.

19–2

Concentration object

19.2

Concentration object

The Concentration object stores the initial normalized concentration.
Access

import load mdb.models[name].fields[name]

19.2.1

Concentration(...)

This method creates a Concentration object.
Path

mdb.models[name].Concentration
Required arguments

name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member. magnitude A Double specifying the value of the initial normalized concentration.
Optional arguments

None.
Return value

A PorePressure object.
Exceptions

None.

19.2.2

setValues(...)

This method modifies the Concentration object.

19–3

FieldState object

Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the Concentration method, except for the name argument.
Return value

None
Exceptions

None.

19.2.3

Members

The Concentration object has members with the same names and descriptions as the arguments to the Concentration method.
19.2.4 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=CONCENTRATION

19.3

FieldState object

The FieldState object is the base object for the objects in the fieldState repository of the Step object. The members of the FieldState object are common to all objects derived from FieldState. The FieldState object has no constructor or methods.
Access

import load mdb.models[name].steps[name].fieldStates[name]

19.3.1
status

Members

The FieldState object has the following member: A SymbolicConstant specifying the propagation state of the FieldState object. Possible values are:

• •

NOT_YET_ACTIVE CREATED

19–4

GeneralField object

• • • • • • • • • • •

PROPAGATED MODIFIED DEACTIVATED DEACTIVATED_TO_INITIAL NO_LONGER_ACTIVE RESET_TO_INITIAL TO_BE_COMPUTED PROPAGATED_FROM_COMPUTED BUILT_INTO_BASE_STATE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE

This member exists in all FieldState objects, but different fields use different subsets of the entire list of possible values depending on propagation rules.

19.4

GeneralField object

The GeneralField object stores a general predefined field.
Access

import load mdb.models[name].fields[name]

19.4.1

GeneralField(...)

This method creates a GeneralField object.
Path

mdb.models[name].GeneralField
Required arguments

name A String specifying the repository key. createStepName A String specifying the name of the step in which the field is created. This must be the first analysis step.

19–5

GeneralField object

region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.
Optional arguments

distribution A SymbolicConstant specifying how the field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, and FROM_FILE_AND_USER_DEFINED. The default value is UNIFORM. crossSectionDistribution A SymbolicConstant specifying how the field is distributed over the cross section of the region. Possible values are CONSTANT_OVER_SECTION, GRADIENTS_THROUGH_SHELL_SECTION, GRADIENTS_THROUGH_BEAM_SECTION, POINTS_THROUGH_SHELL_SECTION, and POINTS_THROUGH_BEAM_SECTION. The default is CONSTANT_OVER_SECTION. specifyVariableID A Boolean indicating whether the field variable is specified using an integer identifier. Only applicable if distribution is USER_DEFINED or FROM_FILE_AND_USER_DEFINED. variableID An Int specifying the identifier of the field. Only applicable if distribution is UNIFORM, USER_DEFINED, and FROM_FILE_AND_USER_DEFINED. numberOfVariables A positive Int specifying the number of field variables to be updated simultaneously from within user subroutine UFIELD. Only applicable if distribution is USER_DEFINED or FROM_FILE_AND_USER_DEFINED. amplitude A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the Field has no amplitude reference. The default value is UNSET. Note: amplitude should be given only if it is valid for the specified step. fileName A String specifying the name of the file from which the GeneralField values are to be read when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. beginStep An Int specifying the first step from which GeneralField values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED.

19–6

GeneralField object

beginIncrement An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. endStep An Int specifying the last step from which GeneralField values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. endIncrement An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. midSide A Boolean specifying that GeneralFields in second-order elements are to be interpolated from corner node temperatures. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. magnitudes A Sequence of Doubles that define the GeneralField values when the distribution=UNIFORM. Depending on the cross section distribution, the magnitudes sequence holds different magnitude parameters: CONSTANT_OVER_SECTION: The constant General Field magnitude. GRADIENTS_THROUGH_SHELL_SECTION: Mean Value; Gradient in the thickness direction. GRADIENTS_THROUGH_BEAM_SECTION: Mean value; Gradient in the N1 direction; Gradient in the N2 direction. POINTS_THROUGH_SHELL_SECTION, POINTS_THROUGH_BEAM_SECTION: One General Field magnitude for each point.

Return value

A GeneralField object.

Exceptions

None.

19.4.2

move(...)

This method moves the GeneralFieldState object from one step to a different step.

19–7

GeneralField object

Arguments Required arguments

fromStepName A String specifying the name of the step from which the FieldState is moved. toStepName A String specifying the name of the step to which the FieldState is moved.
Optional arguments

None.
Return value

None
Exceptions

TextError.

19.4.3

setValues(...)

This method modifies the data for an existing GeneralField 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 GeneralField method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

19.4.4

setValuesInStep(...)

This method modifies the propagating data for an existing GeneralField object in the specified step.

19–8

GeneralField object

Arguments Required argument

stepName A String specifying the name of the step in which the field is modified.
Optional arguments

The optional arguments to setValuesInStep are the same asoptional arguments to the GeneralField method, except for the distribution and crossSectionDistribution arguments.

Return value

None

Exceptions

None.

19.4.5

Members

The GeneralField object can have the following members: distribution A SymbolicConstant specifying how the field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, and FROM_FILE_AND_USER_DEFINED. The default value is UNIFORM. name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.
19.4.6 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=FIELD *FIELD

19–9

GeneralFieldState object

19.5

GeneralFieldState object

The GeneralFieldState object stores the propagating data of a GeneralField in a step. One instance of this object is created internally by the GeneralField object for each step. The instance is also deleted internally by the GeneralField object. The GeneralFieldState object has no constructor or methods.
Access

import load mdb.models[name].steps[name].fieldStates[name]

19.5.1

Members

The GeneralFieldState object has the following members: magnitudesState A Sequence of SymbolicConstants specifying the propagation state of each item of the magnitudes member. Possible values of the SymbolicConstants are UNSET, SET, and UNCHANGED. fileName A String specifying the name of the file from which the GeneralField values are to be read when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. fileNameState A SymbolicConstant specifying the propagation state of the fileName member. Possible values are UNSET, SET, and UNCHANGED. beginStep An Int specifying the first step from which the field values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. beginStepState A SymbolicConstant specifying the propagation state of the beginStep member. Possible values are UNSET, SET, and UNCHANGED. beginIncrement An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START and STEP_END. beginIncrementState A SymbolicConstant specifying the propagation state of the beginIncrement member. Possible values are UNSET, SET, and UNCHANGED.

19–10

GeneralFieldState object

endStep An Int specifying the last step from which GeneralField values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. endStepState A SymbolicConstant specifying the propagation state of the endStep member. Possible values are UNSET, SET, and UNCHANGED. endIncrement An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. endIncrementState A SymbolicConstant specifying the propagation state of the endIncrement member. Possible values are UNSET, SET, and UNCHANGED. midside A Boolean specifying that GeneralFields in second-order elements are to be interpolated from corner node temperatures. midsideState A SymbolicConstant specifying the propagation state of the midside member. Possible values are UNSET, SET, and UNCHANGED. amplitude A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. amplitudeState A SymbolicConstant specifying the propagation state of the amplitudeState member. Possible values are UNSET, SET, and UNCHANGED. magnitudes A Sequence of Doubles that define the GeneralField values when the distribution=UNIFORM. Depending on the cross section distribution, the magnitudes sequence holds different magnitude parameters: CONSTANT_OVER_SECTION: The constant General Field magnitude. GRADIENTS_THROUGH_SHELL_SECTION: Mean Value; Gradient in the thickness direction. GRADIENTS_THROUGH_BEAM_SECTION: Mean value; Gradient in the N1 direction; Gradient in the N2 direction. POINTS_THROUGH_SHELL_SECTION, POINTS_THROUGH_BEAM_SECTION: One General Field magnitude for each point. status A SymbolicConstant specifying the propagation state of the FieldState object. Possible values are:

• • •

NOT_YET_ACTIVE CREATED PROPAGATED

19–11

Hardening object

• • • • • • • • • •

MODIFIED DEACTIVATED DEACTIVATED_TO_INITIAL NO_LONGER_ACTIVE RESET_TO_INITIAL TO_BE_COMPUTED PROPAGATED_FROM_COMPUTED BUILT_INTO_BASE_STATE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE

This member exists in all FieldState objects, but different fields use different subsets of the entire list of possible values depending on propagation rules.

19.6

Hardening object

The Hardening object stores the data for initial equivalent plastic strains and, if relevant, the initial backstress tensor.
Access

import load mdb.models[name].fields[name]

19.6.1

Hardening(...)

This method creates a Hardening object.
Path

mdb.models[name].Hardening
Required arguments

name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.

19–12

Hardening object

Optional arguments

distribution A SymbolicConstant specifying how the field varies spatially. Possible values are UNIFORM, and USER_DEFINED. The default value is UNIFORM. eqpl A Double specifying the initial equivalent plastic strain when distribution=UNIFORM or REBAR. sectionType A SymbolicConstant specifying the section type when distribution=UNIFORM. Possible values are SOLID, REGULAR_SHELL, MEMBRANE, REGULAR_BEAM, GENERALIZED_SHELL, GENERALIZED_BEAM, TRUSS, and SOLID. stressTensor A Sequence of sequences of Doubles specifying the initial backstress tensor for kinematic hardening models when distribution=UNIFORM.
Return value

A Hardening object.
Exceptions

None.

19.6.2

setValues(...)

This method modifies the Hardening object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the Hardening method, except for the name argument.
Return value

None
Exceptions

None.

19–13

InitialState object

19.6.3

Members

The Hardening object has members with the same names and descriptions as the arguments to the Hardening method.
19.6.4 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=HARDENING

19.7

InitialState object

The InitialState object stores the data for an initial state field.
Access

import load mdb.models[name].fields[name]

19.7.1

InitialState(...)

This method creates an InitialState field object.
Path

mdb.models[name].InitialState
Required arguments

name A String specifying the repository key. instances A sequence of PartInstance objects specifying the instances to which the field is applied. fileName A String specifying the name of the job that generated the initial state data.
Optional arguments

endStep An Int specifying the step from which the initial state values are to be read or the SymbolicConstant LAST_STEP. The default value is LAST_STEP. endIncrement An Int specifying the increment of the step set in endStep or the SymbolicConstant STEP_END. The default value is STEP_END.

19–14

InitialState object

updateReferenceConfiguration A Boolean specifying whether to update the reference configuration based on the import data. The default value is OFF.
Return value

An InitialState object.
Exceptions

None.

19.7.2

setValues(...)

This method modifies the InitialState object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the InitialState method, except for the name argument.
Return value

None
Exceptions

None.

19.7.3

Members

The InitialState object has members with the same names and descriptions as the arguments to the InitialState method. In addition, the InitialState object can have the following member: region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.
19.7.4 Corresponding analysis keywords

*INSTANCE

19–15

MassFlowRate object

19.8

MassFlowRate object

The MassFlowRate object stores the data for mass flow rate.
Access

import load mdb.models[name].fields[name]

19.8.1

MassFlowRate(...)

This method creates a MassFlowRate object.
Path

mdb.models[name].MassFlowRate
Required arguments

name A String specifying the repository key. createStepName A String specifying the name of the step in which the field is created. This must be the first analysis step. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.
Optional arguments

v1 A Double specifying the mass flow rate per unit area in the X-direction. v2 A Double specifying the mass flow rate per unit area in the Y-direction. v3 A Double specifying the mass flow rate per unit area in the Z-direction. amplitude A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the Field has no amplitude reference. The default value is UNSET. Note: amplitude should be given only if it is valid for the specified step.

19–16

MassFlowRate object

Return value

A MassFlowRate object.
Exceptions

AbaqusError At least one of the directions must have a nonzero flow rate.

19.8.2

move(...)

This method moves the MassFlowState object from one step to a different step.
Arguments Required arguments

fromStepName A String specifying the name of the step from which the FieldState is moved. toStepName A String specifying the name of the step to which the FieldState is moved.
Optional arguments

None.
Return value

None
Exceptions

TextError.

19.8.3

setValues(...)

This method modifies the data for an existing MassFlowRate 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 MassFlowRate method, except for the name and createStepName arguments.

19–17

MassFlowRate object

Return value

None
Exceptions

AbaqusError At least one of the directions must have a nonzero flow rate.

19.8.4

setValuesInStep(...)

This method modifies the propagating data for an existing MassFlowRate object in the specified step. The arguments to setValuesInStep are the same as the arguments to the MassFlowRate method, except for the name, createStepName, and region. All arguments are optional. In addition the following argument is required.
Arguments Required argument

stepName A String specifying the name of the step in which the field is modified.
Optional arguments

None.
Return value

None
Exceptions

None.

19.8.5
name

Members

The MassFlowRate object can have the following members: A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.

19–18

MassFlowRateState object

19.8.6

Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=MASS FLOW RATE *MASS FLOW RATE

19.9

MassFlowRateState object

The MassFlowRateState object stores the propagating data of a MassFlowRate in a step. One instance of this object is created internally by the MassFlowRate object for each step. The instance is also deleted internally by the MassFlowRate object. The MassFlowRateState object has no constructor or methods.
Access

import load mdb.models[name].steps[name].fieldStates[name]

19.9.1

Members

The MassFlowRateState object has the following members: amplitude A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the Field has no amplitude reference. amplitudeState A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED. v1 A Double specifying the mass flow rate per unit area in the X-direction. v1State A SymbolicConstant specifying the propagation state of the v1 member. Possible values are UNSET, SET, and UNCHANGED. v2 A Double specifying the mass flow rate per unit area in the Y-direction. v2State A SymbolicConstant specifying the propagation state of the v2 member. Possible values are UNSET, SET, and UNCHANGED. v3 A Double specifying the mass flow rate per unit area in the Z-direction.

19–19

PorePressure object

v3State A SymbolicConstant specifying the propagation state of the v3 member. Possible values are UNSET, SET, and UNCHANGED. status A SymbolicConstant specifying the propagation state of the FieldState object. Possible values are:

• • • • • • • • • • • • •

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED DEACTIVATED_TO_INITIAL NO_LONGER_ACTIVE RESET_TO_INITIAL TO_BE_COMPUTED PROPAGATED_FROM_COMPUTED BUILT_INTO_BASE_STATE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE

This member exists in all FieldState objects, but different fields use different subsets of the entire list of possible values depending on propagation rules.

19.10

PorePressure object

The PorePressure object stores the data for initial pore fluid pressures.
Access

import load mdb.models[name].fields[name]

19.10.1

PorePressure(...)

This method creates a PorePressure object.
Path

mdb.models[name].PorePressure

19–20

PorePressure object

Required arguments

name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.
Optional arguments

distribution A SymbolicConstant specifying the field distribution. Possible values are UNIFORM, LINEAR, and USER_DEFINED. The default value is LINEAR. magnitude1 A Double specifying the first value of fluid pore pressure. verticalCoord1 A Double specifying the vertical coordinate cooresponding to the value of magnitude1. magnitude2 A Double specifying the second value of fluid pore pressure. verticalCoord2 A Double specifying the vertical coordinate cooresponding to the value of magnitude2.
Return value

A PorePressure object.
Exceptions

None.

19.10.2

setValues(...)

This method modifies the PorePressure object.
Arguments Required arguments

None.
Optional arguments

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

19–21

PressureStress object

Return value

None
Exceptions

None.

19.10.3

Members

The PorePressure object has members with the same names and descriptions as the arguments to the PorePressure method.
19.10.4 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=PORE PRESSURE

19.11

PressureStress object

The PressureStress object stores the data for presure stresses in a mass diffusion analysis.
Access

import load mdb.models[name].fields[name]

19.11.1

PressureStress(...)

This method creates a PressureStress object.
Path

mdb.models[name].PressureStress
Required arguments

name A String specifying the repository key. createStepName A String specifying the name of the step in which the field is created. This must be the first analysis step. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and

19–22

PressureStress object

distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.
Optional arguments

distribution A SymbolicConstant specifying how the field varies spatially. Possible values are UNIFORM, GEOSTATIC, USER_DEFINED, LINEAR, FROM_FILE, and FROM_FILE_AND_USER_DEFINED. The default value is UNIFORM. magnitude A Double that define the pressure stress values when the distribution=UNIFORM. fileName A String specifying the name of the file from which the temperature values are to be read when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. beginStep An Int specifying the first step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. beginIncrement An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. endStep An Int specifying the last step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. endIncrement An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. amplitude A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the Field has no amplitude reference. The default value is UNSET. Note: amplitude should be given only if it is valid for the specified step.
Return value

A PressureStress object.
Exceptions

None.

19–23

PressureStress object

19.11.2

move(...)

This method moves the PressureStressState object from one step to a different step.
Arguments Required arguments

fromStepName A String specifying the name of the step from which the FieldState is moved. toStepName A String specifying the name of the step to which the FieldState is moved.
Optional arguments

None.
Return value

None
Exceptions

TextError.

19.11.3

setValues(...)

This method modifies the data for an existing PressureStress 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 PressureStress method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

19–24

PressureStress object

19.11.4

setValuesInStep(...)

This method modifies the propagating data for an existing PressureStress object in the specified step.
Arguments Required argument

stepName A String specifying the name of the step in which the field is modified.
Optional arguments

The optional arguments to setValuesInStep are the same optional arguments in the PressureStress method except for distribution.
Return value

None
Exceptions

None.

19.11.5

Members

The PressureStress object can have the following members: distribution A SymbolicConstant specifying how the field varies spatially. Possible values are UNIFORM, GEOSTATIC, USER_DEFINED, LINEAR, FROM_FILE, and FROM_FILE_AND_USER_DEFINED. The default value is UNIFORM. name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.
19.11.6 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=PRESSURE STRESS *PRESSURE STRESS

19–25

PressureStressState object

19.12

PressureStressState object

The PressureStressState object stores the propagating data of a PressureStress in a step. One instance of this object is created internally by the PressureStress object for each step. The instance is also deleted internally by the PressureStress object. The PressureStressState object has no constructor or methods.
Access

import load mdb.models[name].steps[name].fieldStates[name]

19.12.1

Members

The PressureStressState object has the following members: amplitude A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the Field has no amplitude reference. The default value is UNSET. Note: amplitude should be given only if it is valid for the specified step. amplitudeState A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED. magnitude A Double that define the pressure stress values when the distribution=UNIFORM. magnitudeState A SymbolicConstant specifying the propagation state of the magnitude member. Possible values are UNSET, SET, and UNCHANGED. fileName A String specifying the name of the file from which the temperature values are to be read when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. fileNameState A SymbolicConstant specifying the propagation state of the fileName member. Possible values are UNSET, SET, and UNCHANGED. beginStep An Int specifying the first step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED.

19–26

PressureStressState object

beginStepState A SymbolicConstant specifying the propagation state of the beginStep member. Possible values are UNSET, SET, and UNCHANGED. beginIncrement An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. beginIncrementState A SymbolicConstant specifying the propagation state of the beginIncrement member. Possible values are UNSET, SET, and UNCHANGED. endStep An Int specifying the last step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. endStepState A SymbolicConstant specifying the propagation state of the endStep member. Possible values are UNSET, SET, and UNCHANGED. endIncrement An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED. endIncrementState A SymbolicConstant specifying the propagation state of the endIncrement member. Possible values are UNSET, SET, and UNCHANGED. status A SymbolicConstant specifying the propagation state of the FieldState object. Possible values are:

• • • • • • • • • • • •

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED DEACTIVATED_TO_INITIAL NO_LONGER_ACTIVE RESET_TO_INITIAL TO_BE_COMPUTED PROPAGATED_FROM_COMPUTED BUILT_INTO_BASE_STATE TYPE_NOT_APPLICABLE

19–27

RelativeDensity object



INSTANCE_NOT_APPLICABLE

This member exists in all FieldState objects, but different fields use different subsets of the entire list of possible values depending on propagation rules.

19.13

RelativeDensity object

The RelativeDensity object stores the data for initial relative density values for materials defined with the *POROUS METAL PLASTICITY option.
Access

import load mdb.models[name].fields[name]

19.13.1

RelativeDensity(...)

This method creates a RelativeDensity object.
Path

mdb.models[name].RelativeDensity
Required arguments

name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member. magnitude A Double specifying the initial relative density.
Optional arguments

None.
Return value

A RelativeDensity object.
Exceptions

None.

19–28

SDV object

19.13.2

setValues(...)

This method modifies the RelativeDensity object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the RelativeDensity method, except for the name argument.
Return value

None
Exceptions

None.

19.13.3

Members

The RelativeDensity object has members with the same names and descriptions as the arguments to the RelativeDensity method.
19.13.4 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=RELATIVE DENSITY

19.14

SDV object

The SDV object stores the data for initial values of solution-dependent state variables.
Access

import load mdb.models[name].fields[name]

19.14.1

SDV(...)

This method creates a SDV object.

19–29

SDV object

Path

mdb.models[name].SDV
Required arguments

name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.
Optional arguments

distribution A SymbolicConstant specifying how the field varies spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM. magnitudes A Sequence of Doubles specifying the values of the solution-dependent state variables when the distribution=UNIFORM.
Return value

A SDV object.
Exceptions

None.

19.14.2

setValues(...)

This method modifies the SDV object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the SDV method, except for the name argument.
Return value

None

19–30

Saturation object

Exceptions

None.

19.14.3
19.14.4

Members
Corresponding analysis keywords

The SDV object has members with the same names and descriptions as the arguments to the SDV method.

*INITIAL CONDITIONS, TYPE=SOLUTION

19.15

Saturation object

The Saturation object stores the data for initial saturation values for the analysis of flow through a porous medium.
Access

import load mdb.models[name].fields[name]

19.15.1

Saturation(...)

This method creates a Saturation object.
Path

mdb.models[name].Saturation
Required arguments

name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member. magnitude A Double specifying the initial saturation value.
Optional arguments

None.

19–31

SpudPreload object

Return value

A Saturation object.
Exceptions

None.

19.15.2

setValues(...)

This method modifies the Saturation object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the Saturation method, except for the name argument.
Return value

None
Exceptions

None.

19.15.3

Members

The Saturation object has members with the same names and descriptions as the arguments to the Saturation method.
19.15.4 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=SATURATION

19.16

SpudPreload object

The SpudPreload object stores the data for initial preload value for a spud can.
Access

import load

19–32

SpudPreload object

mdb.models[name].fields[name]

19.16.1

SpudPreload(...)

This method creates a SpudPreload object.
Path

mdb.models[name].SpudPreload
Required arguments

name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member. magnitude A Double specifying the spud can preload.
Optional arguments

None.
Return value

A SpudPreload object.
Exceptions

None.

19.16.2

setValues(...)

This method modifies the SpudPreload object.
Arguments Required arguments

None.
Optional arguments

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

19–33

Stress object

Return value

None
Exceptions

None.

19.16.3

Members

The SpudPreload object has members with the same names and descriptions as the arguments to the SpudPreload method.
19.16.4 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=SPUD PRELOAD

19.17

Stress object

The Stress object stores the data for an initial stress field.
Access

import load mdb.models[name].fields[name]

19.17.1

Stress(...)

This method creates a Stress object.
Path

mdb.models[name].Stress
Required arguments

name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.

19–34

Stress object

Optional arguments

distribution A SymbolicConstant specifying how the field varies spatially. Possible values are UNIFORM, GEOSTATIC, and USER_DEFINED. The default value is UNIFORM. sectionType A SymbolicConstant specifying the section type when distribution=UNIFORM. Possible values are SOLID, REGULAR_SHELL, MEMBRANE, REGULAR_BEAM, GENERALIZED_SHELL, GENERALIZED_BEAM, TRUSS, and SOLID. stressTensor A Sequence of sequences of Doubles that specify the six stress components when distribution=UNIFORM. magnitude1 A Double specifying the first value of vertical component of effective stress when distribution=GEOSTATIC. verticalCoord1 A Double specifying the vertical coordinate corresponding to magnitude1. magnitude2 A Double specifying the second value of vertical component of effective stress when distribution=GEOSTATIC. verticalCoord2 A Double specifying the vertical coordinate corresponding to magnitude2. lateralCoeff1 A Double specifying the first coefficient of lateral stress when distribution=GEOSTATIC. lateralCoeff2 A Double specifying the second coefficient of lateral stress when distribution=GEOSTATIC.

Return value

A Stress object.

Exceptions

None.

19.17.2

setValues(...)

This method modifies the Stress object.

19–35

Temperature object

Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the Stress method, except for the name argument.
Return value

None
Exceptions

None.

19.17.3

Members

The Stress object has members with the same names and descriptions as the arguments to the Stress method.
19.17.4 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=STRESS

19.18

Temperature object

The Temperature object stores the data for temperature fields.
Access

import load mdb.models[name].fields[name]

19.18.1

Temperature(...)

This method creates a Temperature object.
Path

mdb.models[name].Temperature

19–36

Temperature object

Required arguments

name A String specifying the repository key. createStepName A String specifying the name of the step in which the field is created. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.
Optional arguments

distribution A SymbolicConstant specifying how the field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, and FROM_FILE_AND_USER_DEFINED. The default value is UNIFORM. crossSectionDistribution A SymbolicConstant specifying how the field is distributed over the cross section of the region. Possible values are

• • • •

CONSTANT_OVER_SECTION GRADIENTS_THROUGH_SHELL_CS GRADIENTS_THROUGH_BEAM_CS POINTS_THROUGH_SECTION

The default value is CONSTANT_OVER_SECTION. amplitude A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the Field has no amplitude reference. The default value is UNSET. Note: amplitude should be given only if it is valid for the specified step. fileName A String specifying the name of the file from which the temperature values are to be read when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. beginStep An Int specifying the first step from which temperature values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. The default value is None.

19–37

Temperature object

beginIncrement An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. The default value is None. endStep An Int specifying the last step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. The default value is None. endIncrement An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. The default value is None. interpolate A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values areOFF, ON or MIDSIDE_ONLY. The default value is OFF. magnitudes A Sequence of Doubles specifying the temperature values when distribution=UNIFORM. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:

• • • •

If crossSectionDistribution=CONSTANT_OVER_SECTION then magnitudes is a Double specifying the temperature. If crossSectionDistribution=GRADIENTS_THROUGH_SHELL_CS then magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction. If crossSectionDistribution=GRADIENTS_THROUGH_BEAM_CS then magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction. If crossSectionDistribution=POINTS_THROUGH_SECTION then magnitudes is a sequence of Doubles specifying the temperature at each point.

absoluteExteriorTolerance A Float specifying the absolute value by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside. exteriorTolerance A Float specifying the fraction of the average element size in the global model by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

19–38

Temperature object

Return value

A Temperature object.
Exceptions

None.

19.18.2

move(...)

This method moves the TemperatureState object from one step to a different step.
Arguments Required arguments

fromStepName A String specifying the name of the step from which the FieldState is moved. toStepName A String specifying the name of the step to which the FieldState is moved.
Optional arguments

None.
Return value

None
Exceptions

TextError.

19.18.3

setValues(...)

This method modifies the data for an existing Temperature 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 Temperature method, except for the name and createStepName arguments.

19–39

Temperature object

Return value

None
Exceptions

None.

19.18.4

setValuesInStep(...)

This method modifies the propagating data for an existing Temperature object in the specified step.
Arguments Required argument

stepName A String specifying the name of the step in which the field is modified.
Optional arguments

The optional arguments to setValuesInStep are the same as the optional arguments to the Temperature method, except for the distribution and crossSectionDistribution arguments.
Return value

None
Exceptions

None.

19.18.5

Members

The Temperature object can have the following members: distribution A SymbolicConstant specifying how the field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, and FROM_FILE_AND_USER_DEFINED. The default value is UNIFORM. name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.

19–40

TemperatureState object

19.18.6

Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=TEMPERATURE *TEMPERATURE

19.19

TemperatureState object

The TemperatureState object stores the propagating data of a temperature in a step. One instance of this object is created internally by the Temperature object for each step. The TemperatureState object has no constructor or methods.
Access

import load mdb.models[name].steps[name].fieldStates[name]

19.19.1

Members

The TemperatureState object has the following members: magnitudesState A Sequence of SymbolicConstants specifying the propagation state of each item of the magnitudes member. Possible values of the SymbolicConstants are UNSET, SET, and UNCHANGED. fileName A String specifying the name of the file from which the temperature values are to be read when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. fileNameState A SymbolicConstant specifying the propagation state of the fileName member. Possible values are UNSET, SET, and UNCHANGED. beginStep An Int specifying the first step from which temperature values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. The default value is None. beginStepState A SymbolicConstant specifying the propagation state of the beginStep member. Possible values are UNSET, SET, and UNCHANGED. beginIncrement An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. The default value is None.

19–41

TemperatureState object

beginIncrementState A SymbolicConstant specifying the propagation state of the beginIncrement member. Possible values are UNSET, SET, and UNCHANGED. endStep An Int specifying the last step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. The default value is None. endStepState A SymbolicConstant specifying the propagation state of the endStep member. Possible values are UNSET, SET, and UNCHANGED. endIncrement An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. The default value is None. endIncrementState A SymbolicConstant specifying the propagation state of the endIncrement member. Possible values are UNSET, SET, and UNCHANGED. midside A Boolean specifying that temperatures in second-order elements are to be interpolated from corner node temperatures. This argument is valid only when distribution=FROM_FILE or distribution=FROM_FILE_AND_USER_DEFINED. midsideState A SymbolicConstant specifying the propagation state of the midside member. Possible values are UNSET, SET, and UNCHANGED. amplitude A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the Field has no amplitude reference. The default value is UNSET. Note: amplitude should be given only if it is valid for the specified step. amplitudeState A SymbolicConstant specifying the propagation state of the amplitudeState member. Possible values are UNSET, SET, and UNCHANGED. magnitudes A Sequence of Doubles specifying the temperature values when distribution=UNIFORM. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:



If crossSectionDistribution=CONSTANT_OVER_SECTION then magnitudes is a Double specifying the temperature.

19–42

Velocity object

• • •
status

If crossSectionDistribution=GRADIENTS_THROUGH_SHELL_CS then magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction. If crossSectionDistribution=GRADIENTS_THROUGH_BEAM_CS then magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction. If crossSectionDistribution=POINTS_THROUGH_SECTION then magnitudes is a sequence of Doubles specifying the temperature at each point.

A SymbolicConstant specifying the propagation state of the FieldState object. Possible values are:

• • • • • • • • • • • • •

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED DEACTIVATED_TO_INITIAL NO_LONGER_ACTIVE RESET_TO_INITIAL TO_BE_COMPUTED PROPAGATED_FROM_COMPUTED BUILT_INTO_BASE_STATE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE

This member exists in all FieldState objects, but different fields use different subsets of the entire list of possible values depending on propagation rules.

19.20

Velocity object

The TranslationalVelocity object stores the data for an initial velocity field.
Access

import load mdb.models[name].fields[name]

19.20.1

Velocity(...)

This method creates a Velocity field object.

19–43

Velocity object

Path

mdb.models[name].Velocity
Required arguments

name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member. velocity1 A Double specifying the first component of the velocity. velocity2 A Double specifying the second component of the velocity. velocity3 A Double specifying the third component of the velocity. omega A Double specifying the angular velocity. axisBegin A sequence of Doubles specifying the X-, Y-, and Z- coordinates of the starting point of the axis about which omega is defined. axisEnd A sequence of Doubles specifying the X-, Y-, and Z- coordinates of the end point of the axis about which omega is defined.
Optional arguments

None.
Return value

A Velocity object.
Exceptions

None.

19.20.2

setValues(...)

This method modifies the Velocity object.

19–44

VoidsRatio object

Arguments Required arguments None. Optional arguments

The optional arguments to setValues are the same as the arguments to the Velocity method, except for the name argument.
Return value

None
Exceptions

None.

19.20.3

Members

The Velocity object has members with the same names and descriptions as the arguments to the Velocity method.
19.20.4 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=VELOCITY *INITIAL CONDITIONS, TYPE=ROTATING VELOCITY

19.21

VoidsRatio object

The VoidsRatio object stores the data for initial void ratios.
Access

import load mdb.models[name].fields[name]

19.21.1

VoidsRatio(...)

This method creates a VoidsRatio object.
Path

mdb.models[name].VoidsRatio

19–45

VoidsRatio object

Required arguments

name A String specifying the repository key. region A Region object specifying the region to which the field is applied. All field objects have this member, but it is not applicable if the object has a distribution member and distribution=FROM_FILE or FROM_FILE_AND_USER_DEFINED, or if the object has an instances member.
Optional arguments

distribution A SymbolicConstant specifying how the field varies spatially. Possible values are UNIFORM, LINEAR , and USER_DEFINED. The default value is LINEAR. magnitude A Double specifying the magnitute of the void ratio, if the distribution=UNIFORM, or the first value of void ratio=LINEAR. verticalCoord1 A Double specifying distribution=LINEAR. the vertical component corresponding to magnitude1 when

magnitude2 A Double specifying the second value of void ratio when distribution=LINEAR. verticalCoord2 A Double specifying distribution=LINEAR.
Return value

the

vertical

component

corresponding

to

magnitude2

when

A VoidsRatio object.
Exceptions

None.

19.21.2

setValues(...)

This method modifies the VoidsRatio object.
Arguments Required arguments

None.

19–46

VoidsRatio object

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

None
Exceptions

None.

19.21.3

Members

The VoidsRatio object has members with the same names and descriptions as the arguments to the VoidsRatio method.
19.21.4 Corresponding analysis keywords

*INITIAL CONDITIONS, TYPE=RATIO

19–47

FieldReportOptions object

20.
20.1

History and Field Report commands
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

20.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 initial 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 initial value is ON. printTotal A Boolean specifying whether to include column totals in the tabular report. The initial value is ON. printMinMax A Boolean specifying whether to include column summary minimum and maximum values in the tabular report. The initial value is ON.

20–1

HistoryVariable object

pageWidth A SymbolicConstant specifying how the width of the tabular report is to be determined. Possible values are NO_LIMIT and SPECIFY. The initial 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 initial 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 initial value is ASCENDING.
Return value

A FieldReportOptions object.
Exceptions

None.

20.1.2

Members

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

20.2

HistoryVariable object

The HistoryVariable object stores history data.
Access

import visualization session.viewports[name].odbDisplay.historyVariables[name]

20.2.1
name

Members

The HistoryVariable object has the following members: A read-only String specifying the history request label. legendLabel A read-only String specifying the legend text. steps A read-only sequence of tuples each containing the following elements:

20–2

writeFieldReport

• • •

stepLabel: A String specifying the step label. stepNumber: An Int specifying the step number. procedureDomain: A SymbolicConstant specifying the analysis type of the step. Possible values are “TIME,” “FREQUENCY,” or “MODAL.”

20.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.
Access

import visualization session.viewports[name].odbDisplay.fieldVariables

20.3.1

Members

The OdbFieldVarList object has no members.

20.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].odbDisplay.modelVariableList

20.4.1

Members

The OdbModelFieldVarList object has no members.

20.5

writeFieldReport

This command writes a field output report to a file.

20.5.1

writeFieldReport(...)

This method writes a FieldOutput object to a user-defined ASCII file.

20–3

writeFieldReport

Path

session.writeFieldReport
Arguments Required arguments

filename A String specifying the name of the file to which field output will be written. 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.

20–4

writeFieldReport

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)'} 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.

20–5

Interaction object

21. • • • • •
21.1

Interaction commands
You use Interaction commands to define the following: Contact between two surfaces. Elastic foundations. Thermal film conditions. Radiation to and from the ambient environment. A user-defined actuator/sensor interaction.

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

The methods are described below.
Access

import interaction mdb.models[name].interactions[name]

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

21–1

Interaction object

Return value

None
Exceptions

None.

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

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

21–2

Interaction object

Return value

None
Exceptions

None.

21.1.4

resume()

This method resumes an interaction that was previously suppressed.
Arguments

None.
Return value

None
Exceptions

None.

21.1.5

suppress()

This method suppresses an interaction.
Arguments

None.
Return value

None
Exceptions

None.

21.1.6
name

Members

The Interaction object has the following member: A String specifying the repository key.

21–3

ActuatorSensor object

21.2

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]

21.2.1

ActuatorSensor(...)

This method creates an ActuatorSensor object.
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 or unsymmetric. The default value is OFF (symmetric). 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.

21–4

ActuatorSensor object

solutionDepVars A sequence of Floats specifying the initial values of the solution-dependent variables.
Optional arguments

None.
Return value

An ActuatorSensor object.
Exceptions

None.

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

21.2.3

Members

The ActuatorSensor object has members with the same names and descriptions as the arguments to the ActuatorSensor method.
21.2.4 Corresponding analysis keywords

*ELEMENT *USER ELEMENT *INITIAL CONDITIONS, TYPE=SOLUTION

21–5

ActuatorSensorProp object

21.3

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

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

21.3.2

setValues(...)

This method modifies the ActuatorSensorProp object.

21–6

ActuatorSensorState 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.
Return value

None
Exceptions

None.

21.3.3

Members

The ActuatorSensorProp object has members with the same names and descriptions as the arguments to the ActuatorSensorProp method.
21.3.4 Corresponding analysis keywords

*UEL PROPERTY

21.4

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

import interaction mdb.models[name].steps[name].interactionStates[name]

21.4.1
status

Members

The ActuatorSensorState object has the following member: A SymbolicConstant specifying the propagation state of the InteractionState object. Possible values are:

21–7

CavityRadiation object

• • • • • • • • •
21.5

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE

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]

21.5.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 sequence of Strings specifying the surfaces for which radiation viewfactor control is being specified.
Optional arguments

surfaceEmissivities A sequence of Floats specifying the surface emissivity, . The default value is an empty sequence.

21–8

CavityRadiation object

ambientTemp A Float specifying the reference ambient temperature value, . openCavity A Boolean specifying whether a cavity is open. The default value is OFF. 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 sequence of Strings specifying the surfaces that provide blocking inside the cavity. The default value is an empty sequence. rangeOfView A Float specifying the distance beyond which viewfactors need not be calculated because surfaces are judged to be too far apart to “see” each other (due to blocking by other surfaces). The default value is None, specifying no upper limit. surfaceReflection A Boolean specifying whether reflection must 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.
Return value

A CavityRadiation object.
Exceptions

None.

21.5.2

setValues(...)

This method modifies the data for an existing CavityRadiation 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 CavityRadiation method, except for the name and createStepName arguments.

21–9

CavityRadiationState object

Return value

None
Exceptions

None.

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

The optional arguments to setValuesInStep are the same as the optional arguments to the CavityRadiation method.
Return value

None
Exceptions

None.

21.5.4

Members

The CavityRadiation object has members with the same names and descriptions as the arguments to the CavityRadiation method.
21.5.5 Corresponding analysis keywords

*CAVITY DEFINITION

21.6

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.

21–10

CavityRadiationState object

The CavityRadiationState object has no constructor or methods.
Access

import interaction mdb.models[name].steps[name].interactionStates[name]

21.6.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. blockingSurfaces A sequence of Strings specifying the surfaces that provide blocking inside the cavity. 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. 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.

21–11

ConcentratedFilmCondition object

maximumDisplacement A Float specifying the maximum allowable motion of any node in the monitored node set before recalculation of radiation viewfactors. maximumDisplacementState A SymbolicConstant specifying the propagation state of the maximumDisplacement member. Possible values are UNSET, SET, UNCHANGED, and FREED. status A SymbolicConstant specifying the propagation state of the InteractionState object. Possible values are:

• • • • • • • • •
21.6.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*RADIATION VIEWFACTOR

21.7

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]

21.7.1

ConcentratedFilmCondition(...)

This method creates a ConcentratedFilmCondition object.
Path

mdb.models[name].ConcentratedFilmCondition

21–12

ConcentratedFilmCondition object

Required arguments

name A String specifying the repository key. 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, and USER_SUB.
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. Note: This argument applies only during an ABAQUS/Explicit analysis. interactionProperty A String specifying the FilmConditionProp object associated with this interaction. The interactionProperty argument applies only when definition=PROPERTY_REF. The default value is None. 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 None. 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 or definition=USER_SUB.

21–13

ConcentratedFilmCondition object

filmCoeffAmplitude A String specifying the name of the Amplitude object that gives the variation of the film coefficient, , with time. The default value is None. 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.

21.7.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 ConcentratedFilmCondition method, arguments.
Return value

are the same as the arguments to the except for the name and createStepName

None
Exceptions

None.

21.7.3

setValuesInStep(...)

This method modifies the propagating data of an existing ConcentratedFilmCondition object in the specified step.

21–14

ConcentratedFilmConditionState object

Arguments Required argument

stepName A String specifying the name of the step in which the interaction is modified.
Optional arguments

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.

21.7.4

Members

The ConcentratedFilmCondition object has members with the same names and descriptions as the arguments to the ConcentratedFilmCondition method.

21.8

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

import interaction mdb.models[name].steps[name].interactionStates[name]

21.8.1

Members

The ConcentratedFilmConditionState object has the following members: interactionProperty A String specifying the FilmConditionProp object associated with this interaction.

21–15

ConcentratedFilmConditionState object

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. sinkAmplitude A String specifying the name of the Amplitude object that gives the variation of the sink temperature. 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. filmCoeffAmplitude A String specifying the name of the Amplitude object that gives the variation of the film coefficient. 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. status A SymbolicConstant specifying the propagation state of the InteractionState object. Possible values are:

• • • • •

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED

21–16

ConcentratedRadiationToAmbient object

• • • •
21.8.2

NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CFILM

21.9

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]

21.9.1

ConcentratedRadiationToAmbient(...)

This method creates a ConcentratedRadiationToAmbient object.
Path

mdb.models[name].ConcentratedRadiationToAmbient
Required arguments

name A String specifying the repository key. 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, .

21–17

ConcentratedRadiationToAmbient object

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.
Return value

A ConcentratedRadiationToAmbient object.
Exceptions

None.

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

21–18

ConcentratedRadiationToAmbientState object

Return value

None
Exceptions

None.

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

The optional arguments to setValuesInStep are the same as the arguments to the ConcentratedRadiationToAmbient method, except for the name, createStepName, region, and explicitRegionType arguments.
Return value

None
Exceptions

None.

21.9.4

Members

The ConcentratedRadiationToAmbient object has members with the same names and descriptions as the arguments to the ConcentratedRadiationToAmbient method.

21.10

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.

21–19

ConcentratedRadiationToAmbientState object

The ConcentratedRadiationToAmbientState object has no constructor or methods.
Access

import interaction mdb.models[name].steps[name].interactionStates[name]

21.10.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. ambientTemperatureAmp A String specifying the name of the Amplitude object that gives the variation of the ambient temperature with time. 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. 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. status A SymbolicConstant specifying the propagation state of the InteractionState object. Possible values are:

• • • • • •

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE

21–20

ContactExp object

• • •
21.10.2

TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CRADIATE

21.11

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

21.11.1

Members

The ContactControl object has no members.

21.12

ContactExp object

The ContactExp object defines the contact domain and associated properties during contact. The ContactExp object has the same methods as the Interaction object. The ContactExp object is derived from the Interaction object.
Access

import interaction mdb.models[name].interactions[name]

21.12.1

ContactExp(...)

This method creates a ContactExp object.
Path

mdb.models[name].ContactExp

21–21

ContactExp object

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 indicating whether the contacting surface pair consists of all exterior faces, shell edges, and beam segments 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. 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.

21.12.2

ContactExp(...)

This method creates a ContactExp object.

21–22

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 indicating whether the contacting surface pair consists of all exterior faces, shell edges, and beam segments 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. 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:

21–23

ContactExp object

• •

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 indicating the status of the first surface. Possible values are MASTER and SLAVE.

Return value

A ContactExp object.
Exceptions

None.

21.12.3

Members

The ContactExp object can have the following members: 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.

21–24

ContactProperty object

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. name A String specifying the repository key.
21.12.4 Corresponding analysis keywords

*CONTACT

21.13

ContactProperty object

The ContactProperty object defines a contact interaction property. The ActuatorSensorProp object is derived from the InteractionProperty object.
Access

import interaction mdb.models[name].interactionProperties[name]

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

21–25

ContactPropertyAssignment object

Return value

A ContactProperty object.
Exceptions

None.

21.13.2

Members

The ContactProperty object can have the following members: tangentialBehavior A TangentialBehavior object. normalBehavior A NormalBehavior object. damping A Damping object. thermalConductance A ThermalConductance object. heatGeneration A GapHeatGeneration object. radiation A Radiation object.
21.13.3 Corresponding analysis keywords

*SURFACE INTERACTION

21.14

ContactPropertyAssignment object

The ContactPropertyAssignment object stores the contact property assignment definition for domain pairs in a ContactExp object. The ContactPropertyAssignment object has no constructor or members.
Access

import interaction mdb.models[name].interactions[name].contactPropertyAssignments

21–26

ContactPropertyAssignment object

21.14.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 indicating 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.

21.14.2

appendInStep(...)

This method allows addition of contact property 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 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.

21–27

Damping object


None.

A String specifying an InteractionProperty object associated with this pair of regions.

Optional arguments

Return value

None
Exceptions

None.

21.14.3

delete(...)

The delete method allows you to delete existing contact property assignments from a ContactExp object.
Arguments Required arguments

indices A sequence of Ints specifying the index of each contact property assignment to delete.
Optional arguments

None.
Return value

None
Exceptions

None.

21.14.4
21.14.5

Members
Corresponding analysis keywords

The ContactPropertyAssignment object has no members.

*CONTACT PROPERTY ASSIGNMENT

21.15

Damping object

The Damping object specifies damping for a contact interaction property.

21–28

Damping object

Access

import interaction mdb.models[name].interactionProperties[name].damping

21.15.1

Damping(...)

This method creates a Damping object.
Path

mdb.models[name].interactionProperties[name].Damping
Required arguments

None.
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 A Float or a SymbolicConstant 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 (and only value for definition=CRITICAL_DAMPING_FRACTION) is STEP. table A sequence of pairs of Floats. 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.

21–29

ElasticFoundation object

If definition=CRITICAL_DAMPING_FRACTION, the table data specify the following:



Critical damping fraction.

Return value

A Damping object.
Exceptions

None.

21.15.2

setValues(...)

This method modifies the Damping object.
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

None.

21.15.3

Members

The Damping object has members with the same names and descriptions as the arguments to the Damping method.
21.15.4 Corresponding analysis keywords

*CONTACT DAMPING

21.16

ElasticFoundation object

The ElasticFoundation object defines a mechanical foundation. The ElasticFoundation object is derived from the Interaction object.

21–30

ElasticFoundation object

Access

import interaction mdb.models[name].interactions[name]

21.16.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’. 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.

21.16.2

setValues(...)

This method modifies the data for an existing ElasticFoundation object in the step where it is created.
Arguments Required arguments

None.

21–31

ElasticFoundation object

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.

21.16.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.
Optional argument

stiffness A Float specifying the foundation stiffness per area (or per length for beams).
Return value

None
Exceptions

None.

21.16.4

Members

The ElasticFoundation object has members with the same names and descriptions as the arguments to the ElasticFoundation method.
21.16.5 Corresponding analysis keywords

*FOUNDATION

21–32

ElasticFoundationState object

21.17

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.

Access

import interaction mdb.models[name].steps[name].interactionStates[name]

21.17.1

Members

The ElasticFoundationState object has the following members: stiffness A Float specifying the foundation stiffness per area. 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

21–33

ExpContactControl object

21.18

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]

21.18.1

ExpContactControl(...)

This method creates an ExpContactControl object.
Path

mdb.models[name].ExpContactControl
Required argument

name A String specifying the contact controls repository key.
Optional arguments

globTrkChoice A SymbolicConstant that specifies 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.

21–34

ExpContactControl object

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

None

Exceptions

RangeError.

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

Return value

None

Exceptions

RangeError.

21.18.3

Members

The ExpContactControl object has members with the same names and descriptions as the arguments to the ExpContactControl method.
21.18.4 Corresponding analysis keywords

*CONTACT CONTROLS

21–35

FilmCondition object

21.19

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]

21.19.1

FilmCondition(...)

This method creates a FilmCondition object.
Path

mdb.models[name].FilmCondition
Required arguments

name A String specifying the repository key. createStepName A String specifying the name of the step in which the FilmCondition object is created. surface A String specifying the name of the surface to which the film condition interaction is applied. definition A SymbolicConstant specifying how the film condition is defined. EMBEDDED_COEFF, PROPERTY_REF, and USER_SUB.
Optional arguments

Possible values are

interactionProperty A String specifying the FilmConditionProp object associated with this interaction. The interactionProperty argument applies only when definition=PROPERTY_REF. The default value is None. 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 None.

21–36

FilmCondition object

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 or definition=USER_SUB. filmCoeffAmplitude A String specifying the name of the Amplitude object that gives the variation of the film coefficient, , with time. The default value is None. 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 FilmCondition object.
Exceptions

None.

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

21–37

FilmConditionProp object

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

The optional arguments to setValuesInStep are the same as the optional arguments to the FilmCondition method.
Return value

None
Exceptions

None.

21.19.4

Members

The FilmCondition object has members with the same names and descriptions as the arguments to the FilmCondition method.

21.20

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]

21.20.1

FilmConditionProp(...)

This method creates a FilmConditionProp object.

21–38

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

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

21–39

FilmConditionState object

Return value

None
Exceptions

None.

21.20.3

Members

The FilmConditionProp object has members with the same names and descriptions as the arguments to the FilmConditionProp method.
21.20.4 Corresponding analysis keywords

*FILM PROPERTY

21.21

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

import interaction mdb.models[name].steps[name].interactionStates[name]

21.21.1

Members

The FilmConditionState object has the following members: interactionProperty A String specifying the FilmConditionProp object associated with this interaction. 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.

21–40

GapHeatGeneration object

sinkAmplitude A String specifying the name of the Amplitude object that gives the variation of the sink temperature. 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. filmCoeffAmplitude A String specifying the name of the Amplitude object that gives the variation of the film coefficient. filmCoeffAmplitudeState A SymbolicConstant specifying the propagation state of the filmCoeffAmplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED. status A SymbolicConstant specifying the propagation state of the InteractionState object. Possible values are:

• • • • • • • • •
21.21.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*SFILM

21.22

GapHeatGeneration object

The GapHeatGeneration object specifies heat generation for a contact interaction property.

21–41

GapHeatGeneration object

Access

import interaction mdb.models[name].interactionProperties[name].heatGeneration

21.22.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.
Return value

A GapHeatGeneration object.
Exceptions

None.

21.22.2

setValues(...)

This method modifies the GapHeatGeneration object.
Arguments

The arguments to setValues are the same as the arguments to the HeatGeneration method.
Return value

None
Exceptions

None.

21–42

InteractionState object

21.22.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.
21.22.4 Corresponding analysis keywords

*GAP HEAT GENERATION

21.23

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]

21.23.1

Members

The InteractionProperty object has no members.

21.24

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]

21.24.1

Members

The InteractionState object has the following member:

21–43

MasterSlaveAssignment object

status A SymbolicConstant specifying the propagation state of the InteractionState object. Possible values are:

• • • • • • • • •
21.25

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE

MasterSlaveAssignment object

The MasterSlaveAssignment object stores the master-slave assignment definition for surfaces in a ContactExp object. The MasterSlaveAssignment object has no constructor or members.
Access

import interaction mdb.models[name].interactions[name].masterSlaveAssignments

21.25.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 indicating the value of the master-slave to be assigned to the surface whose index is referenced. Possible values are MASTER and SLAVE.

21–44

MasterSlaveAssignment object

Optional arguments None. Return value

None
Exceptions

None.

21.25.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:

• •
None.

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 and SLAVE.

Optional arguments

Return value

None
Exceptions

None.

21.25.3

delete(...)

The delete method allows you to delete existing master-slave assignments from a ContactExp object.

21–45

NormalBehavior object

Arguments Required arguments

indices A sequence of Ints specifying the index of each master-slave assignment to delete.
Optional arguments

None.
Return value

None
Exceptions

None.

21.25.4

Members

The MasterSlaveAssignment object has no members.
21.25.5 Corresponding analysis keywords

*CONTACT FORMULATION, TYPE=PURE MASTER-SLAVE

21.26

NormalBehavior object

The NormalBehavior object specifies normal behavior for a contact interaction property.
Access

import interaction mdb.models[name].interactionProperties[name].normalBehavior

21.26.1

NormalBehavior(...)

This method creates a NormalBehavior object.
Path

mdb.models[name].interactionProperties[name].NormalBehavior

21–46

NormalBehavior object

Required argument

contactStiffness A Float or SymbolicConstant DEFAULT specifying the contact stiffness. This argument is valid only for pressureOverclosure=LINEAR. A value of DEFAULT is valid only when augmentedLagrange=ON.
Optional arguments

pressureOverclosure A SymbolicConstant specifying the pressure-overclosure relationship to be used. Possible values are HARD, EXPONENTIAL, LINEAR, and TABULAR. The default value is HARD. allowSeparation A Boolean specifying whether to allow separation after contact. The default value is ON. maxStiffness A Float specifying the maximum stiffness. The default value is None, specifying no upper limit. table A sequence of sequences of Floats. This argument is valid only for pressureOverclosure=EXPONENTIAL or TABULAR. The items in the table data are described below. augmentedLagrange A Boolean specifying augmented Lagrangian enforcement of contact constraints. This argument may be used only when pressureOverclosure=HARD. The default value is OFF. Table data If pressureOverclosure=EXPONENTIAL, the table data specify the following:

• • • •

Pressure at zero clearance, . Clearance at which the contact pressure is zero, Pressure. Overclosure.

.

If pressureOverclosure=TABULAR, the table data specify the following:

Return value

A NormalBehavior object.
Exceptions

None.

21.26.2

setValues(...)

This method modifies the NormalBehavior object.

21–47

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

21.26.3

Members

The NormalBehavior object has members with the same names and descriptions as the arguments to the NormalBehavior method.
21.26.4 Corresponding analysis keywords

*SURFACE BEHAVIOR

21.27

Radiation object

The Radiation object specifies radiation for a contact interaction property.
Access

import interaction mdb.models[name].interactionProperties[name].radiation

21.27.1

Radiation(...)

This method creates a Radiation object.
Path

mdb.models[name].interactionProperties[name].Radiation

21–48

Radiation object

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:

• •
None.

Effective viewfactor, Gap clearance, .

.

Optional arguments

Return value

A Radiation object.
Exceptions

None.

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

21.27.3

Members

The Radiation object has members with the same names and descriptions as the arguments to the Radiation method.

21–49

RadiationToAmbient object

21.27.4

Corresponding analysis keywords

*GAP RADIATION

21.28

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]

21.28.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. 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, .

21–50

RadiationToAmbient object

Optional arguments

None.
Return value

A RadiationToAmbient object.
Exceptions

None.

21.28.2

setValues(...)

This method modifies the data for an existing RadiationToAmbient 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 RadiationToAmbient method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

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

The optional arguments to setValuesInStep are the same as the arguments to the RadiationToAmbient method, except for the name, createStepName, and surface arguments.

21–51

RadiationToAmbientState object

Return value

None
Exceptions

None.

21.28.4

Members

The RadiationToAmbient object has members with the same names and descriptions as the arguments to the RadiationToAmbient method.

21.29

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

import interaction mdb.models[name].steps[name].interactionStates[name]

21.29.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. ambientTemperatureAmp A String specifying the name of the Amplitude object that gives the variation of the ambient temperature with time. 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.

21–52

RegionPairs object

emissivityState A SymbolicConstant specifying the propagation state of the emissivity member. Possible values are UNSET, SET, UNCHANGED, and FREED. status A SymbolicConstant specifying the propagation state of the InteractionState object. Possible values are:

• • • • • • • • •
21.29.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*SRADIATE

21.30

RegionPairs object

The RegionPairs object stores the domain pair definition for a ContactExp object. The RegionPairs object has no constructor or members.
Access

import interaction mdb.models[name].interactions[name].excludedPairs mdb.models[name].interactions[name].includedPairs

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

21–53

SelfContactExp object

Optional arguments

useAllstar A Boolean indicating whether the contacting surface pair consists of all exterior faces, shell edges, and beam segments in the model. addPairs A sequence of pairs of region objects or SymbolicConstants that specifies the surface pairs to add to the included pairs in the ContactExp object in the given step. Possible values of the SymbolicConstants are WHOLE_DOMAIN and SELF. removePairs A sequence of pairs of region objects or SymbolicConstants that specifies the surface pairs to remove from the included pairs in the ContactExp object in the given step. Possible values of the SymbolicConstants are WHOLE_DOMAIN and SELF.
Return value

None
Exceptions

None.

21.30.2

Members

The RegionPairs object has no members.
21.30.3 Corresponding analysis keywords

*CONTACT INCLUSIONS *CONTACT EXCLUSIONS

21.31

SelfContactExp object
The

The SelfContactExp object defines self-contact during an ABAQUS/Explicit analysis. SelfContactExp object is derived from the Interaction object.
Access

import interaction mdb.models[name].interactions[name]

21–54

SelfContactExp object

21.31.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. KINEMATIC and PENALTY. The default value is KINEMATIC.

Possible values are

contactControls A String specifying the name of the ContactControl object associated with this interaction. The default value is an empty string, indicating that the default contact controls will be used.
Return value

A SelfContactExp object.
Exceptions

None.

21.31.2

setValues(...)

This method modifies the data for an existing SelfContactExp object in the step where it is created.
Arguments Required arguments

None.

21–55

SelfContactExp object

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.

21.31.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.
Return value

None
Exceptions

None.

21.31.4

Members

The SelfContactExp object has members with the same names and descriptions as the arguments to the SelfContactExp method.

21–56

SelfContactExpState object

21.32

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

import interaction mdb.models[name].steps[name].interactionStates[name]

21.32.1

Members

The SelfContactExpState object has the following members: interactionProperty A String specifying the name of the ContactProperty object associated with this interaction. interactionPropertyState A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible values are UNSET, SET, UNCHANGED, and FREED. contactControls A String specifying the name of the ContactControl object associated with this interaction. contactControlsState A SymbolicConstant specifying the propagation state of the contactControls 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

21–57

SelfContactStd object

21.32.2

Corresponding analysis keywords

*CONTACT CONTROLS *CONTACT PAIR *MODEL CHANGE, TYPE=CONTACT PAIR

21.33

SelfContactStd object
The

The SelfContactStd object defines self-contact during an ABAQUS/Standard analysis. SelfContactStd object is derived from the Interaction object.
Access

import interaction mdb.models[name].interactions[name]

21.33.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.
Optional argument

contactControls A String specifying the name of the ContactControl object associated with this interaction. The default value is an empty string, indicating that the default contact controls will be used.
Return value

A SelfContactStd object.

21–58

SelfContactStd object

Exceptions

None.

21.33.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
Exceptions

None.

21.33.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 ContactProperty object associated with this interaction. contactControls A String specifying the name of the ContactControl object associated with this interaction.
Return value

None

21–59

SelfContactStdState object

Exceptions

None.

21.33.4

Members

The SelfContactStd object has members with the same names and descriptions as the arguments to the SelfContactStd method.

21.34

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

import interaction mdb.models[name].steps[name].interactionStates[name]

21.34.1

Members

The SelfContactStdState object has the following members: interactionProperty A String specifying the ContactProperty object associated with this interaction. interactionPropertyState A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible values are UNSET, SET, UNCHANGED, and FREED. contactControls A String specifying the name of the ContactControl object associated with this interaction. contactControlsState A SymbolicConstant specifying the propagation state of the contactControls 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

21–60

StdContactControl object

• • • • • • •
21.34.2

PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CONTACT CONTROLS *CONTACT PAIR *MODEL CHANGE, TYPE=CONTACT PAIR

21.35

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]

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

21–61

StdContactControl object

penetrationTolChoice A SymbolicConstant that specifies 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. Only contact interactions defined with augmented Lagrangian surface behavior will be affected by this argument. The default value is 0.1%. The relativePenetrationTolerance argument applies only when penetrationTolChoice=RELATIVE. The relativePenetrationTolerance and absolutePenetrationTolerance arguments are mutually exclusive. absolutePenetrationTolerance 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. slideDistanceChoice A SymbolicConstant that specifies whether or not the default value will be used for the maximum slide distance that slave nodes can slide on the master surface. Possible values are DEFAULT and SPECIFY. The default value is DEFAULT. slideDistance A Float specifying the maximum slide distance that slave nodes can slide on the master surface. The slideDistance argument applies only when slideDistanceChoice=SPECIFY. frictionOnset A SymbolicConstant specifying when the application of friction occurs. Possible values are IMMEDIATE and DELAYED. If frictionOnset=IMMEDIATE, friction is included in the increment when contact occurs. If frictionOnset=DELAYED, 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.

21–62

StdContactControl object

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 that indicates 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 when stabilizeChoice=AUTOMATIC. For any other value of stabilizeChoice this argument is not valid. dampCoef A Float that directly specifies the damping coefficient. The default value is 0.0 when stabilizeChoice=COEFFICIENT. For any other value of stabilizeChoice this argument is not valid. 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. This argument is valid only if stabilizeChoice = AUTOMATIC or COEFFICIENT. zeroDampingChoice A SymbolicConstant that indicates 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 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.
Return value

None

21–63

SurfaceFeatureAssignment object

Exceptions

RangeError.

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

21.35.3

Members

The StdContactControl object has members with the same names and descriptions as the arguments to the StdContactControl method.
21.35.4 Corresponding analysis keywords

*CONTACT CONTROLS

21.36

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 mdb.models[name].interactions[name].surfaceFeatureAssignments

21–64

SurfaceFeatureAssignment object

21.36.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:


None.

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

Return value

None
Exceptions

None.

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

21–65

SurfaceFeatureAssignment object

assignments A sequence of tuples specifying the surface feature angle assignments. Each tuple contains two entries:

• •
None.

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

Return value

None
Exceptions

None.

21.36.3

delete(...)

The delete method allows you to delete existing surface feature angle assignments from a ContactExp object.
Arguments Required arguments

indices A sequence of Ints specifying the index of each surface feature angle assignment to delete.
Optional arguments

None.
Return value

None
Exceptions

None.

21.36.4

Members

The SurfaceFeatureAssignment object has no members.

21–66

SurfaceOffsetAssignment object

21.36.5

Corresponding analysis keywords

*SURFACE PROPERTY ASSIGNMENT, PROPERTY=FEATURE EDGE CRITERIA

21.37

SurfaceOffsetAssignment object

The SurfaceOffsetAssignment object stores the surface offset fraction assignment definition for surfaces in a ContactExp object. The SurfaceOffsetAssignment object has no constructor or members.
Access

import interaction mdb.models[name].interactions[name].surfaceOffsetAssignments

21.37.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:


None.

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

Return value

None
Exceptions

None.

21–67

SurfaceOffsetAssignment object

21.37.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:

• •
None.

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

Return value

None
Exceptions

None.

21.37.3

delete(...)

The delete method allows you to delete existing surface offset fraction assignments from a ContactExp object.
Arguments Required arguments

indices A sequence of Ints specifying the index of each surface offset fraction assignment to delete.
Optional arguments

None.

21–68

SurfaceThicknessAssignment object

Return value

None
Exceptions

None.

21.37.4
21.37.5

Members
Corresponding analysis keywords

The SurfaceOffsetAssignment object has no members.

*SURFACE PROPERTY ASSIGNMENT, PROPERTY=OFFSET FRACTION

21.38

SurfaceThicknessAssignment object

The SurfaceThicknessAssignment object stores the surface thickness assignment definition for surfaces in a ContactExp object. The SurfaceThicknessAssignment object has no constructor or members.
Access

import interaction mdb.models[name].interactions[name].surfaceThicknessAssignments

21.38.1

changeValuesInStep(...)

This method allows modification of surface thickness 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 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:

21–69

SurfaceThicknessAssignment object

• •
None.

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. A Float specifying a scale factor that multiplies the thickness value specified in the second entry.

Optional arguments

Return value

None
Exceptions

None.

21.38.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:

• • •
None.

A region object or the SymbolicConstant WHOLE_DOMAIN 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. A Float specifying a scale factor that multiplies the thickness value specified in the second entry.

Optional arguments

Return value

None

21–70

SurfaceToSurfaceContactExp object

Exceptions

None.

21.38.3

delete(...)

The delete method allows you to delete existing surface thickness assignments from a ContactExp object.
Arguments Required arguments

indices A sequence of Ints specifying the index of each surface thickness assignment to delete.
Optional arguments

None.
Return value

None
Exceptions

None.

21.38.4
21.38.5

Members
Corresponding analysis keywords

The SurfaceThicknessAssignment object has no members.

*SURFACE PROPERTY ASSIGNMENT, PROPERTY=THICKNESS

21.39

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]

21–71

SurfaceToSurfaceContactExp object

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

mechanicalConstraint A SymbolicConstant specifying the mechanical constraint formulation. KINEMATIC and PENALTY. The default value is KINEMATIC.

Possible values are

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 weightingFactorType=SPECIFIED. The default value is 0.0. contact surfaces when

contactControls A String specifying the name of the ContactControl object associated with this interaction. The default value is an empty string, indicating that the default contact controls will be used.
Return value

A SurfaceToSurfaceContactExp object.

21–72

SurfaceToSurfaceContactExp object

Exceptions

None.

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

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

21–73

SurfaceToSurfaceContactStd object

21.39.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.
Return value

None
Exceptions

None.

21.39.5

Members

The SurfaceToSurfaceContactExp object has members with the same names and descriptions as the arguments to the SurfaceToSurfaceContactExp method.

21.40

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]

21–74

SurfaceToSurfaceContactStd object

21.40.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. The default value is FINITE. 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, SHRINK_FIT, and UNIFORM. Use NONE to specify no allowable contact interference. The default value is NONE. overclosure A Float specifying the maximum overclosure distance allowed. This argument applies only when interferenceType=UNIFORM. 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.

21–75

SurfaceToSurfaceContactStd object

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 in finite-sliding contact. 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. limitSlideDistance A Boolean specifying whether to restrict the sliding distance of slave nodes. The default value is OFF. slideDistance A Float specifying the maximum distance that slave nodes can slide on the master surface. 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 specifying the Set object to which the adjustment is to be applied. enforcement A SymbolicConstant specifying the method used to determine the constraint enforcement. Possible values are NODE_TO_SURFACE, SURFACE_TO_SURFACE, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. This argument in valid only when sliding=SMALL. thickness A Boolean specifying whether shell/membrane element thickness is considered. The default value is OFF. This argument in valid only when sliding=SMALL and enforcement=SURFACE_TO_SURFACE. contactControls A String specifying the name of the ContactControl object associated with this interaction. The default value is an empty string, indicating that the default contact controls will be used.

21–76

SurfaceToSurfaceContactStd object

Return value

A SurfaceToSurfaceContactStd object.
Exceptions

None.

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

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

21–77

SurfaceToSurfaceContactStd object

Exceptions

None.

21.40.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, SHRINK_FIT, and UNIFORM. Use NONE to specify no allowable contact interference. The default value is NONE. overclosure A Float specifying the maximum overclosure distance allowed. This argument applies only when interferenceType=UNIFORM. 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 This argument is required only when interferenceDirectionType=DIRECTION_COSINE. It consists of 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.

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.

21–78

SurfaceToSurfaceExpState object

contactControls A String specifying the name of the ContactControl object associated with this interaction. The default value is an empty string, indicating that the default contact controls will be used.
Return value

None
Exceptions

None.

21.40.5

Members

The SurfaceToSurfaceContactStd object has members with the same names and descriptions as the arguments to the SurfaceToSurfaceContactStd method.

21.41

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

import interaction mdb.models[name].steps[name].interactionStates[name]

21.41.1

Members

The SurfaceToSurfaceExpState object has the following members: interactionProperty A String specifying the name of the ContactProperty object associated with this interaction. interactionPropertyState A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible values are UNSET, SET, UNCHANGED, and FREED. contactControls A String specifying the name of the ContactControl object associated with this interaction. contactControlsState A SymbolicConstant specifying the propagation state of the contactControls member. Possible values are UNSET, SET, UNCHANGED, and FREED.

21–79

SurfaceToSurfaceStdState object

status A SymbolicConstant specifying the propagation state of the InteractionState object. Possible values are:

• • • • • • • • •
21.41.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CONTACT CONTROLS *CONTACT PAIR

21.42

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

import interaction mdb.models[name].steps[name].interactionStates[name]

21.42.1

Members

The SurfaceToSurfaceStdState object has the following members: interactionProperty A String specifying the name of the ContactProperty object associated with this interaction. interactionPropertyState A SymbolicConstant specifying the propagation state of the interactionProperty member. Possible values are UNSET, SET, UNCHANGED, and FREED.

21–80

SurfaceToSurfaceStdState object

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

directionState A SymbolicConstant specifying the propagation state of the direction member. Possible values are UNSET, SET, UNCHANGED, and FREED. amplitude A String specifying the name of the Amplitude object that defines the magnitude of the prescribed interference during the step. amplitudeState A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED. contactControls A String specifying the name of the ContactControl object associated with this interaction. contactControlsState A SymbolicConstant specifying the propagation state of the contactControls member. Possible values are UNSET, SET, UNCHANGED, and FREED.

21–81

TangentialBehavior object

status A SymbolicConstant specifying the propagation state of the InteractionState object. Possible values are:

• • • • • • • • •
21.42.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CONTACT CONTROLS *CONTACT PAIR *CONTACT INTERFERENCE

21.43

TangentialBehavior object

The TangentialBehavior object specifies tangential behavior for a contact interaction property.
Access

import interaction mdb.models[name].interactionProperties[name].tangentialBehavior

21.43.1

TangentialBehavior(...)

This method creates a TangentialBehavior object.
Path

mdb.models[name].interactionProperties[name].TangentialBehavior
Required arguments

None.

21–82

TangentialBehavior object

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. The items in the table data are described below. shearStressLimit A Float specifying the shear stress limit. The default value is None, specifying no upper limit. 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. absoluteDistance A Float specifying the absolute distance. elasticSlipStiffness A Float specifying the elastic slip stiffness. The default value is None, specifying no upper limit. nStateDependentVars An Int specifying the number of state-dependent variables. 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:

21–83

TangentialBehavior object

• • • • • • • • • • • • • •

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. Friction property.

If formulation=USER_DEFINED, the table data specify the following:

Return value

A TangentialBehavior object.
Exceptions

None.

21.43.2

setValues(...)

This method modifies the TangentialBehavior object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the TangentialBehavior method.

21–84

ThermalConductance object

Return value

None
Exceptions

None.

21.43.3

Members

The TangentialBehavior object has members with the same names and descriptions as the arguments to the TangentialBehavior method.
21.43.4 Corresponding analysis keywords

*FRICTION *CHANGE FRICTION

21.44

ThermalConductance object

The ThermalConductance object specifies thermal conductance for a contact interaction property.
Access

import interaction mdb.models[name].interactionProperties[name].thermalConductance

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

21–85

ThermalConductance object

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. clearanceDepTable A sequence of sequences of Floats. 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. 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. Conductivity. Pressure. Temperature, if the data depend on temperature.

The pressureDepTable data specify the following:

21–86

ThermalConductance object

• • • •

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

None.

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

21.44.3

Members

The ThermalConductance object has members with the same names and descriptions as the arguments to the ThermalConductance method.
21.44.4 Corresponding analysis keywords

*GAP CONDUCTANCE

21–87

Job object

22.

Job commands
The Job commands provide methods to create, modify, submit, and control jobs.

22.1

Job object

The Job object defines a job that can be submitted for analysis.
Access

import job mdb.jobs[name]

22.1.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 describing the job. type A SymbolicConstant specifying the type of job. Possible values are ANALYSIS, DATACHECK, SYNTAXCHECK, CONTINUE, RECOVER, and RESTART. The initial value is ANALYSIS. queue A String specifying the name of the queue to which to submit the job. The initial value is None. 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.

22–1

Job object

waitHours An Int specifying the number of hours to wait before submitting the job. This argument is ignored if queue is set. The initial 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 initial 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 initial value is None. Note: You can use the atTime argument when creating a Job object on a Windows workstation; however, remote queues are available only on UNIX platforms. echoPrint A Boolean specifying whether an echo of the input data is printed. The initial value is ON. contactPrint A Boolean specifying whether contact constraint data are printed. The initial value is ON. modelPrint A Boolean specifying whether model definition data are printed. The initial value is ON. historyPrint A Boolean specifying whether history data are printed. The initial value is ON. scratch A String specifying the location of the scratch directory. The initial value is an empty string. userSubroutine A String specifying the file containing the user’s subroutine definitions. The initial 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 initial value is 1. preMemory A Float specifying the amount of memory (in MB) available to the analysis preprocessor. Possible values are preMemory 0. The initial value is 256. standardMemory A Float specifying the amount of memory (in MB) available to ABAQUS/Standard. Possible values are standardMemory 0. The initial value is 256.

22–2

Job object

standardMemoryPolicy A SymbolicConstant specifying the ABAQUS/Standard memory policy. Possible values are MINIMUM, MODERATE, and MAXIMUM. The initial value is MODERATE. explicitPrecision A SymbolicConstant specifying whether to use the double precision version of ABAQUS/Explicit. Possible values are SINGLE and DOUBLE. The initial 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 initial value is SINGLE. parallelizationMethodExplicit A SymbolicConstant specifying the parallelization method for ABAQUS/Explicit. Possible values are LOOP and DOMAIN. The initial 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 initial value is 1. multiprocessingMode A SymbolicConstant specifying whether an analysis is decomposed into threads or into multiple processes that communicate through a message parsing interface. Possible values are DEFAULT, THREADS and MPI. The initial value is DEFAULT.
Return value

A Job object.
Exceptions

AbaqusError.

22.1.2

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.

22–3

Job object

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

type A SymbolicConstant specifying the type of job. Possible values are ANALYSIS, DATACHECK, SYNTAXCHECK, CONTINUE, and RECOVER. The initial value is ANALYSIS. queue A String specifying the name of the queue to which to submit the job. The initial value is None. 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 initial 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 initial 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 initial value is None. Note: You can use the atTime argument when creating a Job object on a Windows workstation; however, remote queues are available only on UNIX platforms. scratch A String specifying the location of the scratch directory. The initial value is an empty string. userSubroutine A String specifying the file containing the user’s subroutine definitions. The initial value is an empty string. numCpus An Int specifying the number of CPUs to use for this analysis. Possible values are numCpus The initial value is 1. 0.

preMemory A Float specifying the amount of memory (in MB) available to the analysis preprocessor. Possible values are preMemory 0. The initial value is 8.0.

22–4

Job object

standardMemory A Float specifying the amount of memory (in MB) available to ABAQUS/Standard. Possible values are standardMemory 0. The initial value is 42.0. standardMemoryPolicy A SymbolicConstant specifying the ABAQUS/Standard memory policy. Possible values are MINIMUM, MODERATE, and MAXIMUM. The initial value is MODERATE. explicitPrecision A SymbolicConstant specifying whether to use the double precision version of ABAQUS/Explicit. Possible values are SINGLE and DOUBLE. The initial 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 initial value is SINGLE. parallelizationMethodExplicit A SymbolicConstant specifying the parallelization method for ABAQUS/Explicit. Possible values are LOOP and DOMAIN. The initial 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 initial value is 1. multiprocessingMode A SymbolicConstant specifying whether an analysis is decomposed into threads or into multiple processes that communicate through a message parsing interface. Possible values are DEFAULT, THREADS and MPI (Message Passing Interface). The initial value is DEFAULT.
Return value

A Job object.
Exceptions

AbaqusError.

22.1.3

kill()

This method kills the analysis of a job.
Arguments

None.
Return value

None

22–5

Job object

Exceptions

None.

22.1.4

submit()

This method submits a job for analysis.
Arguments

None.
Return value

None
Exceptions

None.

22.1.5

waitForCompletion(...)

This method halts the execution of the script until the end of the analysis or until a time-out is reached. If the waitForCompletion method is called and the job status is neither SUBMITTED nor RUNNING, ABAQUS assumes the job has either completed or aborted and returns immediately.
Arguments Required arguments

None.
Optional argument

timeOut An Int specifying the number of seconds to wait until a time-out is reached. If waitForCompletion times out, ABAQUS throws the AbaqusException exception. If you do not provide a timeOut argument, the script will wait indefinitely for the job to complete. If the job submission is delayed using either the at or wait arguments, timeOut includes both the time required to wait and the time required to execute.
Return value

None

22–6

Job object

Exceptions

If waitForCompletion times out: AbaqusException: Will not wait for the job jobName to complete because of timeOut = numSec.

22.1.6

writeInput()

This method writes an input file.
Arguments

None.
Return value

None
Exceptions

None.

22.1.7

setValues(...)

This method modifies the Job object.
Arguments Required arguments

None.
Optional arguments

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 describing the job. type A SymbolicConstant specifying the type of job. Possible values are ANALYSIS, DATACHECK, SYNTAXCHECK, CONTINUE, RECOVER, and RESTART. The initial value is ANALYSIS. queue A String specifying the name of the queue to which to submit the job. The initial value is None. 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.

22–7

Job object

waitHours An Int specifying the number of hours to wait before submitting the job. This argument is ignored if queue is set. The initial 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 initial 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 initial value is None. Note: You can use the atTime argument when creating a Job object on a Windows workstation; however, remote queues are available only on UNIX platforms. echoPrint A Boolean specifying whether an echo of the input data is printed. The initial value is ON. contactPrint A Boolean specifying whether contact constraint data are printed. The initial value is ON. modelPrint A Boolean specifying whether model definition data are printed. The initial value is ON. historyPrint A Boolean specifying whether history data are printed. The initial value is ON. scratch A String specifying the location of the scratch directory. The initial value is an empty string. userSubroutine A String specifying the file containing the user’s subroutine definitions. The initial 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 initial value is 1. preMemory A Float specifying the amount of memory (in MB) available to the analysis preprocessor. Possible values are preMemory 0. The initial value is 256. standardMemory A Float specifying the amount of memory (in MB) available to ABAQUS/Standard. Possible values are standardMemory 0. The initial value is 256.

22–8

Job object

standardMemoryPolicy A SymbolicConstant specifying the ABAQUS/Standard memory policy. Possible values are MINIMUM, MODERATE, and MAXIMUM. The initial value is MODERATE. explicitPrecision A SymbolicConstant specifying whether to use the double precision version of ABAQUS/Explicit. Possible values are SINGLE and DOUBLE. The initial 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 initial value is SINGLE. parallelizationMethodStandard A SymbolicConstant specifying the parallelization method for the ABAQUS/Standard direct solver. Possible values are TREE and SUPER_NODE. The initial value is TREE. parallelizationMethodExplicit A SymbolicConstant specifying the parallelization method for ABAQUS/Explicit. Possible values are LOOP and DOMAIN. The initial 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 initial value is 1. multiprocessingMode A SymbolicConstant specifying whether an ABAQUS/Explicit analysis is decomposed into threads or into multiple processes that communicate through a message parsing interface. Possible values are THREADS and MPI. The initial value is THREADS. 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.
Return value

None
Exceptions

None.

22.1.8

Members

The Job object has members with the same names and descriptions as the arguments to the Job method. In addition, the Job object can have the following members:

22–9

Message object

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. analysis A SymbolicConstant specifying whether the job will be analyzed by ABAQUS/Standard or ABAQUS/Explicit. Possible values are STANDARD, EXPLICIT, and UNKNOWN. If the Job object was created with the JobFromInputFile method, analysisProduct=UNKNOWN. environment A list of strings specifying the environment variables and their values. inputType A SymbolicConstant specifying whether the Job object was created using a Model object name or an input file name for the model definition. Possible values are MODEL and INPUT_FILE. status A SymbolicConstant specifying the status of the analysis. Possible values are SUBMITTED, RUNNING, ABORTED, TERMINATED, and COMPLETED. If the message member is empty, status is set to NONE. messages An array of Message objects specifying the messages received during an analysis.
22.1.9 Corresponding analysis keywords

*HEADING *PREPRINT

22.2

Message object

The Message object contains information about a given phase of the simulation.
Access

import job mdb.jobs[name].messages[i]

22.2.1
type

Members

The Message object has the following members: A SymbolicConstant specifying the type of message. Possible values are:

• •

ABORTED ANY_JOB

22–10

Queue object

• • • • • • • • • • • • • • • • • • • • • • • •
data

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 WARNING

A Dictionary 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 object,” Section 28.2.

22.3

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.

22–11

Queue object

Access

import job session.queues[name]

22.3.1

Queue(...)

This method creates a Queue object. Note: Remote queues are available only on UNIX platforms.
Path

session.Queue
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 OFF. 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 NT. The default value is NT. remotePlatform A SymbolicConstant specifying the type of operating system on the remote machine. Possible values are UNIX and NT. 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’).

22–12

Queue object

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.

22.3.2

Members

The Queue object has members with the same names and descriptions as the arguments to the Queue method.

22–13

Load object

23.

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.

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

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

23.1.2

move(...)

This method moves the load state object from one step to a different step.

23–1

Load object

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.

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

23.1.4

resume()

This method resumes the load that was previously suppressed.

23–2

BodyCharge object

Arguments

None.
Return value

None
Exceptions

None.

23.1.5

suppress()

This method suppresses the load.
Arguments

None.
Return value

None
Exceptions

None.

23.1.6
name

Members

The Load object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.2

BodyCharge object

The BodyCharge object stores the data for a body charge.
Access

import load mdb.models[name].loads[name]

23–3

BodyCharge object

23.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.
Optional argument

amplitude A String or the SymbolicConstant UNSETspecifying 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 BodyCharge object.
Exceptions

None.

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

23–4

BodyCharge object

Return value

None
Exceptions

None.

23.2.3

setValuesInStep(...)

This method modifies the propagating data for an existing BodyCharge 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.

23.2.4
name

Members

The BodyCharge object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23–5

BodyChargeState object

23.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.
Access

import load mdb.models[name].steps[name].loadStates[name]

23.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–6

BodyConcentrationFlux object

23.3.2

Corresponding analysis keywords

*DECHARGE (load type label: EBF)

23.4

BodyConcentrationFlux object

The BodyConcentrationFlux object defines body concentration flux from a region or into a region.
Access

import load mdb.models[name].loads[name]

23.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. distribution=USER_DEFINED.
Optional arguments

magnitude is optional if

distribution A SymbolicConstant specifying how the body concentration flux is distributed spatially. Possible values are UNIFORM and USER_DEFINED. 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.

23–7

BodyConcentrationFlux object

Return value

A BodyConcentrationFlux object.
Exceptions

None.

23.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 BodyConcentrationFlux method, except for the name and createStepName arguments.
Return value

the

None
Exceptions

None.

23.4.3

setValuesInStep(...)

This method modifies the propagating data for an existing BodyConcentrationFlux 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 concentration flux magnitude.

23–8

BodyConcentrationFluxState object

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.

23.4.4

Members

The BodyConcentrationFlux object can have the following members: distribution A SymbolicConstant specifying how the body concentration flux is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.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.
Access

import load mdb.models[name].steps[name].loadStates[name]

23.5.1

Members

The BodyConcentrationFluxState object has the following members:

23–9

BodyCurrent object

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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.5.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CFLUX

23.6

BodyCurrent object

The BodyCurrent object stores the data for a body current.
Access

import load mdb.models[name].loads[name]

23.6.1

BodyCurrent(...)

This method creates a BodyCurrent object.

23–10

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 argument

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 BodyCurrent object.
Exceptions

None.

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

23–11

BodyCurrent object

Exceptions

None.

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

23.6.4
name

Members

The BodyCurrent object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23–12

BodyCurrentState object

23.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.
Access

import load mdb.models[name].steps[name].loadStates[name]

23.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–13

BodyForce object

23.7.2

Corresponding analysis keywords

*DECURRENT (load type label: CBF)

23.8

BodyForce object

The BodyForce object defines a distributed load.
Access

import load mdb.models[name].loads[name]

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

distribution A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. 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 distribution=USER_DEFINED. 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.

23–14

BodyForce object

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.

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

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

23–15

BodyForce object

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.

23.8.4

Members

The BodyForce object can have the following members: distribution A SymbolicConstant specifying how the load is distributed spatially. UNIFORM and USER_DEFINED. The default value is UNIFORM. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.
23.8.5 Corresponding analysis keywords

Possible values are

*DLOAD (load type label: BX, BY, BZ, BR, BXNU, BYNU, BZNU, or BRNU)

23–16

BodyForceState object

23.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.
Access

import load mdb.models[name].steps[name].loadStates[name]

23.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–17

BodyHeatFlux object

• • • • • • • •
23.9.2

CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DLOAD (load type label: BX, BY, BZ, BR, BXNU, BYNU, BZNU, or BRNU)

23.10

BodyHeatFlux object

The BodyHeatFlux object defines body heat flux from a region or into a region.
Access

import load mdb.models[name].loads[name]

23.10.1

BodyHeatFlux(...)

This method creates a BodyHeatFlux object.
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 distribution=USER_DEFINED.

23–18

BodyHeatFlux object

Optional arguments

distribution A SymbolicConstant specifying how the body heat flux is distributed spatially. Possible values are UNIFORM and USER_DEFINED. 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.

23.10.2

setValues(...)

This method modifies the data for an existing BodyHeatFlux 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 BodyHeatFlux method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

23.10.3

setValuesInStep(...)

This method modifies the propagating data for an existing BodyHeatFlux object in the specified step.

23–19

BodyHeatFluxState object

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.

23.10.4

Members

The BodyHeatFlux object can have the following members: distribution A SymbolicConstant specifying how the body heat flux is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

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

23–20

BoltLoad object

Access

import load mdb.models[name].steps[name].loadStates[name]

23.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.11.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DFLUX

23.12

BoltLoad object

The BoltLoad object defines a bolt load.

23–21

BoltLoad object

Access

import load mdb.models[name].loads[name]

23.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. region A Region object specifying the region to which the load is applied. magnitude A Float specifying the bolt load magnitude. datumAxis A DatumAxis 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.

23–22

BoltLoad object

Exceptions

TextError.

23.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
Exceptions

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

23–23

BoltLoadState object

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.

23.12.4

Members

The BoltLoad object can have the following members: datumAxis A DatumAxis 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. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.
23.12.5 Corresponding analysis keywords

*PRE-TENSION SECTION *NODE (for the reference node) *NSET (for the reference node)

23.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.
Access

import load mdb.models[name].steps[name].loadStates[name]

23–24

BoltLoadState object

23.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.13.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CLOAD (when boltMethod=APPLY_FORCE) *BOUNDARY (when boltMethod=ADJUST_LENGTH or FIX_LENGTH)

23–25

ConcCharge object

23.14

ConcCharge object

The ConcCharge object stores the data for a concentrated charge.
Access

import load mdb.models[name].loads[name]

23.14.1

ConcCharge(...)

This method creates a ConcCharge object.
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 argument

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 ConcentratedCharge object.
Exceptions

None.

23–26

ConcCharge object

23.14.2

setValues(...)

This method modifies the data for an existing ConcCharge 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 ConcCharge method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

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

23–27

ConcentratedChargeState object

Exceptions

None.

23.14.4
name

Members

The ConcCharge object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.15

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 ConcentratedCharge object for each step. The instance is also deleted internally by the ConcentratedCharge object. The ConcentratedChargeState object has no constructor or methods.
Access

import load mdb.models[name].steps[name].loadStates[name]

23.15.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–28

ConcConcFlux object

• • • • • • • • •
23.15.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CECHARGE

23.16

ConcConcFlux object

The ConcConcFlux object stores the data for a concentrated concentration flux.
Access

import load mdb.models[name].loads[name]

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

23–29

ConcConcFlux object

Optional argument

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.

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

23.16.3

setValuesInStep(...)

This method modifies the propagating data for an existing ConcConcFlux object in the specified step.
Arguments Required argument

stepName A String specifying the name of the step in which the load is modified.

23–30

ConcentratedConcentrationFluxState object

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.

23.16.4
name

Members

The ConcConcFlux object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.17

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 ConcentratedConcentrationFlux object for each step. The instance is also deleted internally by the ConcentratedConcentrationFlux object. The ConcentratedConcentrationFluxState object has no constructor or methods.
Access

import load mdb.models[name].steps[name].loadStates[name]

23.17.1

Members

The ConcentratedConcentrationFluxState object has the following members:

23–31

ConcCurrent object

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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.17.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CFLUX (degree of freedom: 11, which is assumed)

23.18

ConcCurrent object

The ConcCurrent object stores the data for a concentrated current.
Access

import load mdb.models[name].loads[name]

23.18.1

ConcCurrent(...)

This method creates a ConcCurrent object.

23–32

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 argument

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

None.

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

23–33

ConcCurrent object

Exceptions

None.

23.18.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.
Return value

None
Exceptions

None.

23.18.4
name

Members

The ConcCurrent object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23–34

ConcCurrentState object

23.19

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

import load mdb.models[name].steps[name].loadStates[name]

23.19.1

Members

The ConcCurrentState 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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–35

ConcPoreFluid object

23.19.2

Corresponding analysis keywords

*CECURRENT

23.20

ConcPoreFluid object

The ConcPoreFluid object stores the data for a concentrated pore fluid flow load.
Access

import load mdb.models[name].loads[name]

23.20.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. magnitude A Float specifying the load magnitude.
Optional argument

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.

23–36

ConcPoreFluid object

Exceptions

None.

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

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

23–37

ConcentratedPoreFluidState object

Return value

None
Exceptions

None.

23.20.4
name

Members

The ConcPoreFluid object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.21

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 ConcentratedPoreFluid object for each step. The instance is also deleted internally by the ConcentratedPoreFluid object. The ConcentratedPoreFluidState object has no constructor or methods.
Access

import load mdb.models[name].steps[name].loadStates[name]

23.21.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

23–38

ConcentratedForce object

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

• • • • • • • • •
23.21.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CLOAD (degree of freedom: 8)

23.22

ConcentratedForce object

The ConcentratedForce object defines a concentrated force.
Access

import load mdb.models[name].loads[name]

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

23–39

ConcentratedForce object

region A Region object specifying the region to which the load is applied.
Optional arguments

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. The default value is OFF. You should provide the follower argument only if it is valid for the specified step. 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. When this member is queried, it returns an Int.
Return value

A ConcentratedForce object.
Exceptions

None.

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

23–40

ConcentratedForce object

Return value

None
Exceptions

None.

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

23–41

ConcentratedForceState object

Exceptions

None.

23.22.4

Members

The ConcentratedForce object can have the following members: follower A Boolean specifying whether the direction of the force rotates with the rotation at each node of the region. The default value is OFF. You should provide the follower argument only if it is valid for the specified step. 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. When this member is queried, it returns an Int. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.23

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

import load mdb.models[name].steps[name].loadStates[name]

23.23.1
cf1

Members

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

23–42

ConcentratedHeatFlux object

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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.23.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CLOAD (degree of freedom: 1, 2, or 3)

23.24

ConcentratedHeatFlux object

The ConcentratedHeatFlux object stores the data for a concentrated heat flux load.

23–43

ConcentratedHeatFlux object

Access

import load mdb.models[name].loads[name]

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

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.

23–44

ConcentratedHeatFlux object

23.24.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 ConcentratedHeatFlux method, except for the name and createStepName arguments.
Return value

to

the

None
Exceptions

None.

23.24.3

setValuesInStep(...)

This method modifies the propagating data for an existing ConcentratedHeatFlux 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

23–45

ConcentratedHeatFluxState object

Exceptions

None.

23.24.4
dof

Members

The ConcentratedHeatFlux object can have the following members: An Int specifying the degree of freedom of the node, to which the concentrated heat flux should be applied. The default value is 11. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.25

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

import load mdb.models[name].steps[name].loadStates[name]

23.25.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

23–46

ConnectorForce object

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

• • • • • • • • •
23.25.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CFLUX (degree of freedom: one out of integers 11 to 31)

23.26

ConnectorForce object

The ConnectorForce object defines a connector force.
Access

import load mdb.models[name].loads[name]

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

23–47

ConnectorForce object

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

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

23–48

ConnectorForce object

Exceptions

None.

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

23–49

ConnectorForceState object

23.26.4

Members

The ConnectorForce object can have the following members: connectors A sequence of Strings specifying the names of the connectors to which the load is applied. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.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.
Access

import load mdb.models[name].steps[name].loadStates[name]

23.27.1
f1

Members

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

23–50

ConnectorMoment object

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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.27.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CONNECTOR LOAD (degree of freedom: 1, 2, or 3)

23.28

ConnectorMoment object

The ConnectorMoment object stores the data for a connector moment.
Access

import load mdb.models[name].loads[name]

23–51

ConnectorMoment object

23.28.1

ConnectorMoment(...)

This method creates a ConnectorMoment object.
Path

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

23.28.2

setValues(...)

This method modifies the data for an existing ConnectorMoment object in the step where it is created.
Arguments Required arguments

None.

23–52

ConnectorMoment object

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

None
Exceptions

None.

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

23–53

ConnectorMomentState object

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.

23.28.4

Members

The ConnectorMoment object can have the following members: connectors A sequence of Strings specifying the names of the connectors which the load is applied. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.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.
Access

import load mdb.models[name].steps[name].loadStates[name]

23.29.1
m1

Members

The ConnectorMomentState object has the following members: A Float or a Complex specifying the connector moment component in the connector’s local 4direction. Although m1, m2, and m3 are optional arguments, at least one of them must be nonzero.

23–54

ConnectorMomentState object

m2 A Float or a Complex specifying the connector moment component in the connector’s local 5direction. m3 A Float or a Complex specifying the connector moment component in the connector’s local 6direction. 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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.29.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CONNECTOR LOAD (degree of freedom: 4, 5, or 6)

23–55

Gravity object

23.30

Gravity object

The Gravity object stores the data of a gravity load.
Access

import load mdb.models[name].loads[name]

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

region A Region object specifying the region to which the load is applied. 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.

23–56

Gravity object

Return value

A Gravity object.
Exceptions

None.

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

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

23–57

GravityState object

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.

23.30.4
name

Members

The Gravity object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.31

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

import load mdb.models[name].steps[name].loadStates[name]

23–58

GravityState object

23.31.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. comp3State A SymbolicConstant specifying the propagation state of the load component in the 3-direction. Possible values are UNSET, SET, UNCHANGED, and FREED. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.31.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DLOAD (load type label:GRAV)

23–59

HydrostaticFluidFlowState object

23.32

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

import load mdb.models[name].steps[name].loadStates[name]

23.32.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–60

InertiaRelief object

23.32.2

Corresponding analysis keywords

*FLUID FLUX

23.33

InertiaRelief object

The InertiaRelief object defines an inertia relief load.
Access

import load mdb.models[name].loads[name]

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

23–61

InertiaRelief object

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 A DatumCsys object specifying the local coordinate system of the rigid body degrees of freedom for the inertia relief load. The default value is None, indicating that the free directions are defined in the global coordinate system. When this member is queried, it returns an Int.
Return value

An InertiaRelief object.
Exceptions

None.

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

23.33.3

setValuesInStep(...)

This method modifies the propagating data for an existing InertiaRelief object in the specified step.

23–62

InertiaRelief object

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:

• • •
fixed

The X, Y and Z-coordinates of a fixed rotation point. A point on the rotation axis. A point on the symmetry line.

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.

23.33.4

Members

The InertiaRelief object can have the following members:

23–63

InertiaReliefState object

localCoordinates A DatumCsys object specifying the local coordinate system of the rigid body degrees of freedom for the inertia relief load. The default value is None, indicating that the free directions are defined in the global coordinate system. When this member is queried, it returns an Int. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.34

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

import load mdb.models[name].steps[name].loadStates[name]

23.34.1
u1

Members

The InertiaReliefState object has the following members: 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. u1State A SymbolicConstant specifying the propagation state of the Boolean that identifies the local 1direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

23–64

InertiaReliefState object

u2State A SymbolicConstant specifying the propagation state of the Boolean that identifies the local 2direction 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. 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.

referencePointState A SymbolicConstant specifying the propagation state of the reference point of the inertia relief load. Possible values are UNSET, SET, UNCHANGED, and MODIFIED. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

23–65

InwardVolAccel object

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

• • • • • • • • •
23.34.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*INERTIA RELIEF

23.35

InwardVolAccel object

The InwardVolAccel object stores the data for an inward volume acceleration accoustic load.
Access

import load mdb.models[name].loads[name]

23.35.1

InwardVolAccel(...)

This method creates a InwardVolAccel object.
Path

mdb.models[name].InwardVolAccel
Required arguments

name A String specifying the load repository key.

23–66

InwardVolAccel object

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 argument

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 InwardVolAccel object.
Exceptions

None.

23.35.2

setValues(...)

This method modifies the data for an existing InwardVolAccel 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 InwardVolAccel method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

23–67

InwardVolAccelState object

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

23.35.4
name

Members

The InwardVolAccel object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.36

InwardVolAccelState object

The InwardVolAccelState object stores the propagating data of an inward volume acceleration accoustic 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.

23–68

LineLoad object

Access

import load mdb.models[name].steps[name].loadStates[name]

23.36.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.36.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CLOAD (degree of freedom: 8)

23.37

LineLoad object

The LineLoad object stores the data of an applied line load.

23–69

LineLoad object

Access

import load mdb.models[name].loads[name]

23.37.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. region A Region object specifying the region to which the load is applied.
Optional arguments

comp1 A Float or a Complex specifying the component of the load in the global or the beam local 1direction. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero unless distribution=USER_DEFINED. comp2 A Float or a Complex specifying the component of the load in the global or the beam local 2direction. 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. distribution A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

23–70

LineLoad object

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.

23.37.2

setValues(...)

This method modifies the data for an existing LineLoad 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 LineLoad method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

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

23–71

LineLoad object

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

23.37.4

Members

The LineLoad object can have the following members: distribution A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM and USER_DEFINED. 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. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23–72

LineLoadState object

23.38

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

import load mdb.models[name].steps[name].loadStates[name]

23.38.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–73

LoadState object

• • • • • • • •
23.38.2

CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DLOAD (load type label: PX, PY, PZ for a global reference frame, and P1, P2 for a local reference frame)

23.39

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]

23.39.1

Members

The LoadState object has the following members: amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–74

Moment object

• • • • • •
23.40

MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE

Moment object

The Moment object stores the data for a moment.
Access

import load mdb.models[name].loads[name]

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

23–75

Moment object

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. follower A Boolean specifying whether the direction of the force rotates with the rotation of the node. The default value is OFF. You should provide the follower argument only if it is valid for the specified step. localCsys A DatumCsys object specifying the ID of the Datum coordinate system used as the local coordinate system of the load. The default value is 0, specifying that the load is defined in the global coordinate system. When this member is queried, it returns an Int.
Return value

A Moment object.
Exceptions

None.

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

23–76

Moment object

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

23.40.4

Members

The Moment object can have the following members:

23–77

MomentState object

follower A Boolean specifying whether the direction of the force rotates with the rotation of the node. The default value is OFF. You should provide the follower argument only if it is valid for the specified step. localCsys A DatumCsys object specifying the ID of the Datum coordinate system used as the local coordinate system of the load. The default value is 0, specifying that the load is defined in the global coordinate system. When this member is queried, it returns an Int. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.41

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

import load mdb.models[name].steps[name].loadStates[name]

23.41.1
cm1

Members

The MomentState object has the following members: 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. cm1State A SymbolicConstant specifying the propagation state of the load component in the 4-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

23–78

PEGLoad object

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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.41.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CLOAD (degree of freedom: 4, 5, or 6)

23.42

PEGLoad object

The PEGLoad object stores the data for a PEG load.
Access

import load mdb.models[name].loads[name]

23–79

PEGLoad object

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

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.
Return value

A PEGLoad object.
Exceptions

None.

23.42.2

setValues(...)

This method modifies the data for an existing PEGLoad object in the step where it is created.

23–80

PEGLoad object

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.

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

23–81

PEGLoadState object

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.

23.42.4
name

Members

The PEGLoad object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.43

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. The PEGLoadState object has no constructor or methods.
Access

import load mdb.models[name].steps[name].loadStates[name]

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

23–82

PipePressure object

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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.43.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*CLOAD (degree of freedom: 1 or 2)

23.44

PipePressure object

The PipePressure object stores the data for a pressure applied to pipe or elbow elements.
Access

import load mdb.models[name].loads[name]

23–83

PipePressure object

23.44.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 distribution=USER_DEFINED. diameter A Float specifying the effective inner or outer diameter. hZero A Float specifying the height of the zero pressure level when distribution=HYDROSTATIC. hReference A Float specifying the height of the reference pressure level when distribution=HYDROSTATIC.
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. distribution A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, HYDROSTATIC, and USER_DEFINED. 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. endCondition A SymbolicConstant specifying end loading condition. Possible values are CLOSED and OPEN. The default value is CLOSED.

23–84

PipePressure object

Return value

A PipePressure object.
Exceptions

None.

23.44.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.
Return value

None
Exceptions

None.

23.44.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 distribution=HYDROSTATIC.

23–85

PipePressure object

hReference A Float specifying the height of the reference pressure level when distribution=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.

23.44.4

Members

The PipePressure object can have the following members: distribution A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, HYDROSTATIC, and USER_DEFINED. 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. endCondition A SymbolicConstant specifying end loading condition. Possible values are CLOSED and OPEN. The default value is CLOSED. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23–86

PipePressureState object

23.45

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

import load mdb.models[name].steps[name].loadStates[name]

23.45.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. hZero A Float specifying the height of the zero pressure level when the pipe pressure distribution=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 distribution=HYDROSTATIC. hReferenceState A SymbolicConstant specifying the propagation state of hReference. Possible values are UNSET, SET, UNCHANGED, and FREED. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. amplitudeState A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

23–87

Pressure object

status A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are

• • • • • • • • •
23.45.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DSLOAD

23.46

Pressure object

The Pressure object defines a pressure load.
Access

import load mdb.models[name].loads[name]

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

23–88

Pressure object

magnitude A Float or a Complex specifying the pressure magnitude. Note: magnitude is optional if distribution=USER_DEFINED. hZero A Float specifying the height of the zero pressure level when distribution=HYDROSTATIC. hReference A Float specifying the height of the reference pressure level when distribution=HYDROSTATIC.
Optional arguments

distribution A SymbolicConstant specifying how the pressure is distributed spatially. Possible values are UNIFORM and USER_DEFINED. 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.

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

23–89

Pressure object

Exceptions

None.

23.46.3

setValuesInStep(...)

This method modifies the propagating data for an existing Pressure 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 or a Complex specifying the pressure magnitude. hZero A Float specifying the height of the zero pressure level when distribution=HYDROSTATIC. hReference A Float specifying the height of the reference pressure level when distribution=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.

23.46.4

Members

The Pressure object can have the following members: distribution A SymbolicConstant specifying how the pressure is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

23–90

PressureState object

name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.47

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.

Access

import load mdb.models[name].steps[name].loadStates[name]

23.47.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 distribution=HYDROSTATIC. of the zero pressure level when the pressure

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 distribution=HYDROSTATIC. hReferenceState A SymbolicConstant specifying the propagation state of hReference. Possible values are UNSET, SET, UNCHANGED, and FREED.

23–91

RotationalBodyForce object

amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.47.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DSLOAD

23.48

RotationalBodyForce object

The RotationalBodyForce object stores the data for a rotational body force.
Access

import load mdb.models[name].loads[name]

23.48.1

RotationalBodyForce(...)

This method creates a RotationalBodyForce object.
Path

mdb.models[name].RotationalBodyForce

23–92

RotationalBodyForce object

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. 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 valueON. rotaryAcceleration A Boolean specifying whether or not the effect of the load is rotary acceleration. The default value is OFF. Note: At least one of centrifugal or rotaryAcceleration must be specified and only one must have the valueON. 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 argument

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.

23–93

RotationalBodyForce object

23.48.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 RotationalBodyForce method, except for the name and createStepName arguments.
Return value

to

the

None
Exceptions

None.

23.48.3

setValuesInStep(...)

This method modifies the propagating data for an existing RotationalBodyForce 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

23–94

RotationalBodyForceState object

Exceptions

None.

23.48.4

Members

The RotationalBodyForce object can have the following members: 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 valueON. rotaryAcceleration A Boolean specifying whether or not the effect of the load is rotary acceleration. The default value is OFF. Note: At least one of centrifugal or rotaryAcceleration must be specified and only one must have the valueON. 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. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.49

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

import load mdb.models[name].steps[name].loadStates[name]

23–95

ShellEdgeLoad object

23.49.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.49.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DLOAD (load type labels: CENTRIF, ROTA)

23.50

ShellEdgeLoad object

The ShellEdgeLoad object defines shell edge loads on a region.
Access

import load mdb.models[name].loads[name]

23–96

ShellEdgeLoad object

23.50.1

ShellEdgeLoad(...)

This method creates a ShellEdgeLoad object.
Path

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

23–97

ShellEdgeLoad object

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

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

23–98

ShellEdgeLoadState object

23.50.3

setValuesInStep(...)

This method modifies the propagating data for an existing ShellEdgeLoad 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.
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.

23.50.4
name

Members

The ShellEdgeLoad object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.51

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.

23–99

ShellEdgeLoadState object

The ShellEdgeLoadState object has no constructor or methods.

Access

import load mdb.models[name].steps[name].loadStates[name]

23.51.1

Members

The ShellEdgeLoadState object has the following members: magnitude A Float or Complex specifying the load magnitude. magnitudeState A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and MODIFIED. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.51.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DSLOAD

23–100

SurfaceCharge object

23.52

SurfaceCharge object

The SurfaceCharge object stores the data for a surface charge.
Access

import load mdb.models[name].loads[name]

23.52.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 argument

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.

23–101

SurfaceCharge object

23.52.2

setValues(...)

This method modifies the data for an existing SurfaceCharge 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 SurfaceCharge method, except for the name and createStepName arguments.
Return value

None
Exceptions

None.

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

23–102

SurfaceChargeState object

Exceptions

None.

23.52.4
name

Members

The SurfaceCharge object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.53

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

import load mdb.models[name].steps[name].loadStates[name]

23.53.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–103

SurfaceConcentrationFlux object

• • • • • • • • •
23.53.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DSECHARGE (load type label: ES)

23.54

SurfaceConcentrationFlux object

The SurfaceConcentrationFlux object defines surface concentration flux from a region or into a region.
Access

import load mdb.models[name].loads[name]

23.54.1

SurfaceConcentrationFlux(...)

This method creates a SurfaceConcentrationFlux object.
Path

mdb.models[name].SurfaceConcentrationFlux
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 distribution=USER_DEFINED.

23–104

SurfaceConcentrationFlux object

Optional arguments

distribution A SymbolicConstant specifying how the surface heat flux is distributed spatially. Possible values are UNIFORM and USER_DEFINED. 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.

23.54.2

setValues(...)

This method modifies the data for an existing SurfaceConcentrationFlux object in the step where it is created.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same SurfaceConcentrationFlux method, except for the arguments.
Return value

as the arguments to the name and createStepName

None
Exceptions

None.

23.54.3

setValuesInStep(...)

This method modifies the propagating data for an existing SurfaceConcentrationFlux object in the specified step.

23–105

SurfaceConcentrationFluxState object

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.

23.54.4

Members

The SurfaceConcentrationFlux object can have the following members: distribution A SymbolicConstant specifying how the surface heat flux is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.55

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.

23–106

SurfaceCurrent object

Access

import load mdb.models[name].steps[name].loadStates[name]

23.55.1

Members

The SurfaceConcentrationFluxState 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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.55.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DSFLUX

23.56

SurfaceCurrent object

The SurfaceCurrent object stores the data for a surface current.

23–107

SurfaceCurrent object

Access

import load mdb.models[name].loads[name]

23.56.1

SurfaceCurrent(...)

This method creates a SurfaceCurrent object.
Path

mdb.models[name].SurfaceCurrent
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 argument

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.

23.56.2

setValues(...)

This method modifies the data for an existing SurfaceCurrent object in the step where it is created.

23–108

SurfaceCurrent object

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
Exceptions

None.

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

23–109

SurfaceCurrentState object

23.56.4
name

Members

The SurfaceCurrent object can have the following members: A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.57

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

import load mdb.models[name].steps[name].loadStates[name]

23.57.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–110

SurfaceHeatFlux object

• • • • • •
23.57.2

MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DSECURRENT (load type label: CS

23.58

SurfaceHeatFlux object

The SurfaceHeatFlux object defines surface heat flux from a region or into a region.
Access

import load mdb.models[name].loads[name]

23.58.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. distribution=USER_DEFINED. magnitude is optional if

23–111

SurfaceHeatFlux object

Optional arguments

distribution A SymbolicConstant specifying how the surface heat flux is distributed spatially. Possible values are UNIFORM and USER_DEFINED. 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.

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

23.58.3

setValuesInStep(...)

This method modifies the propagating data for an existing SurfaceHeatFlux object in the specified step.

23–112

SurfaceHeatFluxState object

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.

23.58.4

Members

The SurfaceHeatFlux object can have the following members: distribution A SymbolicConstant specifying how the surface heat flux is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.59

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.

23–113

SurfacePoreFluid object

Access

import load mdb.models[name].steps[name].loadStates[name]

23.59.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

• • • • • • • • •
23.59.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DSFLUX

23.60

SurfacePoreFluid object

The SurfacePoreFluid object defines surface pore fluid flow from a region or into a region.

23–114

SurfacePoreFluid object

Access

import load mdb.models[name].loads[name]

23.60.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. distribution=USER_DEFINED.
Optional arguments

magnitude is optional if

distribution A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM and USER_DEFINED. 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.

23–115

SurfacePoreFluid object

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

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

23–116

SurfacePoreFluidState object

Exceptions

None.

23.60.4

Members

The SurfacePoreFluid object can have the following members: distribution A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.61

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

import load mdb.models[name].steps[name].loadStates[name]

23.61.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. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

23–117

SurfaceTraction object

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

• • • • • • • • •
23.61.2

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DSFLOW

23.62

SurfaceTraction object

The SurfaceTraction object defines surface traction on a region.
Access

import load mdb.models[name].loads[name]

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

23–118

SurfaceTraction object

region A Region object specifying the region to which the load is applied. magnitude A Float or Complex 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. angle A Float specifying an additional rotation of directionVector about an axis. The default value is 0. 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. 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. 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. 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 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.

23–119

SurfaceTraction object

Return value

A SurfaceTraction object.
Exceptions

None.

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

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

23–120

SurfaceTraction object

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.

23.62.4
angle

Members

The SurfaceTraction object can have the following members: A Float specifying an additional rotation of directionVector about an axis. The default value is 0. 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. 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. 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 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.

23–121

SurfaceTractionState object

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. When this member is queried, it returns an Int. name A String specifying the load repository key. region A Region object specifying the region to which the load is applied.

23.63

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

import load mdb.models[name].steps[name].loadStates[name]

23.63.1

Members

The SurfaceTractionState object has the following members: magnitude A Float or Complex specifying the load magnitude. magnitudeState A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and MODIFIED. amplitude A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. 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

23–122

SurfaceTractionState object

• • • • • • •
23.63.2

PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE BUILT_INTO_BASE_STATE
Corresponding analysis keywords

*DSLOAD

23–123

LoadCase object

24.

Load Case commands
Load Case commands are used for configuring load cases in specific types of steps that may use them.

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

24.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 SymbolicConstant, NONE, or a sequence of sequences each containing a String specifying the name of a BoundaryCondition followed by a nonzero Float specifying a scale factor. The default value is NONE. loads A SymbolicConstant, NONE, or a sequence of sequences each containing a String specifying the name of a Load followed by a nonzero Float specifying a scale factor. The default value is NONE. includeActiveBaseStateBC A Boolean that determines whether to include all active boundary conditions propagated or modified from the base state. The default value is ON.
Return value

A LoadCase object.

24–1

LoadCase object

Exceptions

RangeError.

24.1.2

setValues(...)

This method modifies the LoadCase object.
Arguments Required arguments

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

24.1.3

Members

The LoadCase object has members with the same names and descriptions as the arguments to the LoadCase method.

24–2

Material object

25.

Material commands
The Material commands are used to define the materials in a model.

25.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.
Access

import material mdb.models[name].materials[name] import odbMaterial session.odbs[name].materials[name]

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

None.
Return value

A Material object.
Exceptions

InvalidNameError.

25–1

Material object

25.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 ofMaterial objects.
Exceptions

None.

25.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. capPlasticity A CapPlasticity object. castIronPlasticity A CastIronPlasticity object. clayPlasticity A ClayPlasticity object. concrete A Concrete object. concreteDamagedPlasticity A ConcreteDamagedPlasticity object. conductivity A Conductivity object.

25–2

Material object

creep A Creep object. crushableFoam A CrushableFoam 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. gasketThicknessBehavior A GasketThicknessBehavior object. gasketTransverseShearElastic A GasketTransverseShearElastic object. gasketMembraneElastic A GasketMembraneElastic object. gel A Gel object. heatGeneration A HeatGeneration object. hyperelastic A Hyperelastic object.

25–3

Material object

hyperfoam A Hyperfoam object. hypoelastic A Hypoelastic object. inelasticHeatFraction An InelasticHeatFraction object. jouleHeatFraction A JouleHeatFraction object. latentHeat A LatentHeat object. mohrCoulombPlasticity A MohrCoulombPlasticity object. moistureSwelling A MoistureSwelling 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. solubility A Solubility object. sorption A Sorption object. specificHeat A SpecificHeat object. swelling A Swelling object.

25–4

AcousticMedium object

userDefinedField A UserDefinedField object. userMaterial A UserMaterial object. userOutputVariables A UserOutputVariables object. viscoelastic A Viscoelastic object. viscous A Viscous object.
25.1.4 Corresponding analysis keywords

*MATERIAL

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

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

25–5

AcousticMedium object

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

25–6

AnnealTemperature object

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

25.2.3

Members

The AcousticMedium object has members with the same names and descriptions as the arguments to the AcousticMedium method.
25.2.4 Corresponding analysis keywords

*ACOUSTIC MEDIUM

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

25.3.1

AnnealTemperature(...)

This method creates an AnnealTemperature object.

25–7

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

RangeError.

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

25–8

BiaxialTestData object

Return value

None
Exceptions

RangeError.

25.3.3

Members

The AnnealTemperature object has members with the same names and descriptions as the arguments to the AnnealTemperature method.
25.3.4 Corresponding analysis keywords

*ANNEAL TEMPERATURE

25.4

BiaxialTestData object

The BiaxialTestData object provides equibiaxial test data (compression and/or tension).
Access

import material mdb.models[name].materials[name].hyperelastic.biaxialTestData mdb.models[name].materials[name].hyperfoam.biaxialTestData import odbMaterial session.odbs[name].materials[name].hyperelastic.biaxialTestData session.odbs[name].materials[name].hyperfoam.biaxialTestData

25.4.1

BiaxialTestData(...)

This method creates a BiaxialTestData object.
Path

mdb.models[name].materials[name].hyperelastic.BiaxialTestData mdb.models[name].materials[name].hyperfoam.BiaxialTestData session.odbs[name].materials[name].hyperelastic.BiaxialTestData session.odbs[name].materials[name].hyperfoam.BiaxialTestData

25–9

BiaxialTestData object

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. The default value is None, for no smoothing. 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.
Return value

A BiaxialTestData object.
Exceptions

None.

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

25–10

CapCreepCohesion object

25.4.3

Members

The BiaxialTestData object has members with the same names and descriptions as the arguments to the BiaxialTestData method.
25.4.4 Corresponding analysis keywords

*BIAXIAL TEST DATA

25.5

CapCreepCohesion object

The CapCreepCohesion object specifies a cap creep model and material properties.
Access

import material mdb.models[name].materials[name].capPlasticity.capCreepCohesion import odbMaterial session.odbs[name].materials[name].capPlasticity.capCreepCohesion

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

25–11

CapCreepCohesion object

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

Return value

A CapCreepCohesion object.
Exceptions

None.

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

25–12

CapCreepConsolidation object

Return value

None
Exceptions

None.

25.5.3

Members

The CapCreepCohesion object has members with the same names and descriptions as the arguments to the CapCreepCohesion method.
25.5.4 Corresponding analysis keywords

*CAP CREEP

25.6

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

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

25–13

CapCreepConsolidation object

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

Return value

A CapCreepConsolidation object.
Exceptions

None.

25.6.2

setValues(...)

This method modifies the CapCreepConsolidation object.

25–14

CapHardening object

Arguments Required arguments None. Optional arguments

The optional arguments to setValues CapCreepConsolidation method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

None.

25.6.3

Members

The CapCreepConsolidation object has members with the same names and descriptions as the arguments to the CapCreepConsolidation method.
25.6.4 Corresponding analysis keywords

*CAP CREEP

25.7

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

25.7.1

CapHardening(...)

This method creates a CapHardening object.
Path

mdb.models[name].materials[name].capPlasticity.CapHardening

25–15

CapHardening object

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

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

25–16

CapPlasticity object

Exceptions

RangeError.

25.7.3

Members

The CapHardening object has members with the same names and descriptions as the arguments to the CapHardening method.
25.7.4 Corresponding analysis keywords

*CAP HARDENING

25.8

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

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

25–17

CapPlasticity object

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

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

25–18

CastIronCompressionHardening object

25.8.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. capCreepConsolidation A CapCreepConsolidation object. capHardening A CapHardening object.
25.8.4 Corresponding analysis keywords

*CAP PLASTICITY

25.9

CastIronCompressionHardening object

The CastIronCompressionHardening object specifies hardening for the Cast- Iron plasticity model.
Access

import material mdb.models[name].materials[name].castIronPlasticity.castIronCompressionHardenin import odbMaterial session.odbs[name].materials[name].castIronPlasticity.castIronCompressionHarden

25.9.1

CastIronCompressionHardening(...)

This method creates a CastIronCompressionHardening object.
Path

mdb.models[name].materials[name].castIronPlasticity.CastIronCompressionHardenin session.odbs[name].materials[name].castIronPlasticity.CastIronCompressionHarden
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.

25–19

CastIronCompressionHardening object

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.

25.9.2

setValues(...)

This method modifies the CastIronCompressionHardening object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are CastIronCompressionHardening method.
Return value

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.9.3

Members

The CastIronCompressionHardening object has members with the same names and descriptions as the arguments to the CastIronCompressionHardening method.

25–20

CastIronPlasticity object

25.9.4

Corresponding analysis keywords

*CAST IRON COMPRESSION HARDENING

25.10

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

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

25–21

CastIronPlasticity object

Return value

A CastIronPlasticity object.
Exceptions

RangeError.

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

25.10.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. castIronCompressionHardening A CastIronCompressionHardening object.
25.10.4 Corresponding analysis keywords

*CAST IRON PLASTICITY

25–22

CastIronTensionHardening object

25.11

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

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

25–23

ClayHardening object

Exceptions

RangeError.

25.11.2

setValues(...)

This method modifies the CastIronTensionHardening object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues CastIronTensionHardening method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.11.3

Members

The CastIronTensionHardening object has members with the same names and descriptions as the arguments to the CastIronTensionHardening method.
25.11.4 Corresponding analysis keywords

*CAST IRON TENSION HARDENING

25.12

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

25–24

ClayHardening object

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

25.12.2

setValues(...)

This method modifies the ClayHardening object.
Arguments Required arguments

None.

25–25

ClayPlasticity object

Optional arguments

The optional arguments to setValues are the same as the arguments to the ClayHardening method.
Return value

None
Exceptions

RangeError.

25.12.3

Members

The ClayHardening object has members with the same names and descriptions as the arguments to the ClayHardening method.
25.12.4 Corresponding analysis keywords

*CLAY HARDENING

25.13

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

25.13.1

ClayPlasticity(...)

This method creates a ClayPlasticity object.
Path

mdb.models[name].materials[name].ClayPlasticity session.odbs[name].materials[name].ClayPlasticity
Required 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.

25–26

ClayPlasticity object

This argument is valid only if hardening=EXPONENTIAL. 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 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.
Table data

If hardening=EXPONENTIAL, the table data specify the following:

• • • • • • • • • • • • • • • • •

Logarithmic plastic bulk modulus, Stress ratio at critical state, The initial yield surface size, . .

(dimensionless).

, 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, . , corresponding to according to the ClayHardening The initial volumetric plastic strain, 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.

25–27

CombinedTestData object

Return value

A ClayPlasticity object.
Exceptions

RangeError.

25.13.2

setValues(...)

This method modifies the ClayPlasticity object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the ClayPlasticity method.
Return value

None
Exceptions

RangeError.

25.13.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.
25.13.4 Corresponding analysis keywords

*CLAY PLASTICITY

25.14

CombinedTestData object

The CombinedTestData object specifies simultaneously the normalized shear and bulk compliances or relaxation moduli as functions of time.

25–28

CombinedTestData object

Access

import material mdb.models[name].materials[name].viscoelastic.combinedTestData import odbMaterial session.odbs[name].materials[name].viscoelastic.combinedTestData

25.14.1

CombinedTestData(...)

This method creates a CombinedTestData object.
Path

mdb.models[name].materials[name].viscoelastic.CombinedTestData session.odbs[name].materials[name].viscoelastic.CombinedTestData
Required 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. 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. 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 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

None. Table data If time=RELAXATION_TEST_DATA, the table data specify the following:

• • •

Normalized shear modulus, Normalized volumetric (bulk) modulus, Time .

. .

25–29

CombinedTestData object

If time=CREEP_TEST_DATA, the table data specify the following:

• • •

Normalized shear compliance, Normalized volumetric (bulk) compliance, Time .

. .

Return value

A CombinedTestData object.
Exceptions

None.

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

25.14.3

Members

The CombinedTestData object has members with the same names and descriptions as the arguments to the CombinedTestData method.
25.14.4 Corresponding analysis keywords

*COMBINED TEST DATA

25–30

Concrete object

25.15

Concrete object

The Concrete object defines concrete properties beyond the elastic range.
Access

import material mdb.models[name].materials[name].concrete import odbMaterial session.odbs[name].materials[name].concrete

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

25–31

ConcreteCompressionDamage object

Exceptions

RangeError.

25.15.2

setValues(...)

This method modifies the Concrete object.
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.

25.15.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.
25.15.4 Corresponding analysis keywords

*CONCRETE

25.16

ConcreteCompressionDamage object

The ConcreteCompressionDamage obje7ct specifies hardening for the concrete damaged plasticity model.

25–32

ConcreteCompressionDamage object

Access

import material mdb.models[name].materials[name].concreteDamagedPlasticity.concreteCompressionD import odbMaterial session.odbs[name].materials[name].concreteDamagedPlasticity.concreteCompressio

25.16.1

ConcreteCompressionDamage(...)

This method creates a ConcreteCompressionDamage object.
Path

mdb.models[name].materials[name].concreteDamagedPlasticity.ConcreteCompressionD session.odbs[name].materials[name].concreteDamagedPlasticity.ConcreteCompressio
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.

25–33

ConcreteCompressionHardening object

Exceptions

RangeError.

25.16.2

setValues(...)

This method modifies the ConcreteCompressionDamage object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues ConcreteCompressionDamage method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.16.3

Members

The ConcreteCompressionDamage object has members with the same names and descriptions as the arguments to the ConcreteCompressionDamage method.
25.16.4 Corresponding analysis keywords

*CONCRETE COMPRESSION DAMAGE

25.17

ConcreteCompressionHardening object

The ConcreteCompressionHardening object specifies hardening for the concrete damaged plasticity model.
Access

import material mdb.models[name].materials[name].concreteDamagedPlasticity.concreteCompressionH import odbMaterial

25–34

ConcreteCompressionHardening object

session.odbs[name].materials[name].concreteDamagedPlasticity.concreteCompressio

25.17.1

ConcreteCompressionHardening(...)

This method creates a ConcreteCompressionHardening object.
Path

mdb.models[name].materials[name].concreteDamagedPlasticity.ConcreteCompressionH session.odbs[name].materials[name].concreteDamagedPlasticity.ConcreteCompressio
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.

Return value

A ConcreteCompressionHardening object.
Exceptions

RangeError.

25.17.2

setValues(...)

This method modifies the ConcreteCompressionHardening object.

25–35

ConcreteDamagedPlasticity object

Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are ConcreteCompressionHardening method.
Return value

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.17.3

Members

The ConcreteCompressionHardening object has members with the same names and descriptions as the arguments to the ConcreteCompressionHardening method.
25.17.4 Corresponding analysis keywords

*CONCRETE COMPRESSION HARDENING

25.18

ConcreteDamagedPlasticity object

The ConcreteDamagedPlasticity object specifies the concrete damaged plasticity model.
Access

import material mdb.models[name].materials[name].concreteDamagedPlasticity import odbMaterial session.odbs[name].materials[name].concreteDamagedPlasticity

25.18.1

ConcreteDamagedPlasticity(...)

This method creates a ConcreteDamagedPlasticity object.
Path

mdb.models[name].materials[name].ConcreteDamagedPlasticity

25–36

ConcreteDamagedPlasticity object

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 inital 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. Etc.

Return value

A ConcreteDamagedPlasticity object.
Exceptions

RangeError.

25.18.2

setValues(...)

This method modifies the ConcreteDamagedPlasticity object.

25–37

ConcreteTensionDamage object

Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues ConcreteDamagedPlasticity method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.18.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.
25.18.4 Corresponding analysis keywords

*CONCRETE DAMAGED PLASTICITY

25.19

ConcreteTensionDamage object

The ConcreteTensionDamage object specifies hardening for the concrete damaged plasticity model.
Access

import material mdb.models[name].materials[name].concreteDamagedPlasticity.concreteTensionDamag

25–38

ConcreteTensionDamage object

import odbMaterial session.odbs[name].materials[name].concreteDamagedPlasticity.concreteTensionDam

25.19.1

ConcreteTensionDamage(...)

This method creates a ConcreteTensionDamage object.
Path

mdb.models[name].materials[name].concreteDamagedPlasticity.ConcreteTensionDamag session.odbs[name].materials[name].concreteDamagedPlasticity.ConcreteTensionDam
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. type A SymbolicConstant specifying the type of tensile damage data. Possible values are STRAIN and DISPLACEMENT. 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. 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. Tensile damage variable, .

If type=DISPLACEMENT, the table data specify the following:

25–39

ConcreteTensionDamage object

• • • • •

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.

25.19.2

setValues(...)

This method modifies the ConcreteTensionDamage object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues ConcreteTensionDamage method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.19.3

Members

The ConcreteTensionDamage object has members with the same names and descriptions as the arguments to the ConcreteTensionDamage method.
25.19.4 Corresponding analysis keywords

*CONCRETE TENSION DAMAGE

25–40

ConcreteTensionStiffening object

25.20

ConcreteTensionStiffening object

The ConcreteTensionStiffening object specifies hardening for the concrete damaged plasticity model.
Access

import material mdb.models[name].materials[name].concreteDamagedPlasticity.concreteTensionStiff import odbMaterial session.odbs[name].materials[name].concreteDamagedPlasticity.concreteTensionSti

25.20.1

ConcreteTensionStiffening(...)

This method creates a ConcreteTensionStiffening object.
Path

mdb.models[name].materials[name].concreteDamagedPlasticity.ConcreteTensionStiff session.odbs[name].materials[name].concreteDamagedPlasticity.ConcreteTensionSti
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, DISPLACEMENT, and GFI. Set type=STRAIN to specify postfailure stress as a function of cracking strain. Set type=DISPLACEMENT to specify postfailure stress as a function of cracking displacement. Set type=GFI to specify 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,

.

25–41

ConcreteTensionStiffening object

• • • • • • • • • • • • • • • • • • • •

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

25.20.2

setValues(...)

This method modifies the ConcreteTensionStiffening object.

25–42

Conductivity object

Arguments Required arguments None. Optional arguments

The optional arguments to setValues ConcreteTensionStiffening method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.20.3

Members

The ConcreteTensionStiffening object has members with the same names and descriptions as the arguments to the ConcreteTensionStiffening method.
25.20.4 Corresponding analysis keywords

*CONCRETE TENSION STIFFENING

25.21

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

25.21.1

Conductivity(...)

This method creates a Conductivity object.
Path

mdb.models[name].materials[name].Conductivity

25–43

Conductivity object

session.odbs[name].materials[name].Conductivity
Required argument

table A sequence of sequences of Floats specifying the items described below.
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. . . . 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. . . . . . . Temperature, if the data depend on temperature. Value of the first field variable, if the data depend on field variables.

If type=ORTHOTROPIC, the table data specify the following:

If type=ANISOTROPIC, the table data specify the following:

25–44

ContactArea object

• •

Value of the second field variable. Etc.

Return value

A Conductivity object.
Exceptions

RangeError.

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

25.21.3

Members

The Conductivity object has members with the same names and descriptions as the arguments to the Conductivity method.
25.21.4 Corresponding analysis keywords

*CONDUCTIVITY

25.22

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.

25–45

ContactArea object

Access

import material mdb.models[name].materials[name].gasketThicknessBehavior.contactArea import odbMaterial session.odbs[name].materials[name].gasketThicknessBehavior.contactArea

25.22.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. Etc.

Return value

A ContactArea object.
Exceptions

None.

25–46

Creep object

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

25.22.3

Members

The ContactArea object has members with the same names and descriptions as the arguments to the ContactArea method.
25.22.4 Corresponding analysis keywords

*GASKET CONTACT AREA

25.23

Creep object

The Creep object defines a creep law.
Access

import material mdb.models[name].materials[name].creep import odbMaterial session.odbs[name].materials[name].creep

25.23.1

Creep(...)

This method creates a Creep object.

25–47

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 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:

Return value

A Creep object.

25–48

CrushableFoam object

Exceptions

RangeError.

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

25.23.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. potential A Potential object.
25.23.4 Corresponding analysis keywords

*CREEP

25.24

CrushableFoam object

The CrushableFoam object specifies the crushable foam plasticity model.
Access

import material

25–49

CrushableFoam object

mdb.models[name].materials[name].crushableFoam import odbMaterial session.odbs[name].materials[name].crushableFoam

25.24.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. 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. Ratio, , of initial yield stress in uniaxial compression, compression, ; 0.0 3.0. Plastic Poisson’s ratio. ; -1 0.5. Temperature, if the data depend on temperature. , to initial yield stress in hydrostatic

If hardening=ISOTROPIC, the table data specify the following:

25–50

CrushableFoam object

• • •

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.

25.24.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
Exceptions

RangeError.

25.24.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.
25.24.4 Corresponding analysis keywords

*CRUSHABLE FOAM

25–51

CrushableFoamHardening object

25.25

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

25.25.1

CrushableFoamHardening(...)

This method creates a CrushableFoamHardening object.
Path

mdb.models[name].materials[name].crushableFoam.CrushableFoamHardening session.odbs[name].materials[name].crushableFoam.CrushableFoamHardening
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.

25–52

CycledPlastic object

Exceptions

RangeError.

25.25.2

setValues(...)

This method modifies the CrushableFoamHardening object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues CrushableFoamHardening method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.25.3

Members

The CrushableFoamHardening object has members with the same names and descriptions as the arguments to the CrushableFoamHardening method.
25.25.4 Corresponding analysis keywords

*CRUSHABLE FOAM HARDENING

25.26

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

25–53

CycledPlastic object

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

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

25–54

CyclicHardening object

Exceptions

None.

25.26.3

Members

The CycledPlastic object has members with the same names and descriptions as the arguments to the CycledPlastic method.
25.26.4 Corresponding analysis keywords

*CYCLED PLASTIC

25.27

CyclicHardening object

The Cyclic Hardening 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

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

25–55

CyclicHardening object

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

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

25–56

Damping object

25.27.3

Members

The CyclicHardening object has members with the same names and descriptions as the arguments to the CyclicHardening method.
25.27.4 Corresponding analysis keywords

*CYCLIC HARDENING

25.28

Damping object

The Damping object specifies material damping.
Access

import material mdb.models[name].materials[name].damping import odbMaterial session.odbs[name].materials[name].damping

25.28.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 This argument applies only to ABAQUS/Standard analyses. 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.

25–57

DeformationPlasticity object

Return value

A Damping object.
Exceptions

RangeError.

25.28.2

setValues(...)

This method modifies the Damping object.
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.

25.28.3

Members

The Damping object has members with the same names and descriptions as the arguments to the Damping method.
25.28.4 Corresponding analysis keywords

*DAMPING

25.29

DeformationPlasticity object

The DeformationPlasticity object specifies the deformation plasticity model.
Access

import material mdb.models[name].materials[name].deformationPlasticity

25–58

DeformationPlasticity object

import odbMaterial session.odbs[name].materials[name].deformationPlasticity

25.29.1

DeformationPlasticity(...)

This method creates a DeformationPlasticity object.
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.

25.29.2

setValues(...)

This method modifies the DeformationPlasticity object.
Arguments Required arguments

None.

25–59

Density object

Optional arguments

The optional arguments to setValues DeformationPlasticity method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.29.3

Members

The DeformationPlasticity object has members with the same names and descriptions as the arguments to the DeformationPlasticity method.
25.29.4 Corresponding analysis keywords

*DEFORMATION PLASTICITY

25.30

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

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

25–60

Density object

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.

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

25.30.3

Members

The Density object has members with the same names and descriptions as the arguments to the Density method.

25–61

Depvar object

25.30.4

Corresponding analysis keywords

*DENSITY

25.31

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

25.31.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 This argument applies only to ABAQUS/Explicit analyses. An Int specifying the state variable number controlling the element deletion flag. The default value is 0. 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.

25–62

DetonationPoint object

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

25.31.3

Members

The Depvar object has members with the same names and descriptions as the arguments to the Depvar method.
25.31.4 Corresponding analysis keywords

*DEPVAR

25.32

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

25.32.1

DetonationPoint(...)

This method creates a DetonationPoint object.

25–63

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.

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

25–64

Dielectric object

25.32.3

Members

The DetonationPoint object has members with the same names and descriptions as the arguments to the DetonationPoint method.
25.32.4 Corresponding analysis keywords

*DETONATION POINT

25.33

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

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

25–65

Dielectric object

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

If type=ANISOTROPIC, the table data specify the following:

Return value

A Dielectric object.
Exceptions

None.

25.33.2

setValues(...)

This method modifies the Dielectric object.

25–66

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

25.33.3

Members

The Dielectric object has members with the same names and descriptions as the arguments to the Dielectric method.
25.33.4 Corresponding analysis keywords

*DIELECTRIC

25.34

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

25.34.1

Diffusivity(...)

This method creates a Diffusivity object.
Path

mdb.models[name].materials[name].Diffusivity session.odbs[name].materials[name].Diffusivity

25–67

Diffusivity object

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

If type=ANISOTROPIC, the table data specify the following:

25–68

Diffusivity object

• • • • • • •

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

RangeError.

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

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

25–69

DruckerPrager object

25.34.4

Corresponding analysis keywords

*DIFFUSIVITY

25.35

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

25.35.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 This argument applies only to ABAQUS/Standard analyses. Only the linear Drucker-Prager model is available in ABAQUS/Explicit analyses. A SymbolicConstant specifying the yield criterion. Possible values are LINEAR, HYPERBOLIC, and EXPONENTIAL. The default value is LINEAR. eccentricity This argument applies only to ABAQUS/Standard analyses. 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. testData This argument is valid only if shearCriterion=EXPONENTIAL.

25–70

DruckerPrager object

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. 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. 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. 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=HYPERBOLIC, the table data specify the following:

If shearCriterion=EXPONENTIAL, the table data specify the following:

Return value

A DruckerPrager object.

25–71

DruckerPrager object

Exceptions

RangeError.

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

25.35.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.
25.35.4 Corresponding analysis keywords

*DRUCKER PRAGER

25–72

DruckerPragerCreep object

25.36

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

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

.)

25–73

DruckerPragerCreep object

• • • • • • • • • • • • • •

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

If law=SINGHM, the table data specify the following:

Return value

A DruckerPragerCreep object.
Exceptions

RangeError.

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

25–74

DruckerPragerHardening object

Exceptions

RangeError.

25.36.3

Members

The DruckerPragerCreep object has members with the same names and descriptions as the arguments to the DruckerPragerCreep method.
25.36.4 Corresponding analysis keywords

*DRUCKER PRAGER CREEP

25.37

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

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

25–75

DruckerPragerHardening object

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.

25.37.2

setValues(...)

This method modifies the DruckerPragerHardening object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues DruckerPragerHardening method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25–76

Elastic object

25.37.3

Members

The DruckerPragerHardening object has members with the same names and descriptions as the arguments to the DruckerPragerHardening method.
25.37.4 Corresponding analysis keywords

*DRUCKER PRAGER HARDENING

25.38

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

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

type A SymbolicConstant specifying the type of elasticity data provided. Possible values are ISOTROPIC, ORTHOTROPIC, ANISOTROPIC, ENGINEERING_CONSTANTS, LAMINA, TRACTION, and COUPLED_TRACTION. 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.

25–77

Elastic object

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. . . . . . . . . . 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. . . . . . This shear modulus is needed to define transverse shear behavior in shells. . This shear modulus is needed to define transverse shear behavior in shells.

If type=ENGINEERING_CONSTANTS, the table data specify the following:

If type=LAMINA, the table data specify the following:

25–78

Elastic object

• • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • •

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

If type=ANISOTROPIC, the table data specify the following:

25–79

Elastic object

• • • • • • • • • • • • • • • • • • • • • • • • • •

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

If type=COUPLED_TRACTION, the table data specify the following:

Return value

An Elastic object.
Exceptions

RangeError.

25–80

ElectricalConductivity object

25.38.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
Exceptions

RangeError.

25.38.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.
25.38.4 Corresponding analysis keywords

*ELASTIC

25.39

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

25–81

ElectricalConductivity object

25.39.1

ElectricalConductivity(...)

This method creates an ElectricalConductivity object.
Path

mdb.models[name].materials[name].ElectricalConductivity session.odbs[name].materials[name].ElectricalConductivity
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. . . . 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:

If type=ANISOTROPIC, the table data specify the following:

25–82

ElectricalConductivity object

• • • • • • • •

. . . . 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 ElectricalConductivity object.
Exceptions

RangeError.

25.39.2

setValues(...)

This method modifies the ElectricalConductivity object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues ElectricalConductivity method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.39.3

Members

The ElectricalConductivity object has members with the same names and descriptions as the arguments to the ElectricalConductivity method.

25–83

Eos object

25.39.4

Corresponding analysis keywords

*ELECTRICAL CONDUCTIVITY

25.40

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

25.40.1

Eos(...)

This method creates an Eos object.
Path

mdb.models[name].materials[name].Eos session.odbs[name].materials[name].Eos
Required argument

table A sequence of sequences of Floats specifying the items described below.
Optional argument

type A SymbolicConstant specifying the equation of state. Possible values are JWL, USUP, and IDEALGAS. The default value is IDEALGAS. Table data If type=IDEALGAS, the table data represents the following:

• • • • • •

Gas constant, . The ambient pressure, Detonation wave speed, . . . (Dimensionless.)

. If this field is left blank, a default of 0.0 is used. .

If type=JWL, the table data represents the following:

25–84

Eos object

• • • • • •

. (Dimensionless.) . (Dimensionless.) Pre-detonation bulk modulus, . . (Dimensionless.) . (Dimensionless.)

.

If type=USUP, the table data represents the following:

Return value

An Eos object.
Exceptions

None.

25.40.2

setValues(...)

This method modifies the Eos object.
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.

25.40.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. eosShear An EosShear object.

25–85

EosShear object

25.40.4

Corresponding analysis keywords

*EOS

25.41

EosShear object

A EosShear object specifies a suboption of the Eos object. The EosShear 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.eosShear import odbMaterial session.odbs[name].materials[name].eos.eosShear

25.41.1

EosShear(...)

This method creates a EosShear object.
Path

mdb.models[name].materials[name].eos.EosShear session.odbs[name].materials[name].eos.EosShear
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. type A SymbolicConstant specifying the type of shear behavior. Possible values are ELASTIC and VISCOUS. The default value is ELASTIC. Table data If type=ELASTIC, the table data specify the following:



Shear modulus.

25–86

EosShear object

• • • • • • • • •

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

If type=VISCOUS, the table data specify the following:

Return value

A EosShear object.
Exceptions

None.

25.41.2

setValues(...)

This method modifies the EosShear object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the EosShear method.
Return value

None
Exceptions

None.

25.41.3

Members

The EosShear object has members with the same names and descriptions as the arguments to the EosShear method.

25–87

Expansion object

25.41.4

Corresponding analysis keywords

*EOS SHEAR

25.42

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

25.42.1

Expansion(...)

This method creates an Expansion object.
Path

mdb.models[name].materials[name].Expansion session.odbs[name].materials[name].Expansion
Required arguments

None.
Optional arguments

type A SymbolicConstant specifying the type of expansion. Possible values are ISOTROPIC, ORTHOTROPIC, and ANISOTROPIC. 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 fieldvariable-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.

25–88

Expansion object

table A sequence of sequences of Floats specifying the items described below. The default value is the 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. . . . 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. . . . (Not used for plane stress case.) . . . 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:

If type=ANISOTROPIC, the table data specify the following:

Return value

An Expansion object.
Exceptions

RangeError.

25–89

FailStrain object

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

25.42.3

Members

The Expansion object has members with the same names and descriptions as the arguments to the Expansion method.
25.42.4 Corresponding analysis keywords

*EXPANSION

25.43

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

25.43.1

FailStrain(...)

This method creates a FailStrain object.

25–90

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

25.43.2

setValues(...)

This method modifies the FailStrain object.
Arguments Required arguments

None.

25–91

FailStress object

Optional arguments

The optional arguments to setValues are the same as the arguments to the FailStrain method.
Return value

None
Exceptions

RangeError.

25.43.3

Members

The FailStrain object has members with the same names and descriptions as the arguments to the FailStrain method.
25.43.4 Corresponding analysis keywords

*FAIL STRAIN

25.44

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

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

25–92

FailStress object

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

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

25–93

FailureRatios object

Exceptions

RangeError.

25.44.3

Members

The FailStress object has members with the same names and descriptions as the arguments to the FailStress method.
25.44.4 Corresponding analysis keywords

*FAIL STRESS

25.45

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

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

25–94

FailureRatios object

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

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

25–95

GasketMembraneElastic object

25.45.3

Members

The FailureRatios object has members with the same names and descriptions as the arguments to the FailureRatios method.
25.45.4 Corresponding analysis keywords

*FAILURE RATIOS

25.46

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

25.46.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. Table data

• •

Young’s modulus, Poisson’s ratio, .

.

25–96

GasketMembraneElastic object

• • • •

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.

25.46.2

setValues(...)

This method modifies the GasketMembraneElastic object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues GasketMembraneElastic method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.46.3

Members

The GasketMembraneElastic object has members with the same names and descriptions as the arguments to the GasketMembraneElastic method.
25.46.4 Corresponding analysis keywords

*GASKET ELASTICITY

25–97

GasketThicknessBehavior object

25.47

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

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

25–98

GasketThicknessBehavior object

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. unloadingTable A sequence of sequences of Floats specifying unloading data. The default value is an empty sequence. The items in the table data are described below. 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. 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. Force or force per unit length; 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:

If variableUnits=STRESS and type=ELASTIC_PLASTIC, the unloadingTable data specify the following:

25–99

GasketThicknessBehavior object

• • • • • • • • • • • • • • • • • • • • • • • • • • • •

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

If variableUnits=FORCE and type=DAMAGE, the unloadingTable data specify the following:

Return value

A GasketThicknessBehavior object.

25–100

GasketTransverseShearElastic object

Exceptions

RangeError.

25.47.2

setValues(...)

This method modifies the GasketThicknessBehavior object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues GasketThicknessBehavior method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.47.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.
25.47.4 Corresponding analysis keywords

*GASKET THICKNESS BEHAVIOR

25.48

GasketTransverseShearElastic object

The GasketTransverseShearElastic object defines the elastic parameters for the transverse shear behavior of a gasket.

25–101

GasketTransverseShearElastic object

Access

import material mdb.models[name].materials[name].gasketTransverseShearElastic import odbMaterial session.odbs[name].materials[name].gasketTransverseShearElastic

25.48.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. Value of the second field variable. Etc.

Return value

A GasketTransverseShearElastic object.
Exceptions

RangeError.

25–102

Gel object

25.48.2

setValues(...)

This method modifies the GasketTransverseShearElastic object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are GasketTransverseShearElastic method.
Return value

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.48.3

Members

The GasketTransverseShearElastic object has members with the same names and descriptions as the arguments to the GasketTransverseShearElastic method.
25.48.4 Corresponding analysis keywords

*GASKET ELASTICITY

25.49

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

25.49.1

Gel(...)

This method creates a Gel object.

25–103

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.

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

25–104

HeatGeneration object

25.49.3
25.49.4

Members
Corresponding analysis keywords

The Gel object has members with the same names and descriptions as the arguments to the Gel method.

*GEL

25.50

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

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

25.50.2

Members

The HeatGeneration object has no members.

25–105

Hyperelastic object

25.50.3

Corresponding analysis keywords

*HEAT GENERATION

25.51

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

25.51.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, and 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.

25–106

Hyperelastic object

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 If type=USER, this argument cannot be used. beta

6.

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. . . . Temperature, if the data depend on temperature. .

If type=MOONEY_RIVLIN, the table data specify the following:

If type=NEO_HOOKE, the table data specify the following:

25–107

Hyperelastic object

• • • • • • • • • • • • • • • • • • • • • • • •

. Temperature, if the data depend on temperature. 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. 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. 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. . . . . . Temperature, if the data depend on temperature. . . . . . . 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.

If type=OGDEN, the table data specify the following for values of :

If type=POLYNOMIAL, the table data specify the following for values of :

If type=REDUCED_POLYNOMIAL, the table data specify the following for values of :

If type=VAN_DER_WAALS, the table data specify the following:

If type=YEOH, the table data specify the following:

25–108

Hyperelastic object

Return value

A Hyperelastic object.
Exceptions

InvalidNameError and RangeError.

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

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

25–109

Hyperfoam object

25.51.4

Corresponding analysis keywords

*HYPERELASTIC

25.52

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

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

25–110

Hyperfoam object

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

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

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

25–111

Hypoelastic object

volumetricTestData A VolumetricTestData object. planarTestData A PlanarTestData object. simpleShearTestData A SimpleShearTestData object. uniaxialTestData A UniaxialTestData object.
25.52.4 Corresponding analysis keywords

*HYPERFOAM

25.53

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

25.53.1

Hypoelastic(...)

This method creates a Hypoelastic object.
Path

mdb.models[name].materials[name].Hypoelastic 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.

25–112

Hypoelastic object

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.

25.53.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
Exceptions

None.

25.53.3

Members

The Hypoelastic object has members with the same names and descriptions as the arguments to the Hypoelastic method.
25.53.4 Corresponding analysis keywords

*HYPOELASTIC

25–113

Hysteresis object

25.54

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

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

None. Table data

• • • •

Stress scaling factor. Creep parameter. Effective stress exponent. Creep strain exponent.

Return value

A Hysteresis object.
Exceptions

RangeError.

25–114

InelasticHeatFraction object

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

25.54.3

Members

The Hysteresis object has members with the same names and descriptions as the arguments to the Hysteresis method.
25.54.4 Corresponding analysis keywords

*HYSTERESIS

25.55

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

25.55.1

InelasticHeatFraction(...)

This method creates an InelasticHeatFraction object.

25–115

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.

25.55.2

setValues(...)

This method modifies the InelasticHeatFraction object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues InelasticHeatFraction method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.55.3

Members

The InelasticHeatFraction object has members with the same names and descriptions as the arguments to the InelasticHeatFraction method.

25–116

JouleHeatFraction object

25.55.4

Corresponding analysis keywords

*INELASTIC HEAT FRACTION

25.56

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

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

25.56.2

setValues(...)

This method modifies the JouleHeatFraction object.

25–117

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

25.56.3

Members

The JouleHeatFraction object has members with the same names and descriptions as the arguments to the JouleHeatFraction method.
25.56.4 Corresponding analysis keywords

*JOULE HEAT FRACTION

25.57

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

25.57.1

LatentHeat(...)

This method creates a LatentHeat object.
Path

mdb.models[name].materials[name].LatentHeat

25–118

LatentHeat object

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. Liquidus temperature.

Return value

A LatentHeat object.
Exceptions

RangeError.

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

25.57.3

Members

The LatentHeat object has members with the same names and descriptions as the arguments to the LatentHeat method.

25–119

MohrCoulombHardening object

25.57.4

Corresponding analysis keywords

*LATENT HEAT

25.58

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

25.58.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. Value of the second field variable. Etc.

25–120

MohrCoulombPlasticity object

Return value

A MohrCoulombHardening object.
Exceptions

RangeError.

25.58.2

setValues(...)

This method modifies the MohrCoulombHardening object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues MohrCoulombHardening method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.58.3

Members

The MohrCoulombHardening object has members with the same names and descriptions as the arguments to the MohrCoulombHardening method.
25.58.4 Corresponding analysis keywords

*MOHR COULOMB HARDENING

25.59

MohrCoulombPlasticity object

The MohrCoulombPlasticity object specifies the extended Mohr-Coulomb plasticity model.
Access

import material

25–121

MohrCoulombPlasticity object

mdb.models[name].materials[name].mohrCoulombPlasticity import odbMaterial session.odbs[name].materials[name].mohrCoulombPlasticity

25.59.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 A Float specifying the flow potential eccentricity in the deviatoric plane, ; 1/2 1.0. The default value is None, in which case ABAQUS calculates the value using the specified MohrCoulomb angle of friction. 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. Table data The table data specify the following:

• • • • • •

Friction angle (given in degrees), , at high confining pressure in the – 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.

plane.

Return value

A MohrCoulombPlasticity object.

25–122

MoistureSwelling object

Exceptions

RangeError.

25.59.2

setValues(...)

This method modifies the MohrCoulombPlasticity object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues MohrCoulombPlasticity method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.59.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 member: mohrCoulombHardening A MohrCoulombHardening object.
25.59.4 Corresponding analysis keywords

*MOHR COULOMB

25.60

MoistureSwelling object

The MoistureSwelling object defines moisture-driven swelling.
Access

import material

25–123

MoistureSwelling object

mdb.models[name].materials[name].moistureSwelling import odbMaterial session.odbs[name].materials[name].moistureSwelling

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

Return value

A MoistureSwelling object.
Exceptions

None.

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

25–124

Ornl object

Return value

None
Exceptions

None.

25.60.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.
25.60.4 Corresponding analysis keywords

*MOISTURE SWELLING

25.61

Ornl object

The Ornl object specifies the constitutive model developed by Oak Ridge National Laboratory.
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

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

25–125

Ornl object

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 is 0.3, as per that section of the Standard. Set a=0.0 to use the 1986 revision of the Standard. h 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]. The default value is None, indicating that 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. reset A Boolean specifying whether to invoke the optional of the Nuclear Standard. The default value is OFF.
Return value

reset procedure described in Section 4.3.5

An Ornl object.
Exceptions

RangeError.

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

25–126

Permeability object

25.61.3

Members

The Ornl object has members with the same names and descriptions as the arguments to the Ornl method.
25.61.4 Corresponding analysis keywords

*ORNL

25.62

Permeability object

The Permeability object defines permeability for pore fluid flow.
Access

import material mdb.models[name].materials[name].permeability import odbMaterial session.odbs[name].materials[name].permeability

25.62.1

Permeability(...)

This method creates a Permeability object.
Path

mdb.models[name].materials[name].Permeability session.odbs[name].materials[name].Permeability
Required argument

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. specificWeight A Float specifying the specific weight of the wetting liquid, . The default value is 1.0.

temperatureDependency A Boolean specifying whether the data depend on temperature. The default value is OFF.

25–127

Permeability object

Table data

If type=ISOTROPIC, the table data specify the following:

• • • • • • • • • • • • • • • •

. Void ratio, . Temperature, if the data depend on temperature. . . . Void ratio, . Temperature, if the data depend on temperature. . . . . . . Void ratio, . Temperature, if the data depend on temperature.

If type=ORTHOTROPIC, the table data specify the following:

If type=ANISOTROPIC, the table data specify the following:

Return value

A Permeability object.
Exceptions

RangeError.

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

25–128

Piezoelectric object

Return value

None
Exceptions

RangeError.

25.62.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. velocityDependence A VelocityDependence object specifying the dependence of the permeability of a material on the velocity of fluid flow.
25.62.4 Corresponding analysis keywords

*PERMEABILITY

25.63

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

25.63.1

Piezoelectric(...)

This method creates a Piezoelectric object.
Path

mdb.models[name].materials[name].Piezoelectric session.odbs[name].materials[name].Piezoelectric

25–129

Piezoelectric object

Required argument

table A sequence of sequences of Floats specifying the items described below.
Optional argument

type A SymbolicConstant specifying the type of material coefficients for the piezoelectric property. Possible values are STRAIN and STRESS. The default value is STRESS. Table data If type=STRESS, the table data specify the following:

• • • • • • • • • • • • • • • • • • • • • • • • •

. . . . . . . . . . . . . . . . . . . . . . . . .

If type=STRAIN, the table data specify the following:

25–130

Piezoelectric object

• • • • • • • • • •

. . . . . . . . . .

Return value

A Piezoelectric object.
Exceptions

None.

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

25.63.3

Members

The Piezoelectric object has members with the same names and descriptions as the arguments to the Piezoelectric method.

25–131

PlanarTestData object

25.63.4

Corresponding analysis keywords

*PIEZOELECTRIC

25.64

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 import odbMaterial session.odbs[name].materials[name].hyperelastic.planarTestData session.odbs[name].materials[name].hyperfoam.planarTestData

25.64.1

PlanarTestData(...)

This method creates a PlanarTestData object.
Path

mdb.models[name].materials[name].hyperelastic.PlanarTestData mdb.models[name].materials[name].hyperfoam.PlanarTestData session.odbs[name].materials[name].hyperelastic.PlanarTestData session.odbs[name].materials[name].hyperfoam.PlanarTestData
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. The default value is None, for no smoothing. 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.

25–132

PlanarTestData object

Table data

For a hyperelastic material model, the table data specify the following:

• • • • •

Nominal stress,

. .

Nominal strain in the direction of loading, Nominal stress, .

For a hyperfoam material model, the table data specify the following: Nominal strain in the direction of loading, Nominal transverse strain, .

. The default value is 0.

Return value

A PlanarTestData object.
Exceptions

None.

25.64.2

setValues(...)

This method modifies the PlanarTestData object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the PlanarTestData method.
Return value

None
Exceptions

None.

25.64.3

Members

The PlanarTestData object has members with the same names and descriptions as the arguments to the PlanarTestData method.

25–133

Plastic object

25.64.4

Corresponding analysis keywords

*PLANAR TEST DATA

25.65

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

25.65.1

Plastic(...)

This method creates a Plastic object.
Path

mdb.models[name].materials[name].Plastic session.odbs[name].materials[name].Plastic
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.

25–134

Plastic object

gamma A Float specifying the value of the kinematic hardening parameter . This argument is only valid if hardening=COMBINED and dataType=PARAMETERS. 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 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. Yield stress. Plastic strain. 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. Yield stress at zero plastic strain. Kinematic hardening 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. Yield stress. Plastic strain. Temperature, if the data depend on temperature.

If hardening=COMBINED and dataType=STABILIZED, the table data specify the following:

If hardening=COMBINED and dataType=PARAMETERS, the table data specify the following:

If hardening=KINEMATIC, the table data specify the following:

25–135

Plastic object

If hardening=JOHNSON_COOK, the table data specify the following:

• • • • • • •

A. B. n. m. Melting temperature. Transition temperature. Hardening properties.

If hardening=USER, the table data specify the following:

Return value

A Plastic object.
Exceptions

RangeError.

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

25.65.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:

25–136

PoreFluidExpansion object

rateDependent A RateDependent object. potential A Potential object. cyclicHardening A CyclicHardening object. ornl An Ornl object. cycledPlastic A CycledPlastic object. annealTemperature An AnnealTemperature object.
25.65.4 Corresponding analysis keywords

*PLASTIC

25.66

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

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

25–137

PoreFluidExpansion object

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

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

25–138

PorousBulkModuli object

25.66.3

Members

The PoreFluidExpansion object has members with the same names and descriptions as the arguments to the PoreFluidExpansion method.
25.66.4 Corresponding analysis keywords

*EXPANSION

25.67

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

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

25–139

PorousElastic object

Return value

A PorousBulkModuli object.
Exceptions

None.

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

25.67.3

Members

The PorousBulkModuli object has members with the same names and descriptions as the arguments to the PorousBulkModuli method.
25.67.4 Corresponding analysis keywords

*POROUS BULK MODULI

25.68

PorousElastic object

The PorousElastic object specifies elastic material properties for porous materials.
Access

import material

25–140

PorousElastic object

mdb.models[name].materials[name].porousElastic import odbMaterial session.odbs[name].materials[name].porousElastic

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

If shear=POISSON, the table data specify the following:

25–141

PorousFailureCriteria object

• •

Value of the second field variable. Etc.

Return value

A PorousElastic object.
Exceptions

RangeError.

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

25.68.3

Members

The PorousElastic object has members with the same names and descriptions as the arguments to the PorousElastic method.
25.68.4 Corresponding analysis keywords

*POROUS ELASTIC

25.69

PorousFailureCriteria object

The PorousFailureCriteria object specifies the material failure criteria for a porous metal.

25–142

PorousFailureCriteria object

Access

import material mdb.models[name].materials[name].porousMetalPlasticity.porousFailureCriteria import odbMaterial session.odbs[name].materials[name].porousMetalPlasticity.porousFailureCriteria

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

fraction A Float specifying the void volume fraction at total failure, criticalFraction A Float specifying the critical void volume fraction, .
Optional arguments

.

None.
Return value

A PorousFailureCriteria object.
Exceptions

RangeError.

25.69.2

setValues(...)

This method modifies the PorousFailureCriteria object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues PorousFailureCriteria method.

are

the

same

as

the

arguments

to

the

25–143

PorousMetalPlasticity object

Return value

None
Exceptions

RangeError.

25.69.3

Members

The PorousFailureCriteria object has members with the same names and descriptions as the arguments to the PorousFailureCriteria method.
25.69.4 Corresponding analysis keywords

*POROUS FAILURE CRITERIA

25.70

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

25.70.1

PorousMetalPlasticity(...)

This method creates a PorousMetalPlasticity object.
Path

mdb.models[name].materials[name].PorousMetalPlasticity session.odbs[name].materials[name].PorousMetalPlasticity
Required arguments

relativeDensity None or a Float specifying the initial relative density of the material, . table A sequence of sequences of Floats specifying the items described below.

25–144

PorousMetalPlasticity object

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.

Return value

A PorousMetalPlasticity object.
Exceptions

RangeError.

25.70.2

setValues(...)

This method modifies the PorousMetalPlasticity object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues PorousMetalPlasticity method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25–145

Potential object

25.70.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.
25.70.4 Corresponding analysis keywords

*POROUS METAL PLASTICITY

25.71

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

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

25–146

Potential object

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.

Return value

A Potential object.
Exceptions

RangeError.

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

25–147

PressureEffect object

Return value

None
Exceptions

RangeError.

25.71.3

Members

The Potential object has members with the same names and descriptions as the arguments to the Potential method.
25.71.4 Corresponding analysis keywords

*POTENTIAL

25.72

PressureEffect object

The PressureEffect object defines equivalent pressure stress driven mass diffusion.
Access

import material mdb.models[name].materials[name].diffusivity.pressureEffect import odbMaterial session.odbs[name].materials[name].diffusivity.pressureEffect

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

25–148

PressureEffect object

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.

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

25.72.3

Members

The PressureEffect object has members with the same names and descriptions as the arguments to the PressureEffect method.

25–149

RateDependent object

25.72.4

Corresponding analysis keywords

*KAPPA

25.73

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 session.odbs[name].materials[name].crushableFoam.rateDependent session.odbs[name].materials[name].druckerPrager.rateDependent session.odbs[name].materials[name].plastic.rateDependent

25.73.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, or JOHNSON_COOK. The default value is POWER_LAW. temperatureDependency A Boolean specifying whether the data depend on temperature. The default value is OFF.

25–150

RateDependent object

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. Yield stress ratio, .

If type=YIELD_RATIO, the table data specify the following: 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 type=JOHNSON_COOK, the table data specify the following:

Return value

A RateDependent object.
Exceptions

RangeError.

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

25–151

Ratios object

Return value

None
Exceptions

RangeError.

25.73.3

Members

The RateDependent object has members with the same names and descriptions as the arguments to the RateDependent method.
25.73.4 Corresponding analysis keywords

*RATE DEPENDENT

25.74

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

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

25–152

Ratios object

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.

Return value

A Ratios object.
Exceptions

RangeError.

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

25–153

Regularization object

Exceptions

RangeError.

25.74.3

Members

The Ratios object has members with the same names and descriptions as the arguments to the Ratios method.
25.74.4 Corresponding analysis keywords

*RATIOS

25.75

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

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

25–154

SaturationDependence object

Return value

A Regularization object.
Exceptions

RangeError.

25.75.2

setValues(...)

This method modifies the Regularization object.
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.

25.75.3

Members

The Regularization object has members with the same names and descriptions as the arguments to the Regularization method.
25.75.4 Corresponding analysis keywords

*DASHPOT

25.76

SaturationDependence object

The SaturationDependence object specifies the dependence of the permeability of a material on the saturation of the wetting liquid.

25–155

SaturationDependence object

Access

import material mdb.models[name].materials[name].permeability.saturationDependence import odbMaterial session.odbs[name].materials[name].permeability.saturationDependence

25.76.1

SaturationDependence(...)

This method creates a SaturationDependence object.
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.

25.76.2

setValues(...)

This method modifies the SaturationDependence object.
Arguments Required arguments

None.

25–156

ShearRetention object

Optional arguments

The optional arguments to setValues SaturationDependence method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

RangeError.

25.76.3

Members

The SaturationDependence object has members with the same names and descriptions as the arguments to the SaturationDependence method.
25.76.4 Corresponding analysis keywords

*PERMEABILITY

25.77

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

25.77.1

ShearRetention(...)

This method creates a ShearRetention object.
Path

mdb.models[name].materials[name].concrete.ShearRetention session.odbs[name].materials[name].concrete.ShearRetention

25–157

ShearRetention object

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. Value of the second field variable. Etc.

Return value

A ShearRetention object.
Exceptions

RangeError.

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

25–158

ShearTestData object

Exceptions

RangeError.

25.77.3

Members

The ShearRetention object has members with the same names and descriptions as the arguments to the ShearRetention method.
25.77.4 Corresponding analysis keywords

*SHEAR RETENTION

25.78

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

25.78.1

ShearTestData(...)

This method creates a ShearTestData object.
Path

mdb.models[name].materials[name].viscoelastic.ShearTestData session.odbs[name].materials[name].viscoelastic.ShearTestData
Required arguments

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:

25–159

ShearTestData object

• •
shrinf

Normalized shear compliance Time . .

.

.

None or a Float specifying a normalized shear. The value of shrinf depends on the value of the time member of the Viscoelastic object. 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 .
Optional arguments

None.
Return value

A ShearTestData object.
Exceptions

None.

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

25.78.3

Members

The ShearTestData object has members with the same names and descriptions as the arguments to the ShearTestData method.

25–160

SimpleShearTestData object

25.78.4

Corresponding analysis keywords

*SHEAR TEST DATA

25.79

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

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

25–161

Solubility object

25.79.2

setValues(...)

This method modifies the SimpleShearTestData object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues SimpleShearTestData method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

None.

25.79.3

Members

The SimpleShearTestData object has members with the same names and descriptions as the arguments to the SimpleShearTestData method.
25.79.4 Corresponding analysis keywords

*SIMPLE SHEAR TEST DATA

25.80

Solubility object

The Solubility object specifies solubility.
Access

import material mdb.models[name].materials[name].solubility import odbMaterial session.odbs[name].materials[name].solubility

25.80.1

Solubility(...)

This method creates a Solubility object.

25–162

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.

25.80.2

setValues(...)

This method modifies the Solubility object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the Solubility method.
Return value

None

25–163

SoretEffect object

Exceptions

RangeError.

25.80.3

Members

The Solubility object has members with the same names and descriptions as the arguments to the Solubility method.
25.80.4 Corresponding analysis keywords

*SOLUBILITY

25.81

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

25.81.1

SoretEffect(...)

This method creates a SoretEffect object.
Path

mdb.models[name].materials[name].diffusivity.SoretEffect session.odbs[name].materials[name].diffusivity.SoretEffect
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.

25–164

SoretEffect object

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.

25.81.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
Exceptions

RangeError.

25.81.3

Members

The SoretEffect object has members with the same names and descriptions as the arguments to the SoretEffect method.
25.81.4 Corresponding analysis keywords

*KAPPA

25–165

Sorption object

25.82

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

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

lawAbsorption A SymbolicConstant specifying absorption behavior. Possible values are LOG, TABULAR. The default value is TABULAR. exsorption A Boolean specifying whether the exsorption data is specified. The default value is OFF. exsorptionTable A sequence of sequences of Floats specifying the items described below. The default value is an empty sequence. lawExsorption A SymbolicConstant specifying exsorption behavior. Possible values are LOG, 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.

25–166

Sorption object

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.

25.82.2

setValues(...)

This method modifies the Sorption object.
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.

25.82.3

Members

The Sorption object has members with the same names and descriptions as the arguments to the Sorption method.

25–167

SpecificHeat object

25.82.4

Corresponding analysis keywords

*SORPTION

25.83

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

25.83.1

SpecificHeat(...)

This method creates a SpecificHeat object.
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

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.

25–168

Swelling object

Return value

A SpecificHeat object.
Exceptions

RangeError.

25.83.2

setValues(...)

This method modifies the SpecificHeat object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the SpecificHeat method.
Return value

None
Exceptions

RangeError.

25.83.3

Members

The SpecificHeat object has members with the same names and descriptions as the arguments to the SpecificHeat method.
25.83.4 Corresponding analysis keywords

*SPECIFIC HEAT

25.84

Swelling object

The Swelling object specifies time-dependent volumetric swelling for a material.
Access

import material mdb.models[name].materials[name].swelling

25–169

Swelling object

import odbMaterial session.odbs[name].materials[name].swelling

25.84.1

Swelling(...)

This method creates a Swelling object.
Path

mdb.models[name].materials[name].Swelling session.odbs[name].materials[name].Swelling
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.

25.84.2

setValues(...)

This method modifies the Swelling object.

25–170

TensionStiffening object

Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the Swelling method.
Return value

None
Exceptions

RangeError.

25.84.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.
25.84.4 Corresponding analysis keywords

*SWELLING

25.85

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

25.85.1

TensionStiffening(...)

This method creates a TensionStiffening object.

25–171

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

If type=DISPLACEMENT, the table data specify the following:

Return value

A TensionStiffening object.
Exceptions

RangeError.

25–172

TriaxialTestData object

25.85.2

setValues(...)

This method modifies the TensionStiffening object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the TensionStiffening method.
Return value

None
Exceptions

RangeError.

25.85.3

Members

The TensionStiffening object has members with the same names and descriptions as the arguments to the TensionStiffening method.
25.85.4 Corresponding analysis keywords

*TENSION STIFFENING

25.86

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

25.86.1

TriaxialTestData(...)

This method creates a TriaxialTestData object.

25–173

TriaxialTestData object

Path

mdb.models[name].materials[name].druckerPrager.TriaxialTestData session.odbs[name].materials[name].druckerPrager.TriaxialTestData
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.

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

25–174

Trs object

Return value

None
Exceptions

RangeError.

25.86.3

Members

The TriaxialTestData object has members with the same names and descriptions as the arguments to the TriaxialTestData method.
25.86.4 Corresponding analysis keywords

*TRIAXIAL TEST DATA

25.87

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 import odbMaterial session.odbs[name].materials[name].viscoelastic.trs

25.87.1

Trs(...)

This method creates a Trs object.
Path

mdb.models[name].materials[name].viscoelastic.Trs session.odbs[name].materials[name].viscoelastic.Trs
Required arguments

None.
Optional arguments

table A sequence of sequences of Floats specifying the items described below. The default value is the empty table.

25–175

Trs object

This argument is valid only when definition=WLF. definition This argument applies only to ABAQUS/Standard analyses. A SymbolicConstant specifying the definition of the shift function. Possible values are WLF and USER. The default value is WLF. Table data

• • •

Reference temperature, . Calibration constant, . Calibration constant, .

Return value

A Trs object.
Exceptions

None.

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

25.87.3
25.87.4

Members
Corresponding analysis keywords

The Trs object has members with the same names and descriptions as the arguments to the Trs method.

*TRS

25–176

UniaxialTestData object

25.88

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 import odbMaterial session.odbs[name].materials[name].hyperelastic.uniaxialTestData session.odbs[name].materials[name].hyperfoam.uniaxialTestData

25.88.1

UniaxialTestData(...)

This method creates a UniaxialTestData object.
Path

mdb.models[name].materials[name].hyperelastic.UniaxialTestData mdb.models[name].materials[name].hyperfoam.UniaxialTestData session.odbs[name].materials[name].hyperelastic.UniaxialTestData session.odbs[name].materials[name].hyperfoam.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. The default value is None, for no smoothing. 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,

.

25–177

UniaxialTestData object

• • • •

Nominal strain,

.

For a hyperfoam material model, the table data specify the following: Nominal stress, Nominal strain, . . . The default value is 0.

Nominal lateral strain,

Return value

A UniaxialTestData object.
Exceptions

None.

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

25.88.3

Members

The UniaxialTestData object has members with the same names and descriptions as the arguments to the UniaxialTestData method.
25.88.4 Corresponding analysis keywords

*UNIAXIAL TEST DATA

25–178

UserDefinedField object

25.89

UserDefinedField object

The UserDefinedField object redefines field variables at a material point.

Access

import material mdb.models[name].materials[name].userDefinedField import odbMaterial session.odbs[name].materials[name].userDefinedField

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

None

Exceptions

None.

25.89.2

Members

The UserDefinedField object has no members.
25.89.3 Corresponding analysis keywords

*USER DEFINED FIELD

25–179

UserMaterial object

25.90

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 import odbMaterial session.odbs[name].materials[name].userMaterial

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

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

25–180

UserOutputVariables object

Return value

A UserMaterial object.
Exceptions

RangeError.

25.90.2

setValues(...)

This method modifies the UserMaterial object.
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.

25.90.3

Members

The UserMaterial object has members with the same names and descriptions as the arguments to the UserMaterial method.
25.90.4 Corresponding analysis keywords

*USER MATERIAL

25.91

UserOutputVariables object

The UserOutputVariables object specifies the number of user-defined output variables.
Access

import material mdb.models[name].materials[name].userOutputVariables

25–181

UserOutputVariables object

import odbMaterial session.odbs[name].materials[name].userOutputVariables

25.91.1

UserOutputVariables(...)

This method creates a UserOutputVariables object.
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.

25.91.2

setValues(...)

This method modifies the UserOutputVariables object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues UserOutputVariables method.
Return value

are

the

same

as

the

arguments

to

the

None

25–182

VelocityDependence object

Exceptions

RangeError.

25.91.3

Members

The UserOutputVariables object has members with the same names and descriptions as the arguments to the UserOutputVariables method.
25.91.4 Corresponding analysis keywords

*USER OUTPUT VARIABLES

25.92

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

25.92.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, .

25–183

Viscoelastic object

Return value

A VelocityDependence object.
Exceptions

RangeError.

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

25.92.3

Members

The VelocityDependence object has members with the same names and descriptions as the arguments to the VelocityDependence method.
25.92.4 Corresponding analysis keywords

*PERMEABILITY

25.93

Viscoelastic object

The Viscoelastic object specifies dissipative behavior for use with elasticity.
Access

import material

25–184

Viscoelastic object

mdb.models[name].materials[name].viscoelastic import odbMaterial session.odbs[name].materials[name].viscoelastic

25.93.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 (for an ABAQUS/Standard analysis only) and TIME. 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. 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. errtol A Float specifying the allowable average root-mean-square error of the data points in the leastsquares fit. The default value is 0.01 (1%). 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 default and maximum 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_DATAor RELAXATION_TEST_DATA.

25–185

Viscoelastic object

Table data

If frequency=FORMULA, the table data 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. Real part of Imaginary part of Real part of Imaginary part of ignored. Frequency in cycles per time. . . . If the material is incompressible, this value is ignored. . If the material is incompressible, this value is

If frequency=TABULAR or time=FREQUENCY_DATA the table data specify the following:

If time=PRONY or frequency=PRONY, the table data 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.

Return value

A Viscoelastic object.
Exceptions

RangeError.

25.93.2

setValues(...)

This method modifies the Viscoelastic object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the Viscoelastic method.

25–186

Viscous object

Return value

None
Exceptions

RangeError.

25.93.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.
25.93.4 Corresponding analysis keywords

*VISCOELASTIC

25.94

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

25.94.1

Viscous(...)

This method creates a Viscous object.

25–187

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.

Return value

A Viscous object.

25–188

VoidNucleation object

Exceptions

None.

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

25.94.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.
25.94.4 Corresponding analysis keywords

*VISCOUS

25.95

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

25–189

VoidNucleation object

session.odbs[name].materials[name].porousMetalPlasticity.voidNucleation

25.95.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. Etc.

Return value

A VoidNucleation object.
Exceptions

RangeError.

25.95.2

setValues(...)

This method modifies the VoidNucleation object.

25–190

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

25.95.3

Members

The VoidNucleation object has members with the same names and descriptions as the arguments to the VoidNucleation method.
25.95.4 Corresponding analysis keywords

*VOID NUCLEATION

25.96

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

25.96.1

VolumetricTestData(...)

This method creates a VolumetricTestData object.

25–191

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 A Float specifying a normalized volumetric value that depends on the value of the time member of the ViscoElastic object. 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, . The default value is None. This argument is valid only for a viscoelastic material model. smoothing None or an Int specifying the value for smoothing. The default value is None, for no smoothing. 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 . Normalized volumetric (bulk) compliance .

.

If time=CREEP_TEST_DATA, the table data specify the following:

25–192

evaluateMaterial



Time

.

Return value

A VolumetricTestData object.
Exceptions

None.

25.96.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.
Return value

None
Exceptions

None.

25.96.3

Members

The VolumetricTestData object has members with the same names and descriptions as the arguments to the VolumetricTestData method.
25.96.4 Corresponding analysis keywords

*VOLUMETRIC TEST DATA

25.97

evaluateMaterial

This command evaluates the behavior of a hyperelastic material under standard test conditions.
Access

import material

25–193

evaluateMaterial

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

Note: Although uniaxialStrain, biaxialStrain, planarStrain, volumeRatio, and simpleShearStrain are optional arguments, at least one of them must be specified with a nonzero value. 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. 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. uniaxialStrain A Float specifying the nominal strain to be applied in the uniaxial tension test. biaxialStrain A Float specifying the nominal strain to be applied in the biaxial tension test.

25–194

evaluateMaterial

planarStrain A Float specifying the nominal strain to be applied in the planar test. The planar test is equivalent to a pure shear test. volumeRatio A Float specifying the the compressive volume ratio. simpleShearStrain A Float specifying the nominal strain to be applied in the simple shear test.
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.

25–195

Mdb object

26.
26.1

Mdb commands
Mdb object

The Mdb object is the high-level ABAQUS model database. A model database stores models and analysis jobs.
Access

mdb

26.1.1

Mdb(...)

This method creates an empty Mdb object.
Path

Mdb
Required arguments

None.
Optional arguments

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 the empty string. compression A Boolean specifying whether to use compression when saving the model database to a file. The default value is ON.
Return value

An Mdb object.
Exceptions

None.

26.1.2

openMdb(...)

This method opens an existing model database file.

26–1

Mdb object

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. If the file contains an old model database version: MdbError: incompatible version number, expected <ABAQUS release version>, got <database le version> If the version number of the model database indicates that it is more recent than the model database version supported by this version of ABAQUS/CAE: MdbError: incompatible version number, expected <ABAQUS release version>, got <database le version> 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...

26.1.3

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

None.
Return value

None

26–2

Mdb object

Exceptions

None.

26.1.4

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

26.1.5

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

None.
Return value

None

26–3

Mdb object

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

26.1.6

setValues(...)

This method modifies an Mdb object.
Arguments Required arguments

None.
Optional argument

compression A Boolean specifying whether to use compression when saving the model database to a file.
Return value

None
Exceptions

None.

26.1.7

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 A Long specifying the version number of the Mdb object in memory. lastChangedCount A Double 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. models A repository of Model objects. customData A RepositorySupport object.

26–4

Mdb commands

annotations A repository of Annotation objects.

26.2

Mdb commands

The following command upgrades a model database (.mdb) to the current version and writes the upgraded version to a new file.

26.2.1

upgradeMdb(...)

This method upgrades an existing Mdb object to the current version 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 (upgradeMdbPath.log).
Path

upgradeMdb
Arguments Required arguments

existingMdbPath A String specifying the path to the file containing the model database to be upgraded. upgradeMdbPath 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

26–5

Assembly object

27.

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.

27.1

Assembly object

The following commands operate on Assembly objects. For more information about the Assembly object, see “Assembly object,” Section 4.1.
Access

import mesh

27.1.1

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.

27.1.2

deletePreviewMesh(...)

This method deletes all preview meshes in the assembly. See the boundaryPreview argument of generateMesh for information about generating preview meshes.

27–1

Assembly object

Arguments

None.
Return value

None
Exceptions

None.

27.1.3

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.

27.1.4

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.

27–2

Assembly object

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. Currently this option will only have an effect if any of the specified regions are to be meshed with tetrahedral elements; in this case the generated mesh will be a triangular preview mesh. The default value is OFF.
Return value

None
Exceptions

None.

27.1.5

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 NUMBER AVERAGE_SIZE BIAS_RATIO VERTEX_ADJ_TO_SMALLEST_ELEM CONSTRAINT

The return value is dependent on the attribute argument.

27–3

Assembly object



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 BIASED 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=BIAS_RATIO, the return value is a Float specifying the length ratio of the largest element to the smallest element. 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=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.

27.1.6

getElementType(...)

This method returns the ElemType object of a given element shape assigned to a region of the assembly.

27–4

Assembly object

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:

• • • • • •
None.

LINE QUAD TRI HEX WEDGE TET

Optional arguments

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.

27.1.7

getMeshControl(...)

This method returns a mesh control parameter for the specified region of the assembly.
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

27–5

Assembly object

• •

MIN_TRANSITION 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

The return value is dependent on the attribute argument.



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 algorithm=MEDIAL_AXIS. – Structured quadrilateral meshing. or sweep hexahedral meshing with

Optional arguments

None.

27–6

Assembly object

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.

27.1.8

getMeshStats(...)

This method returns the mesh statistics for the given part instances or regions.
Arguments Required argument

regions A sequence of PartInstance objects or Region objects specifying the part instances or regions for which mesh statistics should be returned. The part instances can be geometric parts or orphan mesh parts.
Optional arguments

None.
Return value

A MeshStats object.
Exceptions

None.

27.1.9

getPartSeed(...)

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

27–7

Assembly object

• • • • •

DEVIATION_FACTOR MIN_SIZE_FACTOR If attribute=SIZE, the return value is a Float specifying the desired global element size. If part seeds are not defined, the return value is zero. 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.

The return value is dependent on the value of the attribute argument.

Optional arguments

None.
Return value

The return value is a Float, and its value is dependent on the attribute argument.
Exceptions

None.

27.1.10

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.

27–8

Assembly object

27.1.11

queryMeshQuality(...)

This method outputs basic statistics on the mesh quality.
Arguments Required arguments

region A tuple of PartInstance objects specifying the part instances where to test. criterion A SymbolicConstant specifying the mesh quality criterion to test. Possible values are: ASPECT_RATIO The mesh quality criterion to be applied is based on element’s aspect ratio. ANGULAR_DEVIATION The maximum amount (in degrees) that the element deviates from the ideal angle. The ideal angle is 90° for quadrilateral elements, 60° for triangular elements, etc. SMALL_ANGLE The mesh quality criterion to be applied is based on small element face angles. LARGE_ANGLE The mesh quality criterion to be applied is based on large element face angles. SHAPE_FACTOR The mesh quality criterion to be applied is based on element’s shape factor. This criterion is only applicable to triangular and tetrahedral elements. Shape factor is the ratio between the element’s area (or volume) and the area (or volume) of an equilateral triangle (or tet) with the same circumradius as the element. SHORTEST_EDGE The mesh quality criterion to be applied is based on element’s shortest edge. ANALYSIS_CHECKS The mesh quality criteria to be applied are the same as the mesh quality criteria included with the input file processor in ABAQUS/Standard or ABAQUS/Explicit.
Optional arguments

None.

27–9

Assembly object

Return value

If criterion is not equal to ANALYSIS_CHECKS, an array of two Floats containing the average value and the worst value is returned. If criterion is equal to ANALYSIS_CHECKS, an array of two Ints containing the number of elements errors and the number of warnings is returned.
Exceptions

None.

27.1.12

seedEdgeByBias(...)

This method seeds the given edges nonuniformly using the specified number of elements and bias ratio.
Arguments Required arguments

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

constraint A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The initial 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).

27–10

Assembly object

Return value

None
Exceptions

None.

27.1.13

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
Optional argument

number

104 .

constraint A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The initial 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.

27.1.14

seedEdgeBySize(...)

This method seeds the given edges uniformly based on the desired element size.

27–11

Assembly object

Arguments Required arguments

edges A sequence of Edge objects specifying the edges to seed. size A Float specifying the desired element size.
Optional argument

constraint A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The initial 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.

27.1.15

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

, where

is the chordal deviation and

is the element

27–12

Assembly object

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 initial value is FREE. If unspecified, the existing constraint will remain unchanged. Possible values are:

• •
None

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

Exceptions

None.

27.1.16

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.

27–13

Assembly object

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.

27.1.17

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.

27.1.18

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

27–14

Assembly object

• • • • • •

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 initial 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. 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 Version 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 initial 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.

27–15

Assembly object

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.
Return value

None
Exceptions

None.

27.1.19

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

None.
Return value

None
Exceptions

None.

27–16

Part object

27.2

Part object

The following commands operate on Part objects. For more information about the Part object, see “Part object,” Section 32.1.
Access

import mesh

27.2.1

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.

27.2.2

deletePreviewMesh(...)

This method deletes all preview meshes in the parts. See the boundaryPreview argument of generateMesh for information about generating preview meshes.
Arguments

None.
Return value

None

27–17

Part object

Exceptions

None.

27.2.3

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.

27.2.4

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

27–18

Part object

boundaryPreview A Boolean specifying whether the generated mesh should be a boundary preview mesh. Currently this option will only have affect if any of the specified regions are to be meshed with tetrahedral elements, whereby the generated mesh will be a triangular preview mesh. The default value is OFF.
Return value

None
Exceptions

None.

27.2.5

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 NUMBER AVERAGE_SIZE BIAS_RATIO VERTEX_ADJ_TO_SMALLEST_ELEM CONSTRAINT 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 BIASED NONE

The return value is dependent on the value of the attribute argument.

27–19

Part object

• • • • •

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=BIAS_RATIO, the return value is a Float specifying the length ratio of the largest element to the smallest element. 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 =BIASED. 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.

27.2.6

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:

27–20

Part object

• • • • • •
None.

LINE QUAD TRI HEX WEDGE TET

Optional arguments

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.

27.2.7

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 If attribute=ELEM_SHAPE, the return value is a SymbolicConstant specifying the element shape used during meshing. Possible values are: – LINE – QUAD – TRI

The return value depends on the value of the attribute argument.

27–21

Part object

– – – – –

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 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 algorithm=MEDIAL_AXIS. – Structured quadrilateral meshing. or sweep hexahedral meshing with

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.

27–22

Part object

27.2.8

getMeshStats(...)

This method returns the mesh statistics for the given parts or regions.
Arguments Required argument

regions A sequence of Part objects or Region objects specifying the parts or regions for which mesh statistics should be returned. The parts can be geometric parts or orphan mesh parts.
Optional arguments

None.
Return value

A MeshStats object.
Exceptions

None.

27.2.9

getPartSeed(...)

This method returns a part seed parameter for the part.
Arguments Required arguments

attribute A SymbolicConstant specifying the type of part seed attribute to return. Possible values are:

• • • • • •

SIZE DEVIATION_FACTOR MIN_SIZE_FACTOR If attribute=SIZE, the return value is a Float specifying the desired global element size. If part seeds are not defined, the return value is zero. 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.

The return value depends on the value of the attribute argument.

27–23

Part object

Optional arguments

None.
Return value

The return value is a Float that depends on the value of the attribute argument.
Exceptions

None.

27.2.10

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.

27.2.11

queryMeshQuality(...)

This method outputs basic statistics on the mesh quality.
Arguments Required arguments

criterion A SymbolicConstant specifying the mesh quality criterion to test. Possible values are: ASPECT_RATIO The mesh quality criterion to be applied is based on element’s aspect ratio.

27–24

Part object

ANGULAR_DEVIATION The maximum amount (in degrees) that the element deviates from the ideal angle. The ideal angle is 90° for quadrilateral elements, 60° for triangular elements, etc. SMALL_ANGLE The mesh quality criterion to be applied is based on small element face angles. LARGE_ANGLE The mesh quality criterion to be applied is based on large element face angles. SHORTEST_EDGE The mesh quality criterion to be applied is based on element’s shortest edge. SHAPE_FACTOR The mesh quality criterion to be applied is based on element’s shape factor. This criterion is only applicable to triangular and tetrahedral elements. Shape factor is the ratio between the element’s area (or volume) and the area (or volume) of an equilateral triangle (or tet) with the same circumradius as the element. ANALYSIS_CHECKS The mesh quality criteria to be applied are the same as the mesh quality criteria included with the input file processor in ABAQUS/Standard or ABAQUS/Explicit.
Optional arguments

None.
Return value

If criterion is not equal to ANALYSIS_CHECKS, an array of two Floats containing the average value and the worst value is returned. If criterion is equal to ANALYSIS_CHECKS, an array of two Ints containing the number of elements errors and the number of warnings is returned.
Exceptions

None.

27.2.12

seedEdgeByBias(...)

This method seeds the given edges nonuniformly using the specified number of elements and bias ratio.

27–25

Part object

Arguments Required arguments

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

number

104 .

constraint A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The initial 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.

27.2.13

seedEdgeByNumber(...)

This method seeds the given edges uniformly based on the number of elements along the edges.

27–26

Part object

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
Optional argument

number

104 .

constraint A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The initial 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.

27.2.14

seedEdgeBySize(...)

This method seeds the given edges uniformly 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 argument

constraint A SymbolicConstant specifying how closely the seeds must be matched by the mesh. The initial 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.

27–27

Part object



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.

27.2.15

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. 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 initial value is FREE. If unspecified, the existing constraint will remain unchanged. Possible values are:

• •
None

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

Exceptions

None.

27–28

Part object

27.2.16

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

27.2.17

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.

27–29

Part object

Optional arguments

None.
Return value

None
Exceptions

None.

27.2.18

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

27–30

Part object

• •

SWEEP: Sweep mesh technique. 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 Version 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 initial value is ON. If unspecified, the existing value will remain unchanged. This option is applicable only in the following cases:

• •
None

Free quadrilateral meshing or hexahedral sweep meshing with algorithm=MEDIAL_AXIS. Structured quadrilateral meshing.

Return value

Exceptions

None.

27.2.19

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.

27–31

ElemType object

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.

27.3

ElemType object

The ElemType object is an argument object used as an argument in the setElementType command.
Access

import mesh

27.3.1

ElemType(...)

This method creates an ElemType object.
Path

ElemType
Required argument

elemCode A SymbolicConstant specifying the ABAQUS element code (e.g., C3D8R) or one of the following:

• • • •

UNKNOWN_TRI: Unknown element type associated with a triangular shape. UNKNOWN_QUAD: Unknown element type associated with a quadrilateral shape. UNKNOWN_HEX: Unknown element type associated with a hexahedral shape. UNKNOWN_WEDGE: Unknown element type associated with a wedge shape.

27–32

ElemType object



UNKNOWN_TET: 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 library is STANDARD if applicable. hourglassStiffness This argument is applicable only to some ABAQUS/Standard elements. 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. bendingHourglass This argument is applicable only to some ABAQUS/Standard elements. 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. drillingHourglass This argument is applicable only to some ABAQUS/Standard elements. 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. kinematicSplit This argument is applicable only to some ABAQUS/Explicit elements. A SymbolicConstant specifying the kinematic split control. Possible values are AVERAGE_STRAIN, ORTHOGONAL, and CENTROID. The default value, AVERAGE_STRAIN, will be used where appropriate. distortionControl This argument is applicable only to some ABAQUS/Explicit elements. A Boolean specifying whether to prevent negative element volumes or other excessive distortions in crushable materials. The default value is OFF. lengthRatio This argument is applicable only when distortionControl is ON. A Float used to define the length ratio for distortion control in crushable materials. Possible values are 0.0 lengthRatio 1.0. The default value is lengthRatio= secondOrderAccuracy This argument is applicable only to some ABAQUS/Explicit elements. A Boolean specifying the second-order accuracy option. The default is OFF. hourglassControl This argument is applicable only to some ABAQUS/Explicit elements. A SymbolicConstant specifying the hourglass control. Possible values are RELAX_STIFFNESS, STIFFNESS, VISCOUS, ENHANCED, and COMBINED. The default value is ENHANCED and it will be used where appropriate.

27–33

MeshEdge object

weightFactor This argument is applicable only to some ABAQUS/Explicit elements. A Float specifying a weight factor when hourglassControl=COMBINED. The default value is 0.5 and it will be used where appropriate. displacementHourglass This argument is applicable only to some ABAQUS/Explicit elements. A Float specifying the displacement hourglass scaling factor. The default value will be used where appropriate. rotationalHourglass This argument is applicable only to some ABAQUS/Explicit elements. A Float specifying the rotational hourglass scaling factor. The default value will be used where appropriate. outOfPlaneDisplacementHourglass This argument is applicable only to some ABAQUS/Explicit elements. A Float specifying the out-of-plane displacement hourglass scaling factor. The default value will be used where appropriate.
Return value

None
Exceptions

None.

27.3.2

Members

The ElemType object has members with the same names and descriptions as the arguments to the ElemType method.

27.4

MeshEdge object

The MeshEdge object has no constructor, methods, or members.
Access

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

27–34

MeshElement object

27.4.1

Members

The MeshEdge object has no members.

27.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].elements[i] import assembly mdb.models[name].rootAssembly.instances[name].elements[i]

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

27–35

MeshNode object

27.5.2
label

Members

The MeshElement object has the following members: An Int specifying the element label. connectivity A sequence of Ints specifying the internal node indices that define the nodal connectivity. type A String specifying the ABAQUS element code. instanceName A String specifying the name of the part instance that owns this element.

27.6

MeshFace object

The MeshFace object has no constructor, methods, or members.
Access

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

27.6.1

Members

The MeshFace object has no members.

27.7

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].nodes[i] import assembly mdb.models[name].rootAssembly.instances[name].nodes[i]

27–36

MeshStats object

27.7.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 argument

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.

27.7.2
label

Members

The MeshNode object has the following members: An Int specifying the node label. coordinates A sequence of Floats specifying the coordinates of the node. instanceName A String specifying the name of the part instance that owns this node.

27.8

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.

27–37

MeshStats object

Access

import mesh

27.8.1

Members

The MeshStats object has the following members: numPointElems An Int specifying the number of point elements. 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.

27–38

MonitorMgr object

28.

Messaging commands
Messaging commands are available only if ABAQUS/CAE is run interactively using the GUI.

28.1

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

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

28–1

MonitorMgr object

• • • • • • • • • • • • • • • •

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

28–2

MonitorMgr object

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

28–3

MonitorMgr object



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.

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

28.1.4

Members

The MonitorMgr object has no members.

28–4

DataObject object

28.2

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

• • •
ERROR

message

COMPLETED message

END_STEP stepId

• • • • • • • • •

message

HEADING heading

MONITOR_DATA dof node nset procedure time value

ODB_FILE file

28–5

DataObject object

STARTED


STATUS

No additional members.

• • • • • • • • •
STEP

attempts equilibrium increment iterations severe step stepTime timeIncrement totalTime

• • •
28.2.1

stepId stepName

WARNING message

Members

The DataObject object has the following members: 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”. phase A SymbolicConstant specifying the phase of the analysis. Possible values are BATCHPRE_PHASE, PACKAGER_PHASE, STANDARD_PHASE, EXPLICIT_PHASE, and CALCULATOR_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.

28–6

DataObject object

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. file A String specifying the full path of the output database. heading A String specifying the job heading. increment An Int specifying the increment of the analysis. iterations An Int specifying the number of iterations in the step. message A String specifying the job heading. node An Int specifying the node number requested for monitoring output. nset A String specifying the node set specified 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. stepName A String specifying the name 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.

28–7

DataObject object

value A Float specifying the current value of the degree of freedom requested for monitoring.

28–8

Model object

29.

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.

29.1

Model object

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

mdb.models[name]

29.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 the empty string. stefanBoltzmann A Float specifying the Stefan-Boltzman constant. The default value is None. absoluteZero A Float specifying the absolute zero constant. The default value is None.
Return value

A Model object.
Exceptions

None.

29–1

Model object

29.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 name of the new Model object. 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.

29.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 name of the new Model object. 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.

29–2

Model object

Optional arguments None. Return value

A Model object.
Exceptions

None.

29.1.4

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 the empty string. noPartsInputFile A Boolean specifying whether an input file should be written without parts and assemblies. The default value is OFF. absoluteZero A Float specifying the absolute zero constant. The default value is None. stefanBoltzmann A Float specifying the Stefan-Boltzman 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 analyis will start. restartIncrement An Int specifying the increment 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.

29–3

Model object

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.

29.1.5

Methods()

Additional methods of the Model object are documented with the objects that are owned by the Model object; for example, the Sketch, Part, Assembly, Material, and Step objects.
Arguments

None.
Return value

None
Exceptions

None.

29.1.6

Members

The Model object has members with the same names and descriptions as the arguments to the Model method. In addition, the Model object can have the following members: noPartsInputFile A Boolean specifying whether an input file should be written without parts and assemblies. The default value is OFF. 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 analyis will start. restartIncrement An Int specifying the increment where the restart analysis will start. To select the end of the step use the SymbolicConstant STEP_END.

29–4

Model object

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. lastChangedCount A Float specifying the time stamp that indicates when the model was last changed. 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. connectors A repository of Connector objects. connectorProperties A repository of ConnectorProperty objects. constraints A repository of Constraint objects. fields A repository of Field objects. interactions A repository of Interaction objects. interactionProperties A repository of InteractionProperty objects. contactControls A repository of ContactControl objects. loads A repository of Load objects. materials A repository of Material objects.

29–5

KeywordBlock object

sections A repository of Section objects. sketches A repository of Sketch objects. parts A repository of Part objects. steps A repository of Step objects. featureOptions A FeatureOptions object. adaptiveMeshControls A repository of AdaptiveMeshControl objects. filters A repository of Filter objects. integratedOutputSections A repository of IntegratedOutputSection objects. fieldOutputRequest A repository of FieldOutputRequest objects. historyOutputRequest A repository of HistoryOutputRequest objects.
29.1.7 Corresponding analysis keywords

*PHYSICAL CONSTANTS

29.2

KeywordBlock object

You use the KeywordBlock object to add ABAQUS/Standard or ABAQUS/Explicit functionality that is not supported by ABAQUS/CAE to the input file. The following three versions of the input file exist within ABAQUS/CAE:

• • •

the Input Editor file: the sieBlocks member of the KeywordBlock object; the ABAQUS Input File: the aifText member of the KeywordBlock object; and an input file generated during an interaction with ABAQUS/CAE.

The KeywordBlock object contains a list of blocks from the ABAQUS/CAE Keywords Editor. A block is an ABAQUS/Standard or ABAQUS/Explicit keyword along with the parameters and data lines associated with the keyword. A block can also be a comment. 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.

29–6

KeywordBlock object

Access

mdb.models[name].keywordBlock

29.2.1

setValues(...)

This method modifies the KeywordBlock object.
Arguments Required arguments

None.
Optional arguments

sieBlocks A list of Strings. Each String is a block that specifies a keyword and the parameters and data lines associated with the keyword. aifText A String containing the latest version of the input file generated by the model prior to the merge with the Keywords Editor. edited A Boolean specifying whether the Keywords Editor has been used to change the model. If edited=TRUE and you do not specify values for sieBlocks and aifText, any existing values of sieBlocks and aifText will be removed from the KeywordBlock object. If edited=FALSE, any existing values of sieBlocks and aifText in the KeywordBlock object will be removed, regardless of whether they are specified or not. The edited value is set to TRUE by the insert and replace methods.

Return value

None

Exceptions

None.

29.2.2

insert(...)

This method inserts a keyword block in an input file at a specified position.

29–7

KeywordBlock object

Arguments Required arguments

position An Int specifying the position of the keyword block after which the new block should be inserted. text A String specifying the keyword block to be inserted.
Optional arguments

None.
Return value

None
Exceptions

IndexError.

29.2.3

replace(...)

This method replaces a specified keyword block with a new keyword block.
Arguments Required arguments

position An Int specifying the position of the keyword block to be replaced. text A String specifying the replacement keyword block.
Optional arguments

None.
Return value

None
Exceptions

IndexError.

29–8

KeywordBlock object

29.2.4

synchVersions()

This method merges the input file resulting from changes made in the Keywords Editor with that resulting from interactions with the ABAQUS/CAE modules. After you execute the synchVersions command, ABAQUS stores the modules version in aifText and the merged result in sieBlocks. In addition, ABAQUS sets lastSynchCount to the current value of the counter associated with the Mdb object.
Arguments

None.
Return value

None
Exceptions

None.

29.2.5

Members

The KeywordBlock object has the following members: sieBlocks A list of Strings. Each String is a block that specifies a keyword and the parameters and data lines associated with the keyword. aifText A String containing the latest version of the input file generated by the model prior to the merge with the Keywords Editor. edited A Boolean specifying whether the Keywords Editor has been used to change the model. lastSynchCount A Float indicating the value of the counter associated with the Mdb object at the most recent synchronization.

29–9

Odb object

30.

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.

30.1

Odb object

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

import odbAccess session.odbs[name]

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

30–1

Odb object

Exceptions

None.

30.1.2

close()

This method closes an output database.
Arguments

None.
Return value

None
Exceptions

None.

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

30–2

Odb object

Exceptions

If the exact frame is not found: AbaqusException: Frame not found.

30.1.4

save()

This method saves output to an output database (.odb) file.
Arguments Required arguments

None.
Optional argument Return value

None
Exceptions

AbaqusError Database save failed. The database was opened as read-only. Modification of data is not permitted.

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

30–3

FieldLocation object

30.1.6

Members

The Odb object has members with the same names and descriptions as the arguments to the Odb method. In addition, the Odb object can have the following members: isReadOnly A Boolean specifying whether the output database was opened with read-only access. 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 An UserData object. profiles A repository of Profile objects.

30.2

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]

30–4

FieldOutput object

30.2.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. 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 An array of SectionPoint objects.

30.3

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]

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

30–5

FieldOutput object

type A SymbolicConstant specifying the output type. Possible values are SCALAR, VECTOR, TENSOR_3D_FULL, TENSOR_3D_PLANAR, TENSOR_3D_SURFACE, TENSOR_2D_PLANAR, 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’, ’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. Possible values are MAGNITUDE, MISES, TRESCA, PRESS, INV3, MAX_PRINCIPAL, MID_PRINCIPAL, MIN_PRINCIPAL, MAX_INPLANE_PRINCIPAL, MIN_INPLANE_PRINCIPAL, and OUTOFPLANE_PRINCIPAL. An empty sequence indicates that no invariants are valid for this field. The default value is an empty sequence.
Return value

A FieldOutput object.
Exceptions

None.

30.3.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 output variable name. description A String specifying the output variable.

30–6

FieldOutput object

Return value

A FieldOutput object.
Exceptions

None.

30.3.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 V, “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

30–7

FieldOutput object

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 AbaqusException. For example, if the local coordinate system is specified for scalar data: AbaqusException: Transformation not allowed for scalar data.

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

30–8

FieldOutput object

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 V, “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 AbaqusException. For example, if the local coordinate system is specified for scalar data: AbaqusException: Transformation not allowed for scalar data.

30.3.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.
Return value

None

30–9

FieldOutput object

Exceptions

The addData method throws many exceptions of type AbaqusException. For example, if the local coordinate system is specified for scalar data: AbaqusException: Transformation not allowed for scalar data.

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

invariant A SymbolicConstant specifying the invariant. Possible values are MAGNITUDE, MISES, TRESCA, PRESS, INV3, MAX_PRINCIPAL, MID_PRINCIPAL, and MIN_PRINCIPAL.
Optional arguments

None.
Return value

A FieldOutput object.
Exceptions

None.

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

componentLabel A String specifying the component label, such as “S11”.

30–10

FieldOutput object

Optional arguments None. Return value

A FieldOutput object.
Exceptions

None.

30.3.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.
Return value

A FieldOutput object.
Exceptions

None.

30.3.9

getSubset(...)

A FieldOutput object with a subset of the field values.

30–11

FieldOutput object

Arguments Required arguments

None.
Optional arguments

region An OdbSet specifying the region for which to extract values.
Return value

A FieldOutput object.
Exceptions

None.

30.3.10

getSubset(...)

A FieldOutput object with a subset of the field values.
Arguments Required arguments

None.
Optional arguments

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.
Return value

A FieldOutput object.
Exceptions

None.

30.3.11

getSubset(...)

A FieldOutput object with a subset of the field values.
Arguments Required arguments

None.

30–12

FieldOutput object

Optional arguments sectionPoint A SectionPoint object. Return value

A FieldOutput object.
Exceptions

None.

30.3.12

getSubset(...)

A FieldOutput object with a subset of the field values.
Arguments Required arguments

None.
Optional arguments

location A FieldLocation object.
Return value

A FieldOutput object.
Exceptions

None.

30.3.13

getSubset(...)

A FieldOutput object with a subset of the field values.
Arguments Required arguments

None.
Optional arguments

region An OdbMeshElement specifying the region for which to extract values.

30–13

FieldOutput object

Return value

A FieldOutput object.
Exceptions

None.

30.3.14

getSubset(...)

A FieldOutput object with a subset of the field values.
Arguments Required arguments

None.
Optional arguments

region An OdbMeshNode specifying the region for which to extract values.
Return value

A FieldOutput object.
Exceptions

None.

30.3.15

getSubset(...)

A FieldOutput object with a subset of the field values.
Arguments Required arguments

None.
Optional arguments

region An OdbInstance specifying the region for which to extract values.
Return value

A FieldOutput object.

30–14

FieldOutput object

Exceptions

None.

30.3.16

getSubset(...)

A FieldOutput object with a subset of the field values.
Arguments Required arguments

None.
Optional arguments

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.

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

30–15

FieldOutput object

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.

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

30–16

FieldOutput object

Exceptions

None.

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

30–17

FieldValue object

30.3.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 An array of FieldLocation objects. values An array of FieldValue objects. The order of the objects is determined by the ABAQUS Scripting Interface; see the data argument to theaddData method for a description of the order.

30.4

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 9.10.7 of the ABAQUS Scripting User’s Manual.
Access

import odbAccess session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]

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

30–18

FieldValue object



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. 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, TENSOR_2D_SURFACE. data A sequence 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 sequence of Doubles 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. conjugateData A sequence 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 sequence of Doubles 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.

30–19

FieldValue object

magnitude A Float specifying the length or magnitude of the vector. type=VECTOR. mises

magnitude is valid only when

A Float specifying the calculated von Mises stress. The value is valid only when the validInvariants member includes MISES; otherwise, the value is indeterminate. tresca A Float specifying the calculated Tresca stress. The value is valid only when the validInvariants member includes TRESCA; otherwise, the value is indeterminate. press A Float specifying the calculated pressure stress. The value is valid only when the validInvariants member includes PRESS; otherwise, the value is indeterminate. 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. 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. 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. minPrincipal A Float specifying the the minimum principal stress. The value is valid only when the validInvariants member includes MIN_PRINCIPAL; otherwise, the value is indeterminate. 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. 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. 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. instance An OdbInstance object specifying the part to which the labels belong.

30–20

HistoryOutput object

sectionPoint A SectionPoint object. localCoordSystem A sequence of sequences 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 sequence of sequences of Doubles 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.

30.5

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]

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

30–21

HistoryOutput object

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.
Return value

A HistoryOutput object.
Exceptions

None.

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

30.5.3

addData(...)

This method adds data to the data member of the HistoryOutput object.

30–22

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

30.5.4

addData(...)

This method adds data to the data member of the HistoryOutput object.
Arguments Required argument

data A sequence of sequences of Floats specifying the pairs (frame, value) where value depends on the type of the output variable.
Optional arguments

None.
Return value

None
Exceptions

None.

30.5.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:

30–23

HistoryPoint object

data A sequence of pairs of Floats of the form (frameValue, value) specifying the values of the specified variable at each frame value (time, frequency, or mode). conjugateData A sequence of pairs of Floats of the form (frameValue, value) specifying the imaginary portion of a specified complex variable at each frame value (time, frequency, or mode).

30.6

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

30.6.1

HistoryPoint(...)

This method creates a HistoryPoint object for a node.
Path

session.odbs[name].steps[name].historyRegions[name].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.

30.6.2

HistoryPoint(...)

This method creates a HistoryPoint object for an element.

30–24

HistoryPoint object

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. sectionPoint A SectionPoint object.
Return value

A HistoryPoint object.
Exceptions

None.

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

30–25

HistoryRegion object

30.6.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.
Exceptions

None.

30.6.5

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

30.7

HistoryRegion object

The HistoryRegion object contains history data for a single location in the model.

30–26

HistoryRegion object

Access

import odbAccess session.odbs[name].steps[name].historyRegions[name]

30.7.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 An OdbLoadCase object specifying the load case associated with the HistoryRegion object, or None. The default value is None.
Return value

A HistoryRegion object.
Exceptions

None.

30.7.2

getSubset(...)

This method returns a subset of the data in the HistoryRegion object.
Arguments Required argument

variableName A String specifying the name of the output variable to return.

30–27

HistoryRegion object

Optional arguments

None.
Return value

A HistoryRegion object.
Exceptions

None.

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

30.7.4

getSubset(...)

This method returns a subset of the data in the HistoryRegion object.
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.

30–28

JobData object

Optional arguments None. Return value

A HistoryRegion object.
Exceptions

None.

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

30.8

JobData object

The JobData object describes the context in which the analysis was run.
Access

import odbAccess session.odbs[name].jobData

30.8.1
name

Members

The JobData object has the following members: A String specifying the name of the job. analysisCode A SymbolicConstant specifying the version of the analysis code. Possible values are ABAQUS_STANDARD, ABAQUS_EXPLICIT, and UNKNOWN_ANALYSIS_CODE. version A String specifying the version of the analysis code.

30–29

OdbAssembly object

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. precision A SymbolicConstant specifying the precision. Possible values are DOUBLE_PRECISION and SINGLE_PRECISION. Only SINGLE_PRECISION is currently supported.

30.9

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

30.9.1

deactivateInstance(...)

This method deactivates an instance on a step.
Arguments Required arguments

stepName A String specifying the Step in which the instance is deactivated. instance An Instance object.
Optional arguments

None.
Return value

None
Exceptions

None.

30–30

OdbConnector object

30.9.2

Members

The OdbAssembly object can have the following members: instances A repository of OdbInstance objects. nodeSets A repository of OdbSet objects containing nodes. elementSets A repository of OdbSet objects containing elements. surfaces A repository of OdbSet objects containing surfaces. nodes An array of OdbMeshNode objects. elements An array of OdbMeshElement objects. connectors A repository of OdbConnector objects. connectorProperties A repository of OdbConnectorProperty objects. datumCsyses A repository of OdbDatumCsys objects.

30.10

OdbConnector object

The OdbConnector object contains a connector that can be stored in an output database. You can create the connector during a ABAQUS/Viewer session and save the connector to the output database before you exit ABAQUS/Viewer. Alternatively, ABAQUS/Standard or ABAQUS/Explicit can write the connector to the output database during an analysis.
Access

import odbAccess session.odbs[name].rootAssembly.connectors[name]

30.10.1

Connector(...)

This method creates a OdbConnector object.

30–31

OdbConnectorProperty object

Path

session.odbs[name].rootAssembly.Connector
Required arguments

name A String specifying the repository key. node1 An OdbMeshNode object specifying the first node of the connector. node2 An OdbMeshNode object specifying the second node of the connector. orientation1 A DatumCsys object specifying the orientation at the first node. orientation2 A DatumCsys object specifying the orientation at the second node. property An OdbConnectorProperty object specifying the property used by this connector.
Optional arguments

None.
Return value

A OdbConnector object.
Exceptions

None.

30.10.2

Members

The OdbConnector object has members with the same names and descriptions as the arguments to the Connector method. In addition, the OdbConnector object has the following member: elementLabel An Int specifying the element label of the connector.

30.11

OdbConnectorProperty object

The OdbConnectorProperty object contains a connector property that can be stored in an output database. You can create the connector property during a ABAQUS/Viewer session and save the connector

30–32

OdbConnectorProperty object

property to the output database before you exit ABAQUS/Viewer. Alternatively, ABAQUS/Standard or ABAQUS/Explicit can write the connector property to the output database during an analysis.
Access

import odbAccess session.odbs[name].rootAssembly.connectorProperties[name]

30.11.1

ConnectorProperty(...)

This method creates an OdbConnectorProperty object.
Path

session.odbs[name].rootAssembly.ConnectorProperty
Required arguments

name A String specifying the repository key. assembledType A SymbolicConstant specifying the assembled connection type. ASSM_NONE, BEAM, CVJOINT, CYLINDRICAL_TYPE, TRANSLATOR, UJOINT, and WELD. Possible values are HINGE, PLANAR,

rotationalType A SymbolicConstant specifying the basic rotational connection type. Possible values are ROT_NONE, ALIGN, CARDAN,CONSTANT_VELOCITY, EULAR, FLEXION_TORSION, REVOLUTE, ROTATION, and UNIVERSAL. translationalType A SymbolicConstant specifying the assembled connection type. TRANS_NONE, AXIAL, CARTESIAN_TYPE, JOIN, LINK, SLIDE_PLANE, and SLOT.
Optional arguments

Possible values are RADIAL_THRUST,

None.
Return value

A OdbConnectorProperty object.
Exceptions

None.

30–33

OdbDatumCsys object

30.11.2

Members

The OdbConnectorProperty object has members with the same names and descriptions as the arguments to the ConnectorProperty method.

30.12

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]

30.12.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, or SPHERICAL. origin A sequence of Floats specifying the coordinates of the origin of the datum coordinate system. point1 A sequence of Floats specifying the corrdinates 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.

30–34

OdbDatumCsys object

Return value

An OdbDatumCsys object.
Exceptions

None.

30.12.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, or 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.

30–35

OdbDatumCsys object

30.12.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, or 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.

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

30–36

OdbDatumCsys 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, or SPHERICAL. origin An OdbMeshNode object specifying the origin of the datum coordinate system.
Optional arguments

None.
Return value

An OdbDatumCsys object.
Exceptions

None.

30.12.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.
Return value

An OdbDatumCsys object.

30–37

OdbFrame object

Exceptions

None.

30.12.6
name

Members

The OdbDatumCsys object has the following members: A String specifying the repository key. coordSysType A SymbolicConstant specifying the type of coordinate system. origin A sequence of Floats specifying a point at the origin of the datum coordinate system. xAxis A sequence of Floats specifying a point on the X-axis. yAxis A sequence of Floats specifying a point on the Y-axis. zAxis A sequence of Floats specifying a point on the Z-axis.

30.13

OdbFrame object

The domain of the OdbFrame object is taken from the parent step.
Access

import odbAccess session.odbs[name].steps[name].frames[i]

30.13.1

Frame(...)

This method creates an OdbFrame object and appends it to the frame sequence.
Path

session.odbs[name].steps[name].Frame
Required arguments

frameId An Int specifying the frame number within the step. The base frame is normally frame number 0, and the results run from 1.

30–38

OdbFrame object

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 the empty string.
Return value

An OdbFrame object.
Exceptions

None.

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

description A String specifying the contents of the frame. The default value is the empty string.
Return value

An OdbFrame object.
Exceptions

None.

30–39

OdbFrame object

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

description A String specifying the contents of the frame. The default value is the empty string.
Return value

An OdbFrame object.
Exceptions

None.

30.13.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
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 the empty string.

30–40

OdbInstance object

frequency A Float specifying the frequency. This member is available only if domain=FREQUENCY or if the procedureType member of the Step object=“FREQUENCY”.
Return value

An OdbFrame object.
Exceptions

None.

30.13.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 read-only 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”. 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. The key to the repository is a String representing an output variable. loadCase An OdbLoadCase object.

30.14

OdbInstance object

A part instance is the usage of a part within an assembly.

30–41

OdbInstance object

Access

import odbAccess session.odbs[name].rootAssembly.instances[name] session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].\ instance

30.14.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), (0, 0, 1), (10, 0, 0))
Return value

An OdbInstance object.
Exceptions

InvalidNameError.

30–42

OdbInstance object

30.14.2

assignBeamOrientation(...)

This method assigns a beam section orientation to a region of a part.
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 cross-section.
Optional arguments

-direction of the beam

None.

Return value

None

Exceptions

None.

30.14.3

assignMaterialOrientation(...)

This method assigns a material orientation to a region of a part.
Arguments Required argument

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.

30–43

OdbInstance object

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.

30.14.4

assignRebarOrientation(...)

This method assigns a rebar reference orientation to a region of a part.
Arguments Required argument

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.

30–44

OdbInstance object

30.14.5

getElementFromLabel(...)

This method is used to retrieved an element with a specific label from an instance object.
Arguments Required arguments

label An Int specifying the element label.
Optional arguments

None.
Return value

An OdbMeshElement object.
Exceptions

If no element with the specified label exists: AbaqusError: Invalid element label

30.14.6

getNodeFromLabel(...)

This method is used to retrieved a node with a specific label from an instance object.
Arguments Required arguments

label An Int specifying the node label.
Optional arguments

None.
Return value

An OdbMeshNode object.
Exceptions

If no node with the specified label exists: AbaqusError: Invalid node label

30–45

OdbInstance object

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

30.14.8

editNodes(...)

This method modifies the nodal coordinates of specifies nodes.
Arguments Required arguments

labels A sequence of Ints specifying the node labels. coordinates A sequence of sequences of three Floats specifying the revised nodal coordinates.
Optional arguments

None.
Return value

None

30–46

OdbInstance object

Exceptions

None.

30.14.9
name

Members

The OdbInstance object can have the following members: A String specifying the part name. type A SymbolicConstant specifying the type of the Part object. DEFORMABLE_BODY is currently supported. Only a value of

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 The value is the same as the previous frame or the original rootAssembly. MODIFIED The geometry of the instance has been changed at this frame. The default value is PROPAGATED. nodes An array of OdbMeshNode objects. elements An array of OdbMeshElement objects. nodeSets A repository of OdbSet objects containing nodes. elementSets A repository of OdbSet objects containing elements. surfaces A repository of OdbSet objects containing surfaces. sectionAssignments An array of SectionAssignment objects.

30–47

OdbMeshElement object

30.15

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]

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

30.15.2

Members

The OdbLoadCase object has members with the same names and descriptions as the arguments to the LoadCase method.

30.16

OdbMeshElement object

OdbMeshElement objects are created with the part.addElements method.

30–48

OdbMeshElement object

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

30.16.1

Members

The OdbMeshElement object can have the following members: label An Int specifying the element label. connectivity A sequence of Ints specifying the element connectivity. type A String specifying the element type. sectionCategory A SectionCategory object specifying the element section properties.

30–49

OdbMeshNode object

30.17

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

30.17.1

Members

The OdbMeshNode object has the following members: label An Int specifying the node label. coordinates A sequence of Floats specifying the nodal coordinates in the global Cartesian coordinate system.

30–50

OdbPart object

30.18

OdbPart object

The OdbPart object is similar to the Part object and contains nodes and elements, but not geometry.
Access

import odbAccess session.odbs[name].parts[name]

30.18.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. THREE_D, TWO_D_PLANAR, and AXISYMMETRIC. type A SymbolicConstant specifying the type of the Part object. DEFORMABLE_BODY is currently supported.
Optional arguments

Possible values are

Only a value of

None.
Return value

An OdbPart object.
Exceptions

None.

30.18.2

addElements(...)

This method adds elements to an OdbPart object using element labels and nodal connectivity.

30–51

OdbPart object

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.

30.18.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), ...). 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.

30–52

OdbPart object

Return value

None
Exceptions

None.

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

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

30–53

OdbPart object

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.

30.18.6

getElementFromLabel(...)

This method is used to retrieved an element with a specific label from a part object.
Arguments Required arguments

label An Int specifying the element label.
Optional arguments

None.
Return value

An OdbMeshElement object.
Exceptions

If no element with the specified label exists: AbaqusError: Invalid element label

30.18.7

getNodeFromLabel(...)

This method is used to retrieved a node with a specific label from a part object.

30–54

OdbSet object

Arguments Required arguments

label An Int specifying the node label.
Optional arguments

None.
Return value

An OdbMeshNode object.
Exceptions

If no node with the specified label exists: AbaqusError: Invalid node label

30.18.8

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 array of OdbMeshNode objects. elements An array OdbMeshElement objects. nodeSets A repository of OdbSet objects containing nodes. elementSets A repository of OdbSet objects containing elements. surfaces A repository of OdbSet objects containing surfaces.

30.19

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]

30–55

OdbSet object

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]

30.19.1

NodeSet(...)

This method creates a node set from a sequence of OdbMeshNode objects.
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 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.

30–56

OdbSet object

Exceptions

InvalidNameError.

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

30.19.3

ElementSet(...)

This method creates an element set from a sequence of OdbMeshElement objects.
Path

session.odbs[name].parts[name].ElementSet

30–57

OdbSet object

session.odbs[name].rootAssembly.instances[name].ElementSet session.odbs[name].rootAssembly.ElementSet
Required arguments

name A String specifying 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.

30.19.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 repository key. 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:

30–58

OdbSet object

elementLabels=(('Instance-1', (2,3,5,7)), ('Instance-2', (1,2,3)))
Optional arguments

None.
Return value

An OdbSet object.
Exceptions

InvalidNameError.

30.19.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 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 Solid elements Three-dimensional shell elements Two-dimensional elements Wire elements For example: side1Elements=instance1.elements[217:218] side2Elements=instance2.elements[100:105] assembly.MeshSurface(name='Surf-1', meshSurfaces=((side1Elems,SIDE1), Side identifiers FACE1, FACE2, FACE3, FACE4, FACE5, FACE6 SIDE1, SIDE2 FACE1, FACE2, FACE3, FACE4 END, END2

30–59

OdbSet object

(side2Elems,SIDE2)))
Optional arguments

None.
Return value

An OdbSet object.
Exceptions

InvalidNameError.

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

None.
Return value

An OdbSet object.
Exceptions

InvalidNameError.

30–60

OdbSet object

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

30.19.8
name

Members

The OdbSet object can have the following members: A String specifying the name of the set. faces A sequence 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. instance A sequence of OdbInstance objects providing the namespaces for the nodes, elements, and faces; None if the set is on a Part or an OdbInstance object.

30–61

OdbStep object

nodes An array of OdbMeshNode objects. If a set spans more than one part instance, this member is a sequence of sequences for each part instance. elements An array of OdbMeshElement objects. If a set spans more than one part instance, this member is a sequence of sequences for each part instance.

30.20

OdbStep object

An output database contains the same steps of the model database that originated it.
Access

import odbAccess session.odbs[name].steps[name]

30.20.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. The type of OdbFrame object that can be created for this step is based on the value of the domain argument.
Optional arguments

previousStepName A String specifying the preceding step. The default value is the empty string. 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.

30–62

OdbStep object

procedure A String specifying the step procedure. The default value is the empty string. timePeriod A Double specifying the time period of the step. timePeriod is required if domain=TIME; otherwise, this argument is not applicable. The default value is 0. totalTime A Double 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

30.20.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. 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:

30–63

OdbStep object

AbaqusException: Frame not found.

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

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

30–64

OdbStep object

Return value

An OdbFrame object.
Exceptions

If the OdbFrame object is not found: AbaqusException: Frame not found.

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

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

30–65

OdbStep object

Return value

None
Exceptions

None.

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

30.20.8

Members

The OdbStep object has members with the same names and descriptions as the arguments to the Step method. 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 Double 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 Double specifying the current value of the mass of the acoustic media of the model. massCenter A sequence of Doubles specifying the coordinates of the center of mass.

30–66

ScratchOdb object

inertiaAboutCenter A sequence of Doubles 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 sequence of Doubles 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 sequence of Doubles specifying the coordinates of the center of mass of the acoustic media. frames An array of OdbFrame objects. historyRegions A repository of HistoryRegion objects. loadCases A repository of OdbLoadCase objects.

30.21

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]

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

30–67

SectionCategory object

Optional arguments

None.
Return value

A ScratchOdb object.
Exceptions

None.

30.21.2

Members

The ScratchOdb object has no members.

30.22

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 6, “Beam Section profile commands,” and Chapter 40, “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 session.odbs[name].parts[name].surfaces[name].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].\

30–68

SectionCategory object

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

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

None.
Return value

A SectionCategory object.
Exceptions

None.

30.22.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:

30–69

SectionPoint object

sectionPoints An array of SectionPoint objects.

30.23

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

30–70

SectorDefinition object

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

30.23.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 15.3 of the ABAQUS Analysis User’s Manual, and “Shell elements,” Section 15.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.
Return value

A SectionPoint object.
Exceptions

None.

30.23.2

Members

The SectionPoint object has members with the same names and descriptions as the arguments to the SectionPoint method.

30.24

SectorDefinition object

The SectorDefinition object describes the number of symmetry sectors and axis of symmetry for a cyclic symmetry model.

30–71

Odb commands

Access

import odbAccess session.odbs[name].sectorDefinition

30.24.1

Members

The SectorDefinition object has the following members: numSectors An Int specifying the number of sectors in the cyclic symmetry model. symmetryAxis A sequence of sequences of Floats specifying the coordinates of two points on the axis of symmetry.

30.25

UserData object

The UserData object contains user-defined XYData objects. The UserData object has no constructor; it is created automatically when an Odb object is created.
Access

import odbAccess session.odbs[name].userData

30.25.1

Members

The UserData object can have the following members: xyDataObjects A repository of XYData objects. annotations A repository of Annotation objects.

30.26

Odb commands

The Odb commands do the following:

• • • •

Determine if an output database (.odb) file needs to be upgraded to the current version. 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 version and write the upgraded version to a new file.

30–72

Odb commands

30.26.1

isUpgradeRequiredForOdb(...)

This method determines if an output database file needs to be upgraded to the current version. 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 version.
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 version.
Exceptions

None.

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

30–73

Odb commands

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

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

30–74

Odb commands

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

30.26.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')

30–75

Odb commands

Arguments Required argument

path A String specifying the path to an existing output database (.odb) file.
Optional arguments

None.
Return value

An Odb object.
Exceptions

If the output database was generated by a previous version of ABAQUS and needs upgrading: OdbError: The database is from a previous version of ABAQUS. Run abaqus upgrade -job <newFilename> -odb <oldFileName> to upgrade it. If the output database was generated by a newer version of ABAQUS, and the installation of ABAQUS needs upgrading: OdbError: ABAQUS installation must be upgraded before this output database can be opened.

30.26.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 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.
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 FALSE, indicating that both read and write access will be permitted.

30–76

Odb commands

Return value

An Odb object.
Exceptions

If the output database was generated by a previous version of ABAQUS and needs upgrading: OdbError: The database is from a previous version of ABAQUS. Run abaqus upgrade -job <newFilename> -odb <oldFileName> to upgrade it. If the output database was generated by a newer version of ABAQUS, and the installation of ABAQUS needs upgrading: 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 < lename>.

30.26.6

upgradeOdb(...)

This method upgrades an existing Odb object to the current version 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.

30–77

Odb commands

Return value

None
Exceptions

If the output database upgrade fails: OdbError: cannot convert database

30–78

OdbDisplay object

31.
31.1

Odb Display commands
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 values from defaultOdbDisplay. 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

import visualization session.viewports[name].odbDisplay

31.1.1

clearColor()

This method clears all current color definitions for the viewport. All entities will be restored to the colors defined by the current plot mode or display group attributes.
Arguments

None.
Return value

None
Exceptions

None.

31.1.2

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.

31–1

OdbDisplay object

Arguments

None.
Return value

None
Exceptions

None.

31.1.3

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.

31.1.4

setDisplayGroup(...)

This method specifies the subset of the model to display.

31–2

OdbDisplay object

Arguments Required argument

displayGroup A DisplayGroup object specifying the subset of the model.
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.

31.1.5

setColor(...)

This method specifies the color of a Leaf object.
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.

31–3

OdbDisplay object

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 initial 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 initial value is SMALL.
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.

31.1.6

setColor(...)

This method specifies the color assignment by element attributes as specified by an AttributeColorMap object.
Arguments Required argument

colorMapping An AttributeColorMap object. Possible values are any AttributeColorMap 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.

31–4

OdbDisplay object

31.1.7

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 frame An Int specifying the frame in the specified step. (numFramesInStep − 1).
Optional arguments

step

(numSteps − 1). frame

Possible values are 0

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. If the Odb object does not contain valid step data: There are no valid step data on the odb. Requested operation cancelled. If invalid step and frame indices are passed in as arguments: Invalid step and/or frame number: Step = step, Frame = frame

31.1.8

setFrame(...)

This method specifies the frame for the OdbDisplay object.
Arguments Required argument

frame An OdbFrame object.
Optional arguments

None.

31–5

OdbDisplay object

Return value

None
Exceptions

None.

31.1.9

setPlotMode(...)

This method specifies the plot mode to be used when displaying the model.
Arguments Required argument

plotMode A SymbolicConstant specifying the plot mode. Possible values are NO_MODE, FAST, UNDEFORMED_SHAPE, DEFORMED_SHAPE, CONTOUR, SYMBOL, and MATERIAL_ORIENTATION.
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.

31.1.10

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.

31–6

OdbDisplay object

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.

31.1.11

setPrimarySectionPoint(...)

This method specifies the section point for the current primary variable.
Arguments Required argument

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:

31–7

OdbDisplay object

sectionPoint={ 'shell < MAT > < 7 section points >':'SPOS, (fraction = 1.0)', 'shell < MAT > < 5 section points >':'SPOS, (fraction = 1.0)', }
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.

31.1.12

setValues(...)

This method specifies member values for the OdbDisplay object.
Arguments Required arguments

None.
Optional argument

visibleDisplayGroups A List of DisplayGroup objects. viewCut A Boolean specifying whether to display the cut. The default value is OFF. viewCutNames A List of ViewCut objects.
Return value

None
Exceptions

None.

31.1.13

Members

The OdbDisplay object can have the following members:

31–8

OdbDisplay object

name A String specifying the name of the output database associated with the OdbDisplay object. fieldFrame A Sequence of either

• •

two Strings that specify the step label and the frame label when the current step is user defined or two Ints that specify the step index and the frame index when the current step is defined in the analysis.

primaryVariable A sequence containing the following elements:

• •

Element 0: A String specifying the variable label. Element 1: An Int specifying the output position. Possible values are: – – – – – – – – – – – 0: UNDEFINED_POSITION 1: NODAL 2: INTEGRATION_POINT 3: ELEMENT_FACE 4: ELEMENT_NODAL 5: WHOLE_ELEMENT 6: ELEMENT_CENTROID 7: WHOLE_REGION 8: WHOLE_PART_INSTANCE 9: WHOLE_MODEL 10: GENERAL_PARTICLE 0: ENUMERATION 1: BOOLEAN 2: INTEGER 3: SCALAR 4: VECTOR 5: QUATERNION_2D 6: QUATERNION_3D 7: TENSOR 8: TENSOR_3D_FULL 9: TENSOR_3D_PLANAR 10: TENSOR_3D_SURFACE



Element 2: An Int specifying the data type. Possible values are: – – – – – – – – – – –

31–9

OdbDisplay object

– 11: TENSOR_2D_PLANAR – 12: TENSOR_2D_SURFACE



Element 3: An Int specifying the storage type. Possible values are: – 0: FLOAT – 1: DOUBLE – 2: INTEGER – 3: BOOLEAN



Element 4: An Int specifying the refinement type. Possible values are: – 0: NO_REFINEMENT – 1: INVARIANT – 2: COMPONENT

• • • •

Element 5: A String specifying the refinement label. Element 6: An Int specifying the refinement index. Element 7: An Int specifying whether section point information is available. Possible values are 1 when section point information is available; 0, when this information is unavailable. Element 6: A sequence of category selection tuples (see below) specifying the section point information. A category selection tuple consists of the following elements: – Element 0: A String specifying the category label. – Element 1: An Int specifying whether to use both top and bottom section points to obtain results. Possible values are 1 to use both section points and 0 to use only the top section point. – Element 2: An Int specifying the top section point index. – Element 3: A String specifying the top section label. – Element 4: An Int specifying the bottom section point index. – Element 5: A String specifying the bottom section label.

deformedVariable A sequence containing the same elements as the primaryVariable member. plotMode A SymbolicConstant identifying the current plot mode. Possible values are NO_MODE, FAST, UNDEFORMED_SHAPE, DEFORMED_SHAPE, CONTOUR, SYMBOL, and MATERIAL_ORIENTATION. firstFrame A read-only pair of Ints specifying the step index and the frame index of the first available frame.

31–10

OdbDisplay object

prevFrame A read-only pair of Ints specifying the step index and the frame index of the frame previous to the current frame. nextFrame A read-only pair of Ints specifying the step index and the frame index of the frame following the current frame. lastFrame A read-only pair of Ints specifying the step index and the frame index of the last available frame. colorMode A SymbolicConstant identifying the current plot mode. Possible values are DEFAULT_COLORS, LEAF_COLORS, PART_MAP_COLORS, MATERIAL_MAP_COLORS, ELSET_MAP_COLORS, ELTYPE_MAP_COLORS, AVERAGING_REGION_MAP_COLORS, and SECTION_MAP_COLORS. fieldVariables An OdbFieldVarList object. modelVariableList An OdbModelFieldVarList object. historyVariables A read-only repository of HistoryVariable objects. The repository key is a string specifying the history request label. nodeSet A read-only repository of OdbSet objects. The repository key is a string specifying the set label. elementSet A read-only repository of OdbSet objects. The repository key is a string specifying the set label. surfaceSet A read-only repository of OdbSet objects. The repository key is a string specifying the set label. contourOptions A ContourOptions object. deformedShapeOptions A DeformedShapeOptions object. symbolOptions A SymbolOptions object. undeformedShapeOptions An UndeformedShapeOptions object. viewCutOptions A ViewCutOptions object. viewCuts A repository of ViewCut objects.

31–11

DefaultOdbDisplay object

scaleFactorMovieOptions A ScaleFactorMovieOptions object. timeHistoryMovieOptions A TimeHistoryMovieOptions object. displayGroup A DisplayGroup object specifying the current display group and referring to an object in the displayGroups member of Session. displayGroupInstances A DisplayGroupInstanceRepository object. animationOptions An AnimationOptions object. basicOptions A BasicOptions object. materialOrientationOptions An OrientationOptions object. colorMappings A repository of AttributeColorMap objects. These cannot be constructed but the current supported attribute maps are available as “Material”, “Section”, “Element set”, “Element type”, “Averaging region” and “Part instance”

31.2

DefaultOdbDisplay object

The DefaultOdbDisplay object is a limited-functionality version of the OdbDisplay object.
Access

import visualization session.defaultOdbDisplay

31.2.1
name

Members

The DefaultOdbDisplay object can have the following members: A String specifying the name of the output database associated with the OdbDisplay object. fieldFrame A Sequence of either:



two Strings that specify the step label and the frame label when the current step is user defined or

31–12

DefaultOdbDisplay object



two Ints that specify the step index and the frame index when the current step is defined in the analysis.

primaryVariable A sequence containing the following elements:

• •

Element 0: A String specifying the variable label. Element 1: An Int specifying the output position. Possible values are: – – – – – – – – – – – 0: UNDEFINED_POSITION 1: NODAL 2: INTEGRATION_POINT 3: ELEMENT_FACE 4: ELEMENT_NODAL 5: WHOLE_ELEMENT 6: ELEMENT_CENTROID 7: WHOLE_REGION 8: WHOLE_PART_INSTANCE 9: WHOLE_MODEL 10: GENERAL_PARTICLE 0: ENUMERATION 1: BOOLEAN 2: INTEGER 3: SCALAR 4: VECTOR 5: QUATERNION_2D 6: QUATERNION_3D 7: TENSOR 8: TENSOR_3D_FULL 9: TENSOR_3D_PLANAR 10: TENSOR_3D_SURFACE 11: TENSOR_2D_PLANAR 12: TENSOR_2D_SURFACE



Element 2: An Int specifying the data type. Possible values are: – – – – – – – – – – – – –



Element 3: An Int specifying the storage type. Possible values are: – 0: FLOAT – 1: DOUBLE – 2: INTEGER

31–13

DefaultOdbDisplay object

– 3: BOOLEAN



Element 4: An Int specifying the refinement type. Possible values are: – 0: NO_REFINEMENT – 1: INVARIANT – 2: COMPONENT

• • • •

Element 5: A String specifying the refinement label. Element 6: An Int specifying the refinement index. Element 7: An Int specifying whether section point information is available. Possible values are 1 when section point information is available; 0, when this information is unavailable. Element 6: A sequence of category selection tuples (see below) specifying the section point information. A category selection tuple consists of the following elements: – Element 0: A String specifying the category label. – Element 1: An Int specifying whether to use both top and bottom section points to obtain results. Possible values are 1 to use both section points and 0 to use only the top section point. – Element 2: An Int specifying the top section point index. – Element 3: A String specifying the top section label. – Element 4: An Int specifying the bottom section point index. – Element 5: A String specifying the bottom section label.

deformedVariable A sequence containing the same elements as the primaryVariable member. plotMode A SymbolicConstant identifying the current plot mode. Possible values are NO_MODE, FAST, UNDEFORMED_SHAPE, DEFORMED_SHAPE, CONTOUR, SYMBOL, and MATERIAL_ORIENTATION. firstFrame A read-only pair of Ints specifying the step index and the frame index of the first available frame. prevFrame A read-only pair of Ints specifying the step index and the frame index of the frame previous to the current frame. nextFrame A read-only pair of Ints specifying the step index and the frame index of the frame following the current frame. lastFrame A read-only pair of Ints specifying the step index and the frame index of the last available frame.

31–14

DefaultOdbDisplay object

fieldVariables An OdbFieldVarList object. modelVariableList An OdbModelFieldVarList object. historyVariables A read-only repository of HistoryVariable objects. The repository key is a string specifying the history request label. nodeSet A read-only repository of OdbSet objects. The repository key is a string specifying the set label. elementSet A read-only repository of OdbSet objects. The repository key is a string specifying the set label. surfaceSet A read-only repository of OdbSet objects. The repository key is a string specifying the set label. contourOptions A ContourOptions object. deformedShapeOptions A DeformedShapeOptions object. symbolOptions A SymbolOptions object. undeformedShapeOptions An UndeformedShapeOptions object. viewCutOptions A ViewCutOptions object. viewCuts A repository of ViewCut objects. scaleFactorMovieOptions A ScaleFactorMovieOptions object. timeHistoryMovieOptions A TimeHistoryMovieOptions object. displayGroup A DisplayGroup object specifying the current display group and referring to an object in the displayGroups member of Session. displayGroupInstances A DisplayGroupInstanceRepository object. animationOptions An AnimationOptions object. basicOptions A BasicOptions object.

31–15

AttributeColorMap object

materialOrientationOptions An OrientationOptions object.

31.3

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 OdbDisplay object cause the AttributeColorMap object to be updated in the session.viewports[name].odbDisplay.colorMappings repository.
Access

import visualization session.viewports[name].odbDisplay.colorMappings[name]

31.3.1

setDefaults()

This method resets the AttributeColorMap object to its default state.
Arguments

None.
Return value

None
Exceptions

None.

31.3.2

setValues(...)

This method modifies the AttributeColorMap object.
Arguments Required arguments

None.
Optional arguments

At least one of the following must be provided:

31–16

AttributeColorMap object

overrides A Dictionary with String keys and values. Each key 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')} autoColors A list of strings defining the colors automatically assigned to attributes without overrides.
Return value

None
Exceptions

None.

31.3.3

updateOverrides(...)

This method specifies additional overrides to be added to the current object definition.
Arguments Required argument

overrides A Dictionary with String keys and values. Each key 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')}
Optional arguments

None.
Return value

None
Exceptions

If the viewport is not associated with any Odb object:

31–17

OdbDisplayOptions object

The current viewport is not associated with an ODB file. Requested operation cancelled.

31.3.4

Members

The AttributeColorMap object has the following members: autoColors A list of strings defining the colors automatically assigned to attributes without overrides. 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. mapColors A list of strings defining the colors currently used by the map. overrides A Dictionary with String keys and values. Each key 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')} attributeColors A dictionary of color settings for each attribute as described in the updateOverrides method.

31.4

OdbDisplayOptions object

The OdbDisplayOptions object contains the display settings for specific display group instances.
Access

session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptio

31.4.1

Members

The OdbDisplayOptions object has the following members: contourOptions A contourOptions object. For more information, see “ContourOptions object,” Section 35.2. deformedShapeOptions A deformedShapeOptions object. For more information, see “DeformedShapeOptions object,” Section 35.3.

31–18

ViewCut object

undeformedShapeOptions An undeformedShapeOptions object. For more information, see “UndeformedShapeOptions object,” Section 35.7. symbolOptions A symbolOptions object. For more information, see “SymbolOptions object,” Section 35.6. materialOrientationOptions A materialOrientationOptions object. For more information, see “OrientationOptions object,” Section 35.5. displayBodyOptions A displayBodyOptions object. plotMode A SymbolicConstant identifying the current plot mode. Possible values are NO_MODE, FAST, UNDEFORMED_SHAPE, DEFORMED_SHAPE, CONTOUR, SYMBOL, and MATERIAL_ORIENTATION.

31.5

ViewCut object

The ViewCut object is used to store values and attributes associate with ViewCut type objects. ViewCut objects can be created using the methods described below. The methods accessed via the OdbDisplay object cause the ViewCut object to be added to the session.viewports[name].odbDisplay.viewCuts repository.
Access

import visualization session.viewports[name].odbDisplay.viewCuts[name]

31.5.1

ViewCut(...)

This method creates a ViewCut object.
Path

session.viewports[name].odbDisplay.ViewCut
Required arguments

name A String specifying the repository key. shape A SymbolicConstant specifying the shape of the ViewCut object. Possible values are PLANE, CYLINDER, SPHERE, ISOSURFACE.

31–19

ViewCut object

origin A sequence of Floats specifying the X-, Y-, and Z-coordinates of the origin of the plane, cylinder or sphere cut. This argument is not required if the cut shape is ISOSURFACE or if the cut is defined by the csysName argument. normal A sequence of Floats specifying the X-, Y-, and Z-coordinates of the normal axis to the plane defining the cut, when the plane is defined using the origin argument or a SymbolicConstant defining this normal axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. This argument is not required if the cut shape is CYLINDER, SPHERE or ISOSURFACE . axis2 A sequence of Floats specifying the X-, Y-, and Z-coordinates of the second axis of the plane defining the cut, when the plane is defined using the origin argument or a SymbolicConstant defining this second axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. This axis is used to rotate the plane cut. This argument is not required if the cut shape is CYLINDER, SPHERE or ISOSURFACE. csysName A String specifying the name of the DatumCsys object to be used to define the cut. This argument is not required if the cut shape is ISOSURFACE or if the cut is defined by the origin argument. cylinderAxis A sequence of Floats specifying the X-, Y-, and Z-coordinates of the cylinder axis defining the cut, when the cut is defined using the origin argument or a SymbolicConstant defining this cylinder axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. This argument is not required if the cut shape is PLANE, SPHERE or ISOSURFACE .
Optional arguments

followDeformation A Boolean specifying wether the cut will follow the deformation or be static. The default value is FALSE. referenceFrame A SymbolicConstant specifying which reference frame will be used when the cut follows the deformation. Possible values are FIRST_FRAME, LAST_FRAME and CURRENT_FRAME. The default value is FIRST_FRAME.
Return value

A ViewCut object.
Exceptions

None.

31–20

ViewCut object

31.5.2

setValues(...)

This method modifies the ViewCut object.
Arguments Required arguments

None.
Optional arguments

At least one of the following must be provided: angle A Float specifying the rotation angle of the cut defined with a shape set to PLANE. motion A SymbolicConstant specifying the type of motion for the cut defined with a shape set to PLANE. Possible values are TRANSLATE and ROTATE. The default value is TRANSLATE. position A Float specifying the position of the cut defined with a shape set to PLANE. radius A Float specifying the radius of the cut defined with a shape set to CYLINDER or SPHERE. rotationAxis A SymbolicConstant specifying the rotation axis for the cut defined with a shape set to PLANE. Possible values are AXIS_1, AXIS_2and AXIS_3. The default value is AXIS_2. value A Float specifying the value of the cut defined with a shape set to ISOSURFACE. showModelAboveCut A Boolean specifying whether to display the model above the cut. The default value is FALSE. showModelOnCut A Boolean specifying whether to display the model on the cut. The default value is TRUE. showModelBelowCut A Boolean specifying whether to display the model below the cut. The default value is TRUE. csysName A String specifying the name of the DatumCsys object to be used to define the cut. origin A sequence of three Floats specifying the X-, Y-, and Z-coordinates of the origin of the plane, cylinder or sphere cut. normal A sequence of Floats specifying the X-, Y-, and Z-coordinates of the normal axis to the plane defining the cut, when the plane is defined using the origin argument or a SymbolicConstant

31–21

ViewCut object

defining this normal axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. axis2 A sequence of three Floats specifying the X-, Y-, and Z-coordinates of the second axis of the plane defining the cut, when the plane is defined using the origin argument or a SymbolicConstant defining this second axis, when the cut is defined by thecsysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. This axis is used to rotate the plane cut. cylinderAxis A sequence of three Floats specifying the X-, Y-, and Z-coordinates of the cylinder axis defining the cut, when the cut is defined using the origin argument or a SymbolicConstant defining this cylinder axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3.. followDeformation A Boolean specifying wether the cut will follow the deformation or be static. The default value is FALSE. referenceFrame A SymbolicConstant specifying which reference frame will be used when the cut follows the deformation. Possible values are FIRST_FRAME, LAST_FRAME and CURRENT_FRAME.
Return value

None
Exceptions

None.

31.5.3

Members

The ViewCut object has members with the same names and descriptions as the arguments to the ViewCut method. In addition, the ViewCut object has the following members: angle A Float specifying the rotation angle of the cut defined with a shape set to PLANE. motion A SymbolicConstant specifying the type of motion for the cut defined with a shape set to PLANE. Possible values are TRANSLATE and ROTATE. The default value is TRANSLATE. position A Float specifying the position of the cut defined with a shape set to PLANE. radius A Float specifying the radius of the cut defined with a shape set to CYLINDER or SPHERE.

31–22

ViewerOptions object

rotationAxis A SymbolicConstant specifying the rotation axis for the cut defined with a shape set to PLANE. Possible values are AXIS_1, AXIS_2and AXIS_3. The default value is AXIS_2. value A Float specifying the value of the cut defined with a shape set to ISOSURFACE. showModelAboveCut A Boolean specifying whether to display the model above the cut. The default value is FALSE. showModelOnCut A Boolean specifying whether to display the model on the cut. The default value is TRUE. showModelBelowCut A Boolean specifying whether to display the model below the cut. The default value is TRUE. active A Boolean specifying whether the cut is displayed. cutRange A pair of Floats specifying the acceptable range for positioning the cut.

31.6

ViewerOptions object

The ViewerOptions object specifies options to set the result caching parameters. The ViewerOptions object has no constructor. ABAQUS creates the viewerOptions member when a session is started.
Access

import visualization session.viewerOptions

31.6.1

setValues(...)

This method modifies the ViewerOptions object.
Arguments Required arguments

None.
Optional arguments

primaryVariableCaching A Boolean specifying whether results are currently cached. Caching improves the performance of subsequent access. The default value is ON.

31–23

ViewerOptions object

deformedVariableCaching A Boolean specifying whether deformation vectors are currently cached. Caching improves the performance of subsequent access. The default value is ON. cutVariableCaching A Boolean specifying whether the values used for displaying cut models are currently cached. Caching improves the performance of subsequent access. The default value is ON. odbUpdateChecking A Boolean specifying whether the current .odb file should be checked for updates. Setting odbUpdateChecking to OFF can improve Viewer performance when accessing data from a remote file. The default value is ON. odbUpdateCheckInterval An Int specifying the minimum time between status checks (in seconds). The default value is 0.
Return value

None
Exceptions

None.

31.6.2

Members

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

31–24

Part object

32.
32.1

Part commands
Part object

The Part object defines the physical attributes of a structure. Parts are instanced into the assembly and positioned before an analysis.
Access

import part mdb.models[name].parts[name]

32.1.1

Part(...)

This method creates a Part object and places it in the parts repository.
Path

mdb.models[name].Part
Required arguments

name A String specifying the repository key. dimensionality A SymbolicConstant specifying the dimensionality of the Part. Possible values are THREE_D, TWO_D_PLANAR, and AXISYMMETRIC. type A SymbolicConstant specifying the type. Possible values are DEFORMABLE_BODY, DISCRETE_RIGID_SURFACE, and ANALYTIC_RIGID_SURFACE.
Optional argument

twist A Boolean specifying whether to include a twist DEGREE OF FREEDOM in the part (only available when dimensionality=AXISYMMETRIC and type=DEFORMABLE_BODY). The default value is OFF.
Return value

A Part object.

32–1

Part object

Exceptions

InvalidNameError.

32.1.2

Part(...)

This method copies a Part object and places the copy in the parts repository.
Path

mdb.models[name].Part
Required arguments

name A String specifying the repository key of the new part. objectToCopy A Part Object to be copied.
Optional arguments

scale A Float specifying the scaling factor to apply to the imported geometric entities during copy. If a scale is specified, compressFeatureList will be set to ON, regardless of whether it is specified in the command. The default value is 1. mirrorPlane A SymbolicConstant specifying how the part is to be mirrored during copy. Possible values are XYPLANE, XZPLANE, YZPLANE. If a mirror plane is specified, compressFeatureList will be set to ON, regardless of whether it is specified in the command. The default value is NONE. compressFeatureList A Boolean specifying whether to compress the feature list when copying a Part object. The default value is OFF. If mirrorPlane or scale is specified, this argument is ignored. When you compress the feature, list the resulting part will have a single feature. Any datums or sets in the original part will be lost. separate A Boolean specifying whether to separate disconnected regions into parts. The default value is OFF.
Return value

A Part object.
Exceptions

InvalidNameError.

32–2

Part object

32.1.3

PartFromGeometryFile(...)

This method creates a Part object and places it in the parts repository.

Path

mdb.models[name].PartFromGeometryFile
Required arguments

name A String specifying the repository key. geometryFile An AcisFile object specifying a file containing geometry. dimensionality A SymbolicConstant specifying the dimensionality of the part. Possible values are THREE_D, TWO_D_PLANAR, and AXISYMMETRIC. type A SymbolicConstant specifying the type of the part. Possible values are DEFORMABLE_BODY, DISCRETE_RIGID_SURFACE, and ANALYTIC_RIGID_SURFACE.
Optional arguments

bodyNum An Int specifying the desired body to be selected from an ACIS object containing a list of N ACIS bodies. Possible values are 1 bodyNum N. The default value is 1. twist A Boolean specifying whether to include a twist DEGREE OF FREEDOM (only available when dimensionality=AXISYMMETRIC and type=DEFORMABLE_BODY). The default value is OFF. topology A SymbolicConstant specifying the type of geometrical body. Possible values are SOLID, SHELL, and WIRE. The default value is SOLID. scale A Float specifying the scaling factor to apply to the imported geometric entities. The default value is 1.0. convertToAnalytical An Int specifying whether to convert to analytical entities. Possible values are 0 or 1. The default value is 0. If convertToAnalytical=1, all the numerical entities, such as splines, are converted to analytical entities, such as arcs and lines, during the repair phase of the command.

32–3

Part object

stitchEdges An Int specifying whether to stitch edges. Possible values are 0 or 1. The default value is 0. If stitchEdges=1, the application will attempt to stitch all the edges of the part into a solid entity during the repair phase of this command. convertToPrecise An Int specifying whether to convert to precise geometry. Possible value are 0 or 1. The default value is 0. If convertToPrecise=1, the application will attempt to re-evaluate the tolerant entities to be more precise.
Return value

A Part object.
Exceptions

InvalidNameError. If the ACIS file is corrupt: PartError: the file is corrupt If the dimensionality does not correspond to what is found in the ACIS file: PartError: dimensionality does not match the contents of the file If the type does not correspond to what is found in the ACIS file: PartError: type does not match the contents of the file

32.1.4

PartFromBooleanCut(...)

This method creates a Part in the parts 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.PartFromBooleanCut
Required arguments

name A String specifying the repository key. 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 arguments

None.

32–4

Part object

Return value

A Part object.
Exceptions

InvalidNameError.

32.1.5

PartFromBooleanMerge(...)

This method creates a Part in the parts repository after merging two or more part instances. The part instances can be either ABAQUS native parts or orphan mesh parts, but they cannot be a combination of both.
Path

mdb.models[name].rootAssembly.PartFromBooleanMerge
Required arguments

name A String specifying the repository key. 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. mergeNodes A SymbolicConstant specifying whether the nodes of orphan mesh part instances should be retained after the merge operation. Possible values are BOUNDARY_ONLY, ALL, or NONE. The default value is BOUNDARY_ONLY. nodeMergingTolerance A Float specifying the maximum distance between nodes of orphan mesh part instances that will be merged and replaced with a single new node. The location of the new node is the average position of the deleted 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 ON.
Return value

A Part object.

32–5

Part object

Exceptions

InvalidNameError.

32.1.6

PartFromInstanceMesh(...)

This method creates a Part object containing the mesh found in the supplied PartInstance objects and places the new Part object in the parts repository.
Path

mdb.models[name].rootAssembly.PartFromInstanceMesh
Required argument

name A String specifying the repository key.
Optional argument

partInstances A sequence of PartInstance objects to be used in the creation of the new mesh part. If the partInstances argument is omitted, the new Part object contains the mesh of all the part instances in the assembly.
Return value

A Part object.
Exceptions

InvalidNameError. If the analysis type (deformable or rigid) is not consistent among the supplied part instances: The selected part instances do not have a consistent analysis type. If the assembly does not contain a mesh: The current assembly does not contain a mesh for a mesh part. If the specified part instances do not contain a mesh: The selected part instances do not have a mesh for a mesh part.

32.1.7

PartFromExtrude2DMesh(...)

This method creates a Part object by extruding an existing two-dimensional orphan mesh Part object in the positive Z-direction and places it in the parts repository.

32–6

Part object

Path

mdb.models[name].PartFromExtrude2DMesh
Required arguments

name A String specifying the repository key. part A Part object specifying an existing two-dimensional orphan mesh Part object. depth A Float specifying the total extrusion distance. elementSize A Float specifying an approximate element length in the extruded direction.
Optional arguments

None.
Return value

A Part object.
Exceptions

InvalidNameError. If the specified part is not an orphan mesh part: Cannot extrude a geometric part. If the specified part is not two-dimensional: Cannot extrude a 3D part. If the specified part is a rigid body: Cannot change dimension of a rigid body.

32.1.8

PartFromMeshMirror(...)

This method creates a Part object by mirroring an existing orphan mesh Part object about a specified plane and places it in the parts repository. The result is a union of the original and the mirrored copy. Contrast the PartFromMeshMirror method with the mirrorPlane argument of the Part copy constructor. The mirrorPlane argument creates only the second half of the part but does not unite the two halves.
Path

mdb.models[name].PartFromMeshMirror

32–7

Part object

Required arguments

name A String specifying the repository key. part A Part object specifying an existing orphan mesh part. point1 A sequence of three Floats specifying a point on the mirror plane. This point is the local origin in the local system of the plane. point2 A sequence of three Floats specifying a point in the direction of the normal to the mirror plane. This point must not be coincident with point1.
Optional arguments

None.
Return value

A Part object.
Exceptions

InvalidNameError. If the specified part is not an orphan mesh part: Cannot mirror a geometric part. If the specified part is a rigid body: Cannot mirror a rigid body. If point1 and point2 are coincident: Mirror plane director has zero length. If the specified part is two-dimensional and the plane is not parallel to the Z-axis: Mirror plane must be parallel to Z axis for 2D parts

32.1.9

PartFromNodesAndElements(...)

This method creates a Part object from nodes and elements and places it in the parts repository.
Path

mdb.models[name].PartFromNodesAndElements
Required arguments

name A String specifying the repository key.

32–8

Part object

dimensionality A SymbolicConstant specifying the dimensionality of the part. Possible values are THREE_D, TWO_D_PLANAR, and AXISYMMETRIC. type A SymbolicConstant specifying the type of the part. Possible values are DEFORMABLE_BODY, DISCRETE_RIGID_SURFACE, and ANALYTIC_RIGID_SURFACE. nodes A sequence of (nodeLabels, nodeCoords) specifying the nodes of the mesh. nodeLabels is a sequence of Ints specifying the node labels, and nodeCoords is a sequence of sequences of three Floats specifying the nodal coordinates. elements A sequence of (meshType, elementLabels, elementConns) specifying the elements of the mesh. meshType is a String specifying the element type. elementlabels is a sequence of Ints specifying the element labels. elementConns is a sequence of sequences of node labels specifying the element connectivity.
Optional argument

twist A Boolean specifying whether to include a twist DEGREE OF FREEDOM in the part (only available when dimensionality=AXISYMMETRIC and type=DEFORMABLE_BODY). The default value is OFF.
Return value

A Part object.
Exceptions

None.

32.1.10

PartFromOdb(...)

This method creates an orphan mesh Part object by reading an output database. The new part is placed in the parts repository.
Path

mdb.models[name].PartFromOdb
Required arguments

name A String specifying the repository key.

32–9

Part object

odb An output database object.
Optional arguments

fileName A String specifying the name of the output database file from which to create the part. The default value is an empty string. instance A String specifying the part instance in the output database from which to create the part. If no instance name is specified, ABAQUS creates an orphan mesh part from the first part instance in the output database. elementSet A String specifying an element set defined on the output database. Only elements from this set will be imported. The default is to import all element sets. shape A SymbolicConstant specifying the configuration state. Possible values are UNDEFORMED and DEFORMED. The default value is UNDEFORMED. step An Int specifying the step number for reading deformed coordinates. where is the number of available steps. The default value is the last available step. You should specify the step argument only when shape=DEFORMED. frame An Int specifying the frame number for reading deformed coordinates. where is the number of available frames. The default value is the last available frame. You should specify the frame argument only when shape=DEFORMED. twist A Boolean specifying whether to include a twist DEGREE OF FREEDOM in the part (only available when dimensionality=AXISYMMETRIC and type=DEFORMABLE_BODY). The default value is OFF.
Return value

A Part object.
Exceptions

InvalidNameError. If the output database contains elements of more than one dimensionality or type: File contains both axisymmetric and nonaxisymmetric elements. File contains both 2D and 3D elements. File contains both rigid and deformable elements.

32–10

Part object

If more than one part is found on the output database: PartError: importing of more than one part is not currently supported If the output database does not contain any valid results for the specified step: Error. File does not contain any valid frames. If the specified step and frame do not contain any displacements: Error. Specified frame does not contain nodal displacements. If the specified element set is not found on the output database: Error. Specified element set is not defined in the ODB. If the step number is invalid: OdiError: Invalid step index: i. Available step indices: 0 - j. If the frame number is invalid: OdiError: Invalid frame index: i. Available frame indices: 0 - j.

32.1.11

PartFromSection3DMeshByPlane(...)

This method creates a Part object by cutting an existing three-dimensional orphan mesh Part object by a plane and places it in the parts repository.
Path

mdb.models[name].PartFromSection3DMeshByPlane
Required arguments

name A String specifying the repository key. part A Part object specifying an existing three-dimensional orphan mesh part. point1 A Sequence of three Floats specifying a point on the cutting plane. This point is the local origin in the local system of the plane. point2 A Sequence of three Floats specifying a point in the direction of the normal to the cutting plane. This point must not be coincident with point1. point3 A sequence of three Floats specifying the direction of the local 1-axis in the local system of the plane. This point must not project onto point1.
Optional arguments

None.

32–11

Part object

Return value

A Part object.
Exceptions

InvalidNameError. If the specified part is not an orphan mesh part: Cannot reduce dimension of a geometric part. If the specified part is not three-dimensional: Cannot reduce dimension of a 2D part. If the specified part is a rigid body: Cannot change dimension of a rigid body. If point1 and point2 are coincident: Cutting plane director has zero length. If point3 projects onto point1: Local axis point projects to origin. If no elements are cut by the specified plane: Cannot reduce part dimension.

32.1.12

Part2DGeomFrom2DMesh(...)

This method creates a geometric Part object from the outline of an existing two-dimensional orphan mesh Part object and places it in the parts repository. If the Part2DGeomFrom2DMesh method cannot create a valid two-dimensional shell section from the two-dimensional mesh, the method fails and creates an empty geometry part with a failed base shell feature.
Path

mdb.models[name].Part2DGeomFrom2DMesh
Required arguments

name A String specifying the repository key for the Part object. part A Part object specifying an existing two-dimensional orphan mesh Part object. featureAngle A Float specifying the angle (in degrees) between line segments that triggers a break in the geometry.

32–12

Part object

Optional arguments

splineCurvatureLimit A Float specifying the traversal angle in degrees of the spline that triggers a break in the geometry. The default value is 90. twist A Boolean specifying whether to include a twist DEGREE OF FREEDOM in the part (only available when dimensionality=AXISYMMETRIC and type=DEFORMABLE_BODY). The default value is OFF.
Return value

A Part object.
Exceptions

InvalidNameError. If the specified part is not an orphan mesh part: Specified part must be an orphan mesh. If the Part2DGeomFrom2DMesh method cannot create a valid two-dimensional shell section from the two-dimensional mesh: Planar shell feature failed If the specified part is not two-dimensional: Cannot create a geometry from a 3D part. If the specified part is a rigid body: Cannot create a geometry from a rigid body.

32.1.13

setValues(...)

This method modifies the Part object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the Part method. In addition, setValues has the following optional argument: geometryRefinement A SymbolicConstant specifying how the part’s surface is being refined when faceted for display. Possible values are EXTRA_COARSE, COARSE, MEDIUM, FINE, and EXTRA_FINE.

32–13

Part object

Return value

None
Exceptions

RangeError.

32.1.14

addGeomToSketch(...)

This method converts a part into a sketch by projecting all of the edges of the part onto the X-Y plane of the sketch. You can use addGeomToSketch with a part of any modeling space.
Arguments Required argument

sketch A Sketch object.
Optional arguments

None.
Return value

None
Exceptions

None.

32.1.15

backup()

This method makes a backup copy of the features in the part. Use the restore method to retrieve the part’s features from the backup.
Arguments

None.
Return value

None
Exceptions

None.

32–14

Part object

32.1.16

checkGeometry(...)

This method checks the validity of the geometry of the part and prints a count of all topological entities on the part (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. reportFacetErrors A Boolean specifying whether faces are checked for proper facetting. The default value is OFF. 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.
Return value

None
Exceptions

None.

32.1.17

clearGeometryCache()

This method clears the geometry cache. Clearing the geometry cache reduces the amount of memory being used to cache part features.
Arguments

None.
Return value

None
Exceptions

None.

32–15

Part object

32.1.18

deleteAllFeatures()

This method deletes all the features in the part.
Arguments

None.
Return value

None
Exceptions

None.

32.1.19

deleteFeatures(...)

This method deletes the given features.
Arguments Required argument

featureNames A tuple of feature names that will be deleted from the part.
Optional arguments

None.
Return value

None
Exceptions

None.

32.1.20

getArea(...)

This method returns the total surface area of a given face or group of faces.
Arguments Required argument

faces A sequence of face objects whose area the method will calculate.

32–16

Part object

Optional argument

relativeAccuracy A Float specifying that the area computation should stop when the specified relative accuracy has been achieved. The default value is 0.000001 (0.0001%).
Return value

A Float specifying the sum of the calculated areas of the given faces.
Exceptions

None.

32.1.21

getCentroid(...)

Depending on the arguments provided, this method returns the following:

• •

The location of the centroid of a given face or group of faces. The location of the centroid of a given cell or group of cells.

Arguments Required argument

faces A sequence of face objects whose centroid the method will calculate. The arguments faces and cells are mutually exclusive. cells A sequence of face objects whose centroid the method will calculate. The arguments faces and cells are mutually exclusive.
Optional argument

relativeAccuracy A Float specifying that the centroid computation should stop when the specified relative accuracy has been achieved. The default value is 0.000001 (0.0001%).
Return value

A sequence of Floats specifying the X-, Y-, and Z-coordinates of the centroid.
Exceptions

None.

32–17

Part object

32.1.22

getCoordinates(...)

This method returns the coordinates of specified point.
Arguments Required arguments

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

None.
Return value

A tuple of 3 Floats representing the coordinates of the specified point.
Exceptions

None.

32.1.23

getCurvature(...)

This method returns the maximum curvature of a given edge or group of edges. For an arc, the curvature is constant over the entire edge, and equal to the inverse of the radius. For a straight line, the curvature is constant and equal to 0. For a spline edge, the curvature varies over a range, and this methods computes the maximum.
Arguments Required argument

edges A sequence of edge objects whose curvature the method will calculate.
Optional argument

samplePoints An Int specifying the number of points along each edge at which the curvature will be computed. The higher the number of sample points, the better the accuracy of the computation. The default value is 100.
Return value

A Float specifying the maximum curvature.

32–18

Part object

Exceptions

None.

32.1.24

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, Node, or Edge specifying the first entity from which to measure. entity2 A Vertex, Datum point, Node, or Edge specifying the second entity to which to measure.
Optional arguments

None.
Return value

A Float specifying the distance between entity1 and entity2.
Exceptions

None.

32.1.25

getPerimeter(...)

This method returns the total perimerter of a given face or group of faces. All faces need to be on the same part. If the specified faces have shared edges, these edges are excluded from the computation, thus providing the length of the outer perimeter of the specified faces.
Arguments Required argument

faces A sequence of face objects whose perimeter the method will calculate.
Optional arguments

None.

32–19

Part object

Return value

A Float specifying the perimeter.
Exceptions

None.

32.1.26

getVolume(...)

This method returns the volume area of a given cell or group of cells.
Arguments Required argument

cells A sequence of cell objects whose volume the method will calculate.
Optional argument

relativeAccuracy A Float specifying the relative accuracy of the computation. The default value is 0.000001 (0.0001%).
Return value

A Float specifying the sum of the areas of the given faces.
Exceptions

None.

32.1.27

isAlignedWithSketch()

This method checks if the normal of an analytical rigid surface part is aligned with that of its sketch.
Arguments

None.
Return value

A Boolean value of TRUE if the part is aligned with the sketch and FALSE if it is not aligned.
Exceptions

This method can be used only with analytical rigid parts.

32–20

Part object

AbaqusException: Can be used only with analytical rigid parts

32.1.28

printAssignedSections()

This method prints information on each section that has been assigned to a region of the part.
Arguments

None.
Return value

None
Exceptions

None.

32.1.29

projectEdgesOntoSketch(...)

This method projects the selected edges of a part onto the specified Sketch object. The edges appear as sketch geometry after projection. If the plane of projection is not parallel to the specified edge, the resultant sketch geometry may be of a different type. For example, a circular edge can be projected as an ellipse or a line depending on the angle of the plane of projection. By default, the projected edge will be constrained to the background geometry. You can remove this constraint by setting constrainToBackground to FALSE.
Arguments Required arguments

sketch The Sketch object on which the edges are projected. edges A sequence of candidate edges to be projected onto the sketch.
Optional argument

constrainToBackground A Boolean that determines whether the projected edges need to constrained to the background geometry. The default is TRUE.
Return value

None

32–21

Part object

Exceptions

None.

32.1.30

projectReferencesOntoSketch(...)

This method projects the vertices of specified edges, and datum points from the part onto the specified Sketch object. The vertices, and datum points appear on the Sketch as reference geometry.
Arguments Required argument

sketch The Sketch 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 COPLANAR_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, part entities in features created before the sketch you are editing are candidates for projection. edges A sequence of candidate edges whose vertices need to be projected onto the sketch. By default, all edges specified by the filter argument 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.

32–22

Part object

32.1.31

queryAttributes()

This method prints the following information about a part:

• •

the name, modeling space, and analysis type; and whether twist is included (only available when the modeling space is axisymmetric and the analysis type is deformable).

Arguments

None.
Return value

None
Exceptions

None.

32.1.32

queryCachedStates()

This method displays the position of geometric states relative to the sequence of features in the part cache. The output is displayed in the message area.
Arguments

None.
Return value

None
Exceptions

None.

32.1.33

queryGeometry()

This method prints the following information about a part:

• • •

the name, modeling space, and analysis type; whether twist is included (only available when the modeling space is axisymmetric and the analysis type is deformable); a 3D point representing the minimum of the part’s bounding box;

32–23

Part object

• • •

a 3D point representing the maximum of the part’s bounding box; a 3D point representing the part’s centroid (only on 3D solid parts); and the volume (only on 3D solid parts).

Arguments Required arguments

None.
Optional argument

relativeAccuracy A Float specifying that the property computations should stop when the specified relative accuracy has been achieved. The default value is 0.000001 (0.0001%).
Return value

None
Exceptions

None.

32.1.34

queryVolumeProperties(...)

This method displays information about the solid cells of the part. It displays the part name, the volume, the coordinates of the centroid, and the moments of inertia about the global coordinate system.
Arguments Required arguments

None.
Optional argument

relativeAccuracy A Float specifying that the volume property computations should stop when the specified relative accuracy has been achieved. The default value is 0.000001 (0.0001%).
Return value

None
Exceptions

None.

32–24

Part object

32.1.35

regenerate(...)

This method regenerates a part. When you modify features, it may be convenient to postpone regeneration until you make all your changes, since regeneration can be time consuming.
Arguments

None.
Return value

None
Exceptions

None.

32.1.36

removeInvalidGeometry(...)

Removes all invalid entities from the part, leaving a valid part. This is not recorded as a feature in the feature list, therefore it should be used on parts that have a single feature (such as an imported part). Note: This may remove valid entities that are connected to invalid ones. You can identify invalid entities using the query toolset before using this command.
Arguments

None.
Return value

None
Exceptions

None.

32.1.37

restore()

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

None.

32–25

Part object

Return value

None
Exceptions

None.

32.1.38

resumeAllFeatures()

This method resumes all the suppressed features in the part.
Arguments

None.
Return value

None
Exceptions

None.

32.1.39

resumeFeatures(...)

This method resumes the specified suppressed features in the part.
Arguments Required argument

featureNames A tuple of names of features which are to be resumed.
Optional arguments

None.
Return value

None
Exceptions

None.

32–26

Part object

32.1.40

resumeLastSetFeatures()

This method resumes the last set of features to be suppressed in the part.
Arguments

None.
Return value

None
Exceptions

None.

32.1.41

saveGeometryCache()
Caching the current geometry improves regeneration

This method caches the current geometry. performance.
Arguments

None.
Return value

None
Exceptions

None.

32.1.42

suppressFeatures(...)

This method suppresses the given features.
Arguments Required argument

featureNames A tuple of names of features which are to be suppressed in the part.
Optional arguments

None.

32–27

Part object

Return value

None
Exceptions

None.

32.1.43

writeAcisFile(...)

This method exports the geometry of the part 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 ’4.2’ corresponds to ACIS version 4.2. The default value is the current version of ACIS.
Return value

None
Exceptions

If the part is an orphan mesh part: Cannot export orphan mesh parts to ACIS.

32.1.44

writeIgesFile(...)

This method exports the geometry of the part to a named file in IGES format.
Arguments Required arguments

fileName A String specifying the name of the file to which to write. flavor A SymbolicConstant specifying a particular flavor of IGES. Possible values are STANDARD, AUTOCAD, SOLIDWORKS, JAMA, and MSBO.

32–28

Part object

Optional arguments

None.
Return value

None
Exceptions

If the part is an orphan mesh part: Cannot export orphan mesh parts to IGES.

32.1.45

writeStepFile(...)

This method exports the geometry of the part to a named file in STEP format.
Arguments Required argument

fileName A String specifying the name of the file to which to write.
Optional arguments

None.
Return value

None
Exceptions

If the part contains no geometry: Parterror: Cannot export orphan mesh parts to STEP.

32.1.46

writeVdaFile(...)

This method exports the geometry of the part to a named file in VDA-FS format.
Arguments Required arguments

fileName A String specifying the name of the file to which to write.
Optional arguments

None.

32–29

Part object

Return value

None
Exceptions

If the part is an orphan mesh part: Cannot export orphan mesh parts to VDA-FS.

32.1.47

Members

The Part object has members with the same names and descriptions as the arguments to the Part method. In addition, the Part object can have the following members: vertices A VertexArray object containing all the vertices in the part. edges An EdgeArray object containing all the edges in the part. faces A FaceArray object containing all the facces in the part. cells A CellArray object containing all the cells in the part. features An array of Feature objects containing all the features in the part. featuresById An array of all Feature objects. 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. datums An array of Datum objects containing all the datums in the part. elements An array of MeshElement objects containing all the elements in the part. elemFaces An array of MeshFace objects containing all the element face in the part. nodes An array of MeshNode objects containing all the nodes in the part. sets A repository of Set objects. For more information, see “Set object,” Section 39.4.

32–30

Feature object

allSets A repository of Set objects. The contents of the allSets repository is the same as the contents of the sets repository. allInternalSets A repository of Set objects created for picked regions. surfaces A repository of Surface objects. For more information, see “Surface object,” Section 39.5. allSurfaces A repository of Surface objects. The contents of the allSurfaces repository is the same as the contents of the surfaces repository. allInternalSurfaces A repository of Surface objects created for picked regions. referencePoints An array of ReferencePoint objects. engineeringFeatures An EngineeringFeature object. reinforcement A Reinforcement object. sectionAssignments An array of SectionAssignment objects. elemEdges An array of MeshEdge objects.

32.2

Feature object

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

import part

32.2.1

AddCells(...)

This method tries to convert a shell entity to a solid entity. The conversion is not always successful.
Path

mdb.models[name].parts[name].AddCells

32–31

Feature object

Required argument

faceList A sequence of Face objects specifying the faces bounding the cell to add.
Optional argument

flipped A Boolean specifying the direction of feature creation. The possible values are TRUE and FALSE. The default is TRUE indicating that the direction is opposite to the face normal. When multiple faces are selected, ABAQUS attempts to create cells on both sides of the selected faces and ignores the flipped argument.
Return value

A Feature object.
Exceptions

None.

32.2.2

AddFaces(...)

This method generates a face using the given edges as the face’s boundaries. The AddFaces method generates a face by creating the geometry consisting of the underlying surface, associated edges, and vertices.
Path

mdb.models[name].parts[name].AddFaces
Required argument

edgeList A sequence of Edge objects specifying the edges that bound the new face.
Optional argument

tryAnalytical A Boolean specifying whether the newly created face should be analytical or not. The default is FALSE.
Return value

A Feature object.
Exceptions

If the given boundary is not a closed loop:

32–32

Feature object

Parterror: Cannot find a closed loop If the given boundary contains a zero length component: Parterror: Cannot find a closed loop If the underlying surface is too difficult to fit: Parterror: Cannot construct face geometry

32.2.3

AnalyticRigidSurf2DPlanar(...)

This method creates a first Feature object for an analytical rigid surface by creating a planar wire from the given Sketch object.
Path

mdb.models[name].parts[name].AnalyticRigidSurf2DPlanar
Required argument

sketch A Sketch object specifying the planar wire.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.4

AnalyticRigidSurfExtrude(...)

This method creates a first Feature object for an analytical rigid surface by extruding the given Sketch object by the given depth, creating a surface.
Path

mdb.models[name].parts[name].AnalyticRigidSurfExtrude
Required argument

sketch A Sketch object specifying the planar wire.
Optional argument

depth A Float specifying the extrusion depth. The default value is 1.0.

32–33

Feature object

Return value

A Feature object.
Exceptions

None.

32.2.5

AnalyticRigidSurfRevolve(...)

This method creates a first Feature object for an analytical rigid surface by revolving the given Sketch object by 360° about the Y-axis.
Path

mdb.models[name].parts[name].AnalyticRigidSurfRevolve
Required argument

sketch A Sketch object specifying the surface to be revolved.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.6

BaseSolidExtrude(...)

This method creates a first Feature object by extruding the given Sketch object by the given depth, creating a solid. The Sketch object must define a closed profile.
Path

mdb.models[name].parts[name].BaseSolidExtrude
Required arguments

sketch A Sketch object specifying the plane shape to be extruded. depth A Float specifying the extrusion depth. Possible values are 10–5 depth 105 .

32–34

Feature object

Optional arguments

draftAngle A Float specifying the draft angle in degrees. Possible values are -90.0 draftAngle 90.0. By convention, for a positive draft angle an outer loop will draft outward and an inner loop will draft inward. The opposite is true for a negative draft angle. The default value, 0, implies a normal extrude. The arguments draftAngle and pitch are mutually exclusive. pitch A Float specifying the pitch. The pitch is the distance traveled along the axial direction by the sketch when the sketch has completed one full revolution about the twist axis. Pitch can be specified as positive or negative to achieve right-handed or left-handed twist about the twist axis, respectively. The default value, 0, implies a normal extrude. Possible values are –105 pitch 105 . The arguments draftAngle and pitch are mutually exclusive.
Return value

A Feature object.
Exceptions

RangeError.

32.2.7

BaseSolidRevolve(...)

This method creates a first Feature object by revolving the given Sketch object by the given angle, creating a solid. The Sketch object must define a closed profile and an axis of revolution. The axis is defined by a single construction line.
Path

mdb.models[name].parts[name].BaseSolidRevolve
Required arguments

sketch A Sketch object specifying the shape to be revolved. angle A Float specifying the revolve angle in degrees. Possible values are 10–4 Note: If pitch
Optional arguments

angle

360.

0, there is no upper limit for angle.

pitch A Float specifying the pitch. The pitch is the distance traveled along the axial direction, measured between corresponding points on the sketch when it has completed one full revolution about the

32–35

Feature object

axis of revolution. Possible values are 0 pitch 105 . The default value, 0, implies a normal revolve. flipRevolveDirection A Boolean specifying whether to override the direction of feature creation. If flipRevolveDirection=OFF, the default direction of revolution is used. If flipRevolveDirection=ON, the revolve direction is reversed. The default value is OFF. flipPitchDirection A Boolean specifying whether to override the direction of translation. If flipPitchDirection=OFF, the direction of translation is given by the direction of the revolve axis. If flipPitchDirection=ON, the translation direction is reversed. The default value is OFF. moveSketchNormalToPath A Boolean specifying whether to rotate the sketch so that it is normal to the path of revolution when using the pitch option. If moveSketchNormalToPath=OFF, the sketch plane remains parallel to the revolve axis. If moveSketchNormalToPath=ON, the sketch is moved to match the angle created by the pitch before being revolved. The default value is OFF.
Return value

A Feature object.
Exceptions

RangeError.

32.2.8

BaseSolidSweep(...)

This method creates a first Feature object by sweeping the given profile Sketch object along the path defined by the path Sketch object, creating a solid. The profile Sketch object must define a closed profile. The origin of the profile sketch is positioned at the start of the sweep path and swept perpendicular to the path. No checks are made for self-intersection.
Path

mdb.models[name].parts[name].BaseSolidSweep
Required arguments

sketch A Sketch object specifying the profile to be swept. path A Sketch object specifying the path of the sweep.
Optional arguments

None.

32–36

Feature object

Return value

A Feature object.
Exceptions

None.

32.2.9

BaseShell(...)

This method creates a first Feature object by creating a planar shell from the given Sketch object. The Sketch object must define a closed profile.
Path

mdb.models[name].parts[name].BaseShell
Required argument

sketch A Sketch object specifying the planar shell.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.10

BaseShellExtrude(...)

This method creates a first Feature object by extruding the given Sketch object by the given depth, creating a shell. The Sketch object can define either an open or closed profile.
Path

mdb.models[name].parts[name].BaseShellExtrude
Required arguments

sketch A Sketch object specifying the shape to be extruded.

32–37

Feature object

depth A Float specifying the extrusion depth. Possible values are Floats > 0.
Optional arguments

draftAngle A Float specifying the draft angle in degrees. Possible values are -90.0 draftAngle 90.0. By convention, for a positive draft angle an outer loop will draft outward and an inner loop will draft inward. The opposite is true for a negative draft angle. The default value, 0, implies a normal extrude. The arguments draftAngle and pitch are mutually exclusive. pitch A Float specifying the pitch. The pitch is the distance traveled along the axial direction by the sketch when the sketch has completed one full revolution about the twist axis. Pitch can be specified as positive or negative to achieve right-handed or left-handed twist about the twist axis, respectively. The default value, 0, implies a normal extrude. Possible values are –105 pitch 105 . The arguments draftAngle and pitch are mutually exclusive.
Return value

A Feature object.
Exceptions

RangeError.

32.2.11

BaseShellRevolve(...)

This method creates a first Feature object by revolving the given Sketch object by the given angle, creating a shell. The Sketch object can define either an open or closed profile and an axis of revolution. The axis is defined by a single construction line.
Path

mdb.models[name].parts[name].BaseShellRevolve
Required arguments

sketch A Sketch object specifying the shape to be revolved. angle A Float specifying the revolve angle in degrees. Possible values are 0 Note: If pitch 0, there is no upper limit for angle. angle 360.

32–38

Feature object

Optional arguments

pitch A Float specifying the pitch. The pitch is the distance traveled along the axial direction, measured between corresponding points on the sketch when it has completed one full revolution about the axis of revolution. Possible values are 0 pitch 105 . The default value, 0, implies a normal revolve. flipRevolveDirection A Boolean specifying whether to override the direction of feature creation. If flipRevolveDirection=OFF, the default direction of revolution is used. If flipRevolveDirection=ON, the revolve direction is reversed. The default value is OFF. flipPitchDirection A Boolean specifying whether to override the direction of translation. If flipPitchDirection=OFF, the direction of translation is given by the direction of the revolve axis. If flipPitchDirection=ON, the translation direction is reversed. The default value is OFF. moveSketchNormalToPath A Boolean specifying whether to rotate the sketch so that it is normal to the path of revolution when using the pitch option. If moveSketchNormalToPath=OFF, the sketch plane remains parallel to the revolve axis. If moveSketchNormalToPath=ON, the sketch is moved to match the angle created by the pitch before being revolved. The default value is OFF.
Return value

A Feature object.
Exceptions

None.

32.2.12

BaseShellSweep(...)

This method creates a first Feature object by sweeping the given section Sketch object along the path defined by the path Sketch object, creating a shell. The sketch object can define either an open or closed profile. The origin of the profile sketch is positioned at the start of the sweep path and swept perpendicular to the path. No checks are made for self-intersection.
Path

mdb.models[name].parts[name].BaseShellSweep
Required arguments

sketch A Sketch object specifying the section to be swept.

32–39

Feature object

path A Sketch object specifying the path of the sweep.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.13

BaseWire(...)

This method creates a first Feature object by creating a planar wire from the given Sketch object.
Path

mdb.models[name].parts[name].BaseWire
Required arguments

sketch A Sketch object specifying the planar wire.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.14

Chamfer(...)

This method creates an additional Feature object by chamfering the given list of edges with a given length.
Path

mdb.models[name].parts[name].Chamfer

32–40

Feature object

Required arguments

length A Float specifying the length of the chamfer. edgeList A sequence of Edge objects specifying the edges to chamfer.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.15

ConvertToAnalytical(...)

This method attempts to change entities into a simpler form that will speed up processing and make entities available during feature operations.
Path

mdb.models[name].parts[name].ConvertToAnalytical
Required arguments

None.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.16

ConvertToPrecise(...)

This method attempts to change imprecise entities so that the geometry becomes precise.

32–41

Feature object

Path

mdb.models[name].parts[name].ConvertToPrecise
Required arguments

None.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.17

Cut(...)

This method creates an additional Feature object by cutting a hole using the given Sketch object.
Path

mdb.models[name].parts[name].Cut
Required arguments

sketchPlane A Datum plane object or a planar Face object. sketchPlaneSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the sketch. sketch A Sketch object specifying the planar cut.
Optional argument

sketchOrientation A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM.
Return value

A Feature object.

32–42

Feature object

Exceptions

None.

32.2.18

CutExtrude(...)

This method creates an additional Feature object by extruding the given Sketch object by the given depth and cutting away material in the solid and shell regions of the part. The Sketch object must define a closed profile. The CutExtrude method creates a blind cut (using depth), an up-to-face cut (using upToFace), or a through-all cut (if depth and upToFace are not specified).
Path

mdb.models[name].parts[name].CutExtrude
Required arguments

sketchPlane A Datum plane object or a planar Face object. sketchPlaneSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the sketch. sketchOrientation A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. sketch A Sketch object specifying the planar sketch to be extruded.
Optional arguments

depth A Float specifying the extrusion depth. If depth is specified, the cut will be a blind cut. The default is to not specify a depth. upToFace A Face specifying the face up to which to cut. If upToFace is specified, the cut will be an up-to-face cut. The default is to not specify a face. Note: If neither depth nor upToFace are specified, the cut will be a through-all cut. draftAngle A Float specifying the draft angle in degrees. Possible values are -90.0 draftAngle 90.0. By convention, for a positive draft angle an outer loop will draft outward and an inner loop will draft

32–43

Feature object

inward. The opposite is true for a negative draft angle. The default value, 0, implies a normal extrude. The arguments draftAngle and pitch are mutually exclusive. pitch A Float specifying the pitch. The pitch is the distance traveled along the axial direction by the sketch when the sketch has completed one full revolution about the twist axis. Pitch can be specified as positive or negative to achieve right-handed or left-handed twist about the twist axis, respectively. The default value, 0, implies a normal extrude. Possible values are –105 pitch 105 . The arguments draftAngle and pitch are mutually exclusive. flipExtrudeDirection A Boolean specifying whether to override the direction of feature creation. If the value is OFF, it means use the direction defined by the sketchPlaneSide; if the value is ON, it means use the opposite direction to the one defined by sketchPlaneSide. The default value is OFF.
Return value

A Feature object.
Exceptions

None.

32.2.19

CutLoft(...)

This method creates an additional Feature object by lofting between the given sections and cutting away material from the part. You define the sections using a sequence of edges from the part or an EdgeArray.
Path

mdb.models[name].parts[name].CutLoft
Required argument

loftSections A sequence of sequences of edges specifying the cross-sections to be lofted. Each outer sequence specifies a section through which the method will pass the loft feature. Each outer sequence can be defined as a sequence of edges or as an EdgeArray. The edges specifying a section must form a simple closed profile and must not contain multiple loops.
Optional arguments

startCondition A SymbolicConstant specifying the tangent direction at the start section of the loft feature. Possible values are NONE, NORMAL, RADIAL and SPECIFIED. You can specify this argument only if the start and end sections are planar. You cannot use this argument in conjunction with the path argument. You must use the startCondition argument in conjunction with the endCondition argument.

32–44

Feature object

endCondition A SymbolicConstant specifying the tangent direction at the end section of the loft feature. Possible values are NONE, NORMAL, RADIAL and SPECIFIED. You can specify this argument only if the start and end sections are planar. You cannot use this argument in conjunction with the path argument. You must use the endCondition argument in conjunction with the startCondition argument. startTangent A Float specifying the angle in degrees of the tangent with respect to the plane in which the start section lies. You must specify the startTangent argument if startCondition=SPECIFIED. Possible values are 0.0 startTangent 180.0. startMagnitude A Float specifying the magnitude of the startTangent. You must specify the startMagnitude argument if startCondition=SPECIFIED. Possible values are 0.0 startMagnitude 100.0. endTangent A Float specifying the angle in degrees of the tangent with respect to the plane in which the end section lies. You must specify the endTangent argument if startCondition=SPECIFIED. Possible values are 0.0 endTangent 180.0. endMagnitude A Float specifying the magnitude of the endTangent. This argument is to be used when the endCondition argument has the value SPECIFIED. Possible values are 0.0 endMagnitude 100.0. globalSmoothing A Boolean specifying whether each path defined in the paths argument is applied locally or globally.

• •

If the path is applied locally, its effect is felt only on faces created from the edges on the loftSections through which the paths pass through. If the path is applied globally, an averaging algorithm is applied over all the paths defined and is distributed over all the faces created.

The default value is ON (globally).

Return value

A Feature object.

Exceptions

None.

32–45

Feature object

32.2.20

CutRevolve(...)

This method creates an additional Feature object by revolving the given Sketch object by the given angle and cutting away material from the part. The Sketch object must define a closed profile and an axis of revolution.
Path

mdb.models[name].parts[name].CutRevolve
Required arguments

sketchPlane A Datum plane object or a planar Face object. sketchPlaneSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the sketch. sketchOrientation A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. sketch A Sketch object specifying the planar sketch to be revolved. angle A Float specifying the angle in degrees to be revolved.
Optional arguments

pitch A Float specifying the pitch. The pitch is the distance traveled along the axial direction, measured between corresponding points on the sketch when it has completed one full revolution about the axis of revolution. Possible values are 0 pitch 105 . The default value, 0, implies a normal revolve. flipRevolveDirection A Boolean specifying whether to override the direction of feature creation. If flipRevolveDirection=OFF, the default direction of revolution is used. If flipRevolveDirection=ON, the revolve direction is reversed. The default value is OFF. flipPitchDirection A Boolean specifying whether to override the direction of translation. If flipPitchDirection=OFF, the direction of translation is given by the direction of the revolve axis. If flipPitchDirection=ON, the translation direction is reversed. The default value is OFF.

32–46

Feature object

moveSketchNormalToPath A Boolean specifying whether to rotate the sketch so that it is normal to the path of revolution when using the pitch option. If moveSketchNormalToPath=OFF, the sketch plane remains parallel to the revolve axis. If moveSketchNormalToPath=ON, the sketch is moved to match the angle created by the pitch before being revolved. The default value is OFF.
Return value

A Feature object.
Exceptions

None.

32.2.21

CutSweep(...)

This method creates an additional Feature object by sweeping the given Sketch object along a path and cutting away material from the part. The section Sketch object must define a closed profile. The origin of the section sketch is positioned at the start of the sweep path, and the sketch is swept perpendicular to the path. No checks are made for self-intersection.
Path

mdb.models[name].parts[name].CutSweep
Required arguments

pathPlane A Datum plane object or a planar Face object. pathUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the path sketch. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the profile sketch. pathOrientation A SymbolicConstant specifying the orientation of pathUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. path A Sketch object specifying the path of the sweep. sketchOrientation A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. sketch A Sketch object specifying the planar section to be swept.

32–47

Feature object

sketchPlane A Datum plane object or a planar Face object.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.22

HoleBlindFromEdges(...)

This method creates an additional Feature object by creating a circular blind hole of the given diameter and depth and cutting away material in the solid and shell regions of the part. The center of the hole is offset from two non-parallel straight edges by the given distances.
Path

mdb.models[name].parts[name].HoleBlindFromEdges
Required arguments

plane A Datum plane object or a planar Face object. planeSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. diameter A Float specifying the diameter of the hole. edge1 An Edge object specifying the edge from which distance1 is measured. distance1 A Float specifying the offset from edge1. edge2 An Edge object specifying the edge from which distance2 is measured. distance2 A Float specifying the offset from edge2. depth A Float specifying the depth of the hole.

32–48

Feature object

Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.23

HoleFromEdges(...)

This method creates an additional Feature object by creating a circular hole of the given diameter in a 2D planar part and cutting away material in the shell and wire regions of the part. The center of the hole is offset from two non-parallel straight edges by the given distances.
Path

mdb.models[name].parts[name].HoleFromEdges
Required arguments

diameter A Float specifying the diameter of the hole. edge1 An Edge object specifying the edge from which distance1 is measured. distance1 A Float specifying the offset from edge1. edge2 An Edge object specifying the edge from which distance2 is measured. distance2 A Float specifying the offset from edge2.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32–49

Feature object

32.2.24

HoleThruAllFromEdges(...)

This method creates an additional Feature object by creating a circular through hole of the given diameter and cutting away material in the solid and shell regions of the part. The center of the hole is offset from two non-parallel straight edges by the given distances.
Path

mdb.models[name].parts[name].HoleThruAllFromEdges
Required arguments

plane A Datum plane object or a planar Face object. planeSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. diameter A Float specifying the diameter of the hole. edge1 An Edge object specifying the edge from which distance1 is measured. distance1 A Float specifying the offset from edge1. edge2 An Edge object specifying the edge from which distance2 is measured. distance2 A Float specifying the offset from edge2.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.25

MergeEdges(...)

This method merges edges either by extending the user selection or using only the selected edges.

32–50

Feature object

Path

mdb.models[name].parts[name].MergeEdges
Required arguments

None.
Optional arguments

edgeList A sequence of Edge objects specifying the edges to be merged. extendSelection A Boolean specifying whether the user selection needs to be extended to include edges till branching occurs. Branching is said to occur when the vertex of an edge is shared by more than two edges.
Return value

A Feature object.
Exceptions

None.

32.2.26

RemoveCells(...)

This method converts a solid entity to a shell entity.
Path

mdb.models[name].parts[name].RemoveCells
Required argument

cellList A sequence of Cell objects specifying the cells to remove.
Optional arguments

None.
Return value

A Boolean value.
Exceptions

If the intended volume to be turned into a shell entity is not three-dimensional. Parterror: Geometry that is not 3-dimensional does not contain cells.

32–51

Feature object

32.2.27

RemoveFaces(...)

This method removes faces from a solid entity or from a shell entity.
Path

mdb.models[name].parts[name].RemoveFaces
Required argument

faceList A sequence of Face objects specifying the faces to remove.
Optional argument

deleteCells A Boolean specifying whether all cells are to be deleted when the faces are removed. The default value is FALSE.
Return value

A Feature object.
Exceptions

None.

32.2.28

RemoveFacesAndStitch(...)

This method removes faces from a solid entity and attempts to close the resulting gap by extending the neighboring faces of the solid.
Path

mdb.models[name].parts[name].RemoveFacesAndStitch
Required argument

faceList A sequence of Face objects specifying the faces to remove.
Optional arguments

None.
Return value

A Feature object.

32–52

Feature object

Exceptions

None.

32.2.29

RemoveRedundantEntities(...)

This method removes redundant edges and vertices from a solid or a shell entity. One of the two arguments is required.
Path

mdb.models[name].parts[name].RemoveRedundantEntities
Required arguments

None.
Optional arguments

vertexList A sequence of Vertex objects specifying the vertices to be removed. edgeList A sequence of Edge objects specifying the edges to be removed. removeEdgeVertices A Boolean specifying whether the vertices of the redundant edges need to be removed. The default is TRUE.
Return value

A Feature object.
Exceptions

If the selected entity is not a redundant entity. Parterror: None of the selected entities are redundant.

32.2.30

RepairFaceNormals(...)

This method aligns all the face normals of a shell entity. For a solid entity, the method inverts all of the faces’ normals if the solid was originally inside out.
Path

mdb.models[name].parts[name].RepairFaceNormals
Required arguments

None.

32–53

Feature object

Optional arguments

None.
Return value

A Feature object.
Exceptions

If the selected faces are shells and are non-manifold. Parterror: Feature failed.

32.2.31

RepairInvalidEdges(...)

This method repairs invalid edges. It will always attempt to improve edges even if none of selected edges are initially invalid and may leave behind invalid edges that could not be repaired.
Path

mdb.models[name].parts[name].RepairInvalidEdges
Required argument

edgeList A sequence of Edge objects.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.32

RepairSliver(...)

This method repairs the selected sliver from the selected face. The sliver area is specified using two points. A face partition is carried out at the specified points and the smaller of the two faces is removed.
Path

mdb.models[name].parts[name].RepairSliver

32–54

Feature object

Required arguments

face A Face object specifying the face on which the sliver is located. point1 A point specifying the location for partition creation. It can be a Vertex object, an Interesting Point or three coordinates specifying the point on an edge of the face. point2 A point specifying the location for partition creation. It can be a Vertex object, an Interesting Point or three coordinates specifying the point on an edge of the face.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.33

RepairSmallEdges(...)

This method repairs small edges. This method will attempt to replace selected small edges with vertices and extend the adjacent faces and edges. This method might leave behind some small edges that cannot be removed.
Path

mdb.models[name].parts[name].RepairSmallEdges
Required argument

edgeList A sequence of Edge objects.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32–55

Feature object

32.2.34

RepairSmallFaces(...)

This method repairs small faces. It will attempt to replace the selected small faces with edges and extend the adjacent faces. This method might leave behind some small faces that cannot be removed.
Path

mdb.models[name].parts[name].RepairSmallFaces
Required argument

faceList A sequence of Face objects.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.35

ReplaceFaces(...)

This method replaces the selected faces with a single face. If one single face is selected, that alone is replaced with a new face.
Path

mdb.models[name].parts[name].ReplaceFaces
Required argument

faceList A sequence of Face objects to be replaced.
Optional argument

stitch A Boolean specifying whether the newly created face needs to be stitched to the existing geometry. The default is TRUE.
Return value

A Feature object.

32–56

Feature object

Exceptions

None.

32.2.36

Round(...)

This method creates an additional Feature object by rounding (filleting) the given list of edges with the given radius. Solid and Shell edges of a part can be rounded. The operation will fail for non-manifold edges.
Path

mdb.models[name].parts[name].Round
Required arguments

radius A Float specifying the radius of the fillets. edgeList A sequence of Edge objects.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.37

Shell(...)

This method creates an additional Feature object by creating a planar shell from the given Sketch object. The Sketch object must define a closed profile.
Path

mdb.models[name].parts[name].Shell
Required arguments

sketchPlane A Datum plane object or a planar Face object.

32–57

Feature object

sketchPlaneSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the sketch. sketch A Sketch object specifying the planar shell.
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

None.

32.2.38

ShellExtrude(...)

This method creates an additional Feature object by extruding the given Sketch object by the given depth, creating a shell protrusion. The Sketch object can define either an open or closed profile.
Path

mdb.models[name].parts[name].ShellExtrude
Required arguments

sketchPlane A Datum plane object or a planar Face object. sketchPlaneSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the sketch. sketch A Sketch object specifying the planar sketch to be extruded.

32–58

Feature object

Optional arguments

depth A Float specifying the extrusion depth. The default is to not specify a depth. Either depth or upToFace must be used to define the extrusion depth. upToFace A Face specifying the face up to which to extrude. If upToFace is specified, the extrusion will be an up-to-face extrusion.The default is to not specify a face. Either depth or upToFace must be used to define the extrusion depth. sketchOrientation A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. The default value is RIGHT. draftAngle A Float specifying the draft angle in degrees. Possible values are -90.0 draftAngle 90.0. By convention, for a positive draft angle an outer loop will draft outward and an inner loop will draft inward. The opposite is true for a negative draft angle. The default value, 0, implies a normal extrude. The arguments draftAngle and pitch are mutually exclusive. pitch A Float specifying the pitch. The pitch is the distance traveled along the axial direction by the sketch when the sketch has completed one full revolution about the twist axis. Pitch can be specified as positive or negative to achieve right-handed or left-handed twist about the twist axis, respectively. The default value, 0, implies a normal extrude. Possible values are –105 pitch 105 . The arguments draftAngle and pitch are mutually exclusive. flipExtrudeDirection A Boolean specifying whether to override the direction of feature creation. If the value is OFF, it means use the direction defined by the sketchPlaneSide; if the value is ON, it means use the opposite direction to the one defined by sketchPlaneSide. The default value is OFF.
Return value

A Feature object.
Exceptions

None.

32.2.39

ShellLoft(...)

This method creates an additional Feature object by lofting between the given sections and adding shell faces to the part. You define the sections using a sequence of edges from the part or an EdgeArray.

32–59

Feature object

Path

mdb.models[name].parts[name].ShellLoft
Required argument

loftSections A sequence of sequences of edges specifying the cross-sections to be lofted. Each outer sequence specifies a section through which the method will pass the loft feature. Each outer sequence can be defined as a sequence of edges or as an EdgeArray. The edges specifying a section must form a simple closed profile and must not contain multiple loops.
Optional arguments

startCondition A SymbolicConstant specifying the tangent direction at the start section of the loft feature. Possible values are NONE, NORMAL, RADIAL and SPECIFIED. You can specify this argument only if the start and end sections are planar. You cannot use this argument in conjunction with the path argument. You must use the startCondition argument in conjunction with the endCondition argument. endCondition A SymbolicConstant specifying the tangent direction at the end section of the loft feature. Possible values are NONE, NORMAL, RADIAL and SPECIFIED. You can specify this argument only if the start and end sections are planar. You cannot use this argument in conjunction with the path argument. You must use the endCondition argument in conjunction with the startCondition argument. startTangent A Float specifying the angle in degrees of the tangent with respect to the plane in which the start section lies. You must specify the startTangent argument if startCondition=SPECIFIED. Possible values are 0.0 startTangent 180.0. startMagnitude A Float specifying the magnitude of the startTangent. You must specify the startMagnitude argument if startCondition=SPECIFIED. Possible values are 0.0 startMagnitude 100.0. endTangent A Float specifying the angle in degrees of the tangent with respect to the plane in which the end section lies. You must specify the endTangent argument if startCondition=SPECIFIED. Possible values are 0.0 endTangent 180.0. endMagnitude A Float specifying the magnitude of the endTangent. This argument is to be used when the endCondition argument has the value SPECIFIED. Possible values are 0.0 endMagnitude 100.0.

32–60

Feature object

paths A sequence of sequences of edges that pass through each section in the loft feature. Each sequence specifies a path followed by the face or an edge created by a loft feature. Each path must start at the first section, end at the last section, and pass through each section. In addition, the order of the sequences must be the same as the order of the sections in the loftSections argument. Each path must not self-intersect and must be tangent continuous. In addition, the paths must not intersect each other. You cannot use the paths argument in conjunction with the startCondition and endCondition arguments. globalSmoothing A Boolean specifying whether each path defined in the paths argument is applied locally or globally.

• •

If the path is applied locally, its effect is felt only on faces created from the edges on the loftSections through which the paths pass through. If the path is applied globally, an averaging algorithm is applied over all the paths defined and is distributed over all the faces created.

The default value is ON (globally).
Return value

A Feature object.
Exceptions

None.

32.2.40

ShellRevolve(...)

This method creates an additional Feature object by revolving the given Sketch object by the given angle, creating a shell protrusion. The Sketch object can define either an open or closed profile and an axis of revolution. The axis is defined by a single construction line. For a description of the plane positioning arguments, see SolidExtrude.
Path

mdb.models[name].parts[name].ShellRevolve
Required arguments

sketchPlane A Datum plane object or a planar Face object. sketchPlaneSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2.

32–61

Feature object

sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the sketch. sketch A Sketch object specifying the planar sketch to be revolved. angle A Float specifying the angle in degrees to be revolved.
Optional arguments

sketchOrientation A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. The default value is RIGHT. pitch A Float specifying the pitch. The pitch is the distance traveled along the axial direction, measured between corresponding points on the sketch when it has completed one full revolution about the axis of revolution. Possible values are 0 pitch 105 . The default value, 0, implies a normal revolve. flipRevolveDirection A Boolean specifying whether to override the direction of feature creation. If flipRevolveDirection=OFF, the default direction of revolution is used. If flipRevolveDirection=ON, the revolve direction is reversed. The default value is OFF. flipPitchDirection A Boolean specifying whether to override the direction of translation. If flipPitchDirection=OFF, the direction of translation is given by the direction of the revolve axis. If flipPitchDirection=ON, the translation direction is reversed. The default value is OFF. moveSketchNormalToPath A Boolean specifying whether to rotate the sketch so that it is normal to the path of revolution when using the pitch option. If moveSketchNormalToPath=OFF, the sketch plane remains parallel to the revolve axis. If moveSketchNormalToPath=ON, the sketch is moved to match the angle created by the pitch before being revolved. The default value is OFF.
Return value

A Feature object.
Exceptions

None.

32.2.41

ShellSweep(...)

This method creates an additional Feature object by sweeping the given Sketch object along the path Sketch, creating a solid swept protrusion. The section Sketch object can be an open or closed profile.

32–62

Feature object

The origin of the section sketch is positioned at the start of the sweep path sketch and swept perpendicular to the path. No checks are made for self-intersection.
Path

mdb.models[name].parts[name].ShellSweep
Required arguments

pathPlane A Datum plane object or a planar Face object specifying the plane on which the path is sketched. pathUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the path sketch. sketchPlane A Datum plane object or a planar Face object specifying the plane on which the profile is sketched. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the path sketch. pathOrientation A SymbolicConstant specifying the orientation of pathUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. path A Sketch object specifying the path of the sweep. sectionUp An Edge object or a Datum axis object specifying the vertical (Y) direction of the profile sketch. sketchOrientation A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. sketch A Sketch object specifying the planar section to be swept.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32–63

Feature object

32.2.42

SolidExtrude(...)

This method creates an additional Feature object by extruding the given Sketch object by the given depth, creating a solid protrusion. The Sketch object must define a closed profile.
Path

mdb.models[name].parts[name].SolidExtrude
Required arguments

sketchPlane A Datum plane object or a planar Face object. sketchPlaneSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the sketch. sketch A Sketch object specifying the planar sketch to be extruded.
Optional arguments

depth A Float specifying the extrusion depth. The default is to not specify a depth. Either depth or upToFace must be used to define the extrusion depth. upToFace A Face specifying the face up to which to extrude. If upToFace is specified, the extrusion will be an up-to-face extrusion.The default is to not specify a face. Either depth or upToFace must be used to define the extrusion depth. sketchOrientation A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. The default value is RIGHT. draftAngle A Float specifying the draft angle in degrees. Possible values are -90.0 draftAngle 90.0. By convention, for a positive draft angle an outer loop will draft outward and an inner loop will draft inward. The opposite is true for a negative draft angle. The default value, 0, implies a normal extrude. The arguments draftAngle and pitch are mutually exclusive. pitch A Float specifying the pitch. The pitch is the distance traveled along the axial direction by the sketch when the sketch has completed one full revolution about the twist axis. Pitch can be specified as positive or negative to achieve right-handed or left-handed twist about the twist axis,

32–64

Feature object

respectively. The default value, 0, implies a normal extrude. Possible values are –105 pitch 105 . The arguments draftAngle and pitch are mutually exclusive. flipExtrudeDirection A Boolean specifying whether to override the direction of feature creation. If the value is OFF, it means use the direction defined by the sketchPlaneSide; if the value is ON, it means use the opposite direction to the one defined by sketchPlaneSide. The default value is OFF.
Return value

A Feature object.
Exceptions

None.

32.2.43

SolidLoft(...)

This method creates an additional Feature object by lofting between the given sections and adding material to the part. You define the sections using a sequence of edges from the part or an EdgeArray.
Path

mdb.models[name].parts[name].SolidLoft
Required argument

loftSections A sequence of sequences of edges specifying the cross-sections to be lofted. Each outer sequence specifies a section through which ABAQUS will pass the loft feature. Each outer sequence can be defined as a sequence of edges or as an EdgeArray. The edges specifying a section must form a simple closed profile and must not contain multiple loops.
Optional arguments

startCondition A SymbolicConstant specifying the tangent direction at the start section of the loft feature. Possible values are NONE, NORMAL, RADIAL and SPECIFIED. You can specify this argument only if the start and end sections are planar. You cannot use this argument in conjunction with the path argument. You must use the startCondition argument in conjunction with the endCondition argument. endCondition A SymbolicConstant specifying the tangent direction at the end section of the loft feature. Possible values are NONE, NORMAL, RADIAL and SPECIFIED. You can specify this argument only if the start and end sections are planar. You cannot use this argument in conjunction with the path argument. You must use the endCondition argument in conjunction with the startCondition argument.

32–65

Feature object

startTangent A Float specifying the angle in degrees of the tangent with respect to the plane in which the start section lies. You must specify the startTangent argument if startCondition=SPECIFIED. Possible values are 0.0 startTangent 180.0. startMagnitude A Float specifying the magnitude of the startTangent. You must specify the startMagnitude argument if startCondition=SPECIFIED. Possible values are 0.0 startMagnitude 100.0. endTangent A Float specifying the angle in degrees of the tangent with respect to the plane in which the end section lies. You must specify the endTangent argument if startCondition=SPECIFIED. Possible values are 0.0 endTangent 180.0. endMagnitude A Float specifying the magnitude of the endTangent. This argument is to be used when the endCondition argument has the value SPECIFIED. Possible values are 0.0 endMagnitude 100.0. paths A sequence of sequences of edges that pass through each section in the loft feature. Each sequence specifies a path followed by the face or an edge created by a loft feature. Each path must start at the first section, end at the last section, and pass through each section. In addition, the order of the sequences must be the same as the order of the sections in the loftSections argument. Each path must not self-intersect and must be tangent continous. In addition, the paths must not intersect each other. You cannot use the paths argument in conjunction with the startCondition and endCondition arguments. globalSmoothing A Boolean specifying whether each path defined in the paths argument is applied locally or globally.

• •

If the path is applied locally, its effect is felt only on faces created from the edges on the loftSections through which the paths pass through. If the path is applied globally, an averaging algorithm is applied over all the paths defined and is distributed over all the faces created.

The default value is ON (globally).
Return value

A Feature object.
Exceptions

None.

32–66

Feature object

32.2.44

SolidRevolve(...)

This method creates an additional Feature object by revolving the given Sketch object by the given angle, creating a solid protrusion. The Sketch object must define a closed profile and an axis of revolution. The axis is defined by a single construction line.
Path

mdb.models[name].parts[name].SolidRevolve
Required arguments

sketchPlane A Datum plane object or a planar Face object. sketchPlaneSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the sketch. sketch A Sketch object specifying the planar sketch to be revolved. angle A Float specifying the angle in degrees to be revolved.
Optional arguments

sketchOrientation A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. The default value is RIGHT. pitch A Float specifying the pitch. The pitch is the distance traveled along the axial direction, measured between corresponding points on the sketch when it has completed one full revolution about the axis of revolution. Possible values are 0 pitch 105 . The default value, 0, implies a normal revolve. flipRevolveDirection A Boolean specifying whether to override the direction of feature creation. If flipRevolveDirection=OFF, the default direction of revolution is used. If flipRevolveDirection=ON, the revolve direction is reversed. The default value is OFF. flipPitchDirection A Boolean specifying whether to override the direction of translation. If flipPitchDirection=OFF, the direction of translation is given by the direction of the revolve axis. If flipPitchDirection=ON, the translation direction is reversed. The default value is OFF.

32–67

Feature object

moveSketchNormalToPath A Boolean specifying whether to rotate the sketch so that it is normal to the path of revolution when using the pitch option. If moveSketchNormalToPath=OFF, the sketch plane remains parallel to the revolve axis. If moveSketchNormalToPath=ON, the sketch is moved to match the angle created by the pitch before being revolved. The default value is OFF.
Return value

A Feature object.
Exceptions

None.

32.2.45

SolidSweep(...)

This method creates an additional Feature object by sweeping the given Sketch object along the path Sketch, creating a solid swept protrusion. The section Sketch object must define a closed profile. The origin of the section sketch is positioned at the start of the sweep path and then swept perpendicular to the path. No checks are made for self-intersection.
Path

mdb.models[name].parts[name].SolidSweep
Required arguments

pathPlane A Datum plane object or a planar Face object. pathUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the path sketch. sketchPlane A Datum plane object or a planar Face object specifying the plane on which to sketch. sketchPlaneSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the path sketch. pathOrientation A SymbolicConstant specifying the orientation of pathUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. path A Sketch object specifying the path of the sweep.

32–68

Feature object

sectionUp An Edge object or a Datum axis object specifying the vertical (Y) direction of the profile sketch. sketchOrientation A SymbolicConstant specifying the orientation of sketchUpEdge on the sketch. Possible values are RIGHT, LEFT, TOP, and BOTTOM. sketch A Sketch object specifying the planar section to be swept.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.46

Stitch(...)

This method attempts to create a valid part by binding the neighboring edges of each of the faces of the part.
Path

mdb.models[name].parts[name].Stitch
Required arguments

None.
Optional arguments

None.
Return value

A Feature object.
Exceptions

None.

32.2.47

Wire(...)

This method creates an additional Feature object by creating a planar wire from the given Sketch object. The Sketch object must define a closed profile.

32–69

Feature object

Path

mdb.models[name].parts[name].Wire
Required arguments

sketchPlane A Datum plane object or a planar Face object specifying the plane on which to sketch. sketchPlaneSide A SymbolicConstant specifying the direction of feature creation. Possible values are SIDE1 and SIDE2. sketchUpEdge An Edge object or a Datum axis object specifying the vertical (Y) direction of the sketch. sketch A Sketch object specifying the planar sketch to be revolved.
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

None.

32.2.48

WirePolyLine(...)

This method creates an additional Feature object by creating a polyline wire through a sequence of given points. Each point can be either a datum point, a vertex, an interesting point or a tuple.
Path

mdb.models[name].parts[name].WirePolyLine
Required argument

points A sequence of Vertex, Datum point, or InterestingPoint objects specifying the points through which the polyline wire will pass. points can also be a sequence of tuples of Floats. You must specify at least two values in the sequence.

32–70

Feature object

Optional argument

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.
Return value

A Feature object.
Exceptions

None.

32.2.49

WireSpline(...)

This method creates an additional Feature object by creating a spline wire that passes through a sequence of given points. Each point can be either a datum point, a vertex, an interesting point, or a tuple.
Path

mdb.models[name].parts[name].WireSpline
Required argument

points A sequence of Vertex, Datum point, or InterestingPoint objects specifying the points through which the spline wire will pass. points can also be a sequence of tuples of Floats. You must specify at least two values in the sequence.
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 spline wire with existing geometry. The default value is ON. smoothClosedSpline A Boolean specifying the behaviour of ABAQUS when the points defining a spline wire form a closed loop (the start and end points are the same). If smoothClosedSpline=ON, ABAQUS creates a smooth spline wire where the tangencies at the end point meet smoothly. If smoothClosedSpline=OFF, ABAQUS will not automatically create a smooth end condition. The default value in OFF.

32–71

AcisFile object

Return value

A Feature object
Exceptions

None.

32.3

AcisFile object

The AcisFile object is a file object used to open ACIS-, STEP-, and IGES-format files.
Access

import part

32.3.1

openAcis(...)

This method creates an AcisFile object from a file containing ACIS-format geometry. This object is subsequently used by the PartFromGeometryFile method.
Path

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

32–72

AcisFile object

Texterror: Failed to read ACIS file.

32.3.2

openCatia(...)

This method creates an AcisFile object from a file containing CATIA V4-format geometry. This object is subsequently used by the PartFromGeometryFile method.
Path

session.openCatia
Required argument

fileName A String specifying the path to the CATIA 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.

32.3.3

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

session.openEnf
Required arguments

fileName A String specifying the path to the Elysium Neutral File that was created by I-DEAS, Pro/ENGINEER, or CATIA V5.

32–73

AcisFile object

fileType A String specifying the type of CAD system that created the file. Possible values are “ideas”, “proe”, or “catiav5”.
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. 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.

32.3.4

openIges(...)

This method creates an AcisFile object from a file containing IGES-format geometry. This object is subsequently used by the PartFromGeometryFile method.
Path

session.openIges
Required argument

fileName A String specifying the path to the IGES file to open.
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.

32–74

AcisFile object

The default value is DEFAULT. scale A Float specifying the scaling factor to apply to the imported geometric entities. The default value is 1.0. msbo An Int specifying if the IGES file contains MSBO (Manifold Solid B-Rep Object) entities. Possible values are 1 for yes and 0 for no. The default value is 0. 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.

32.3.5

openParasolid(...)

This method creates an AcisFile object from a file containing Parasolid-format geometry. This object is subsequently used by the PartFromGeometryFile method.
Path

session.openParasolid
Required argument

fileName A String specifying the path to the Parasolid file to open.

32–75

AcisFile object

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.

32.3.6

openStep(...)

This method creates an AcisFile object from a file containing STEP-format geometry. This object is subsequently used by the PartFromGeometryFile method.
Path

session.openStep
Required argument

fileName A String specifying the path to the STEP file to open.
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.

32–76

AcisFile object

32.3.7

openVda(...)

This method creates an AcisFile object from a file containg VDA-FS-format geometry. This object is subsequently used by the PartFromGeometryFile method.
Path

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

32.3.8

writeAcisFile(...)

This method exports the part 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 ’4.2’ corresponds to ACIS version 4.2. The default value is the current version of ACIS.
Return value

None

32–77

AcisFile object

Exceptions

If the part is an orphan mesh part. AbaqusException: Cannot export orphan mesh parts to ACIS.

32.3.9

Members

The AcisFile object has the following member: numberOfParts An Int indicating the number of parts in the object.

32–78

PARTITION COMMANDS

33.

Partition commands
The partition commands are used to partition edges, faces, and cells into new regions. A partition command can be invoked for a Part object or for an Assembly object. The partition commands create Feature objects and are described in “Feature object,” Section 17.1.

33–1

Path object

34.

Path and Probe commands
Path commands are used to define a line through your model by specifying a series of points. You can view results along the path in the form of an X–Y plot. Probe commands are used to determine model data and analysis results at selected locations.

34.1

Path object

The Path object defines a line through your model by specifying a series of nodes or points.
Access

import visualization session.paths[name]

34.1.1

Path(...)

This method creates a Path object.
Path

session.Path
Required arguments

name A String specifying the repository key. type A SymbolicConstant specifying the type of path being created. Possible values are NODE_LIST, POINT_LIST, EDGE_LIST, CIRCUMFERENTIAL, and RADIAL. expression A sequence specifying the nodes or points that make up the path. The contents of the sequence depends on the type argument.

• • •

If type=NODE_LIST, expression must be a sequence of sequences. Each inner sequence contains two items, the first item is a String specifying the name of a part instance, and the second item can be either a sequence of Ints or a sequence of Strings, each specifying a range of Ints. If type=POINT_LIST, expression must be a sequence of tuples of three Floats, specifying the coordinates of each point. If type=EDGE_LIST, expression must be a sequence of sequences. Each inner sequence contains two items, the first item is a String specifying the name of the part instance, and the

34–1

Path object

second item is a sequence of tuples of four Ints that uniquely identify an element edge. The four Ints are: 1. The element label. 2. The element face index (one-based). 3. The face edge index (one-based). 4. The edge direction. A positive number specifies that the edge direction runs from the edge start node to the edge end node. A negative number specifies the opposite.



When type=CIRCUMFERENTIAL or RADIAL, expression must be a sequence of three tuples of three Floats, specifying the coordinates of the points used to define a coordinate system.

circleDefinition A SymbolicConstant specifying the method in which the circle is being defined. This argument is valid only when type=CIRCUMFERENTIAL or RADIAL. Possible values are ORIGIN_AXIS and POINT_ARC. When the value is ORIGIN_AXIS, the first two points in expression are points on the rotational axis and the third point lies on the x-axis. When the value is POINT_ARC, the three points in expression are points lying on the arc of the circle. numSegments An Int specifying the number of equal segments in the path. This argument is valid only when type=CIRCUMFERENTIAL or RADIAL. startAngle A Float specifying the start angle of the circumferential path. This argument is valid only when type=CIRCUMFERENTIAL. endAngle A Float specifying the end angle of the circumferential path. This argument is valid only when type=CIRCUMFERENTIAL. radius A Float or a SymbolicConstant specifying the radius of the circumferential path. This argument is valid only when type=CIRCUMFERENTIAL. The possible value of the SymbolicConstant is CIRCLE_RADIUS. radialAngle A Float specifying the angle between the radial path and the X-axis of the specified coordinate system. This argument is valid only when type=RADIAL. startRadius A Float or a SymbolicConstant specifying the start radius of the radial path. This argument is valid only when type=RADIAL. The possible value of the SymbolicConstant is CIRCLE_RADIUS. endRadius A Float or a SymbolicConstant specifying the end radius of the radial path. This argument is valid only when type=RADIAL. The possible value of the SymbolicConstant is CIRCLE_RADIUS.

34–2

NodeQuery object

Optional arguments

None.
Return value

A Path object.
Exceptions

ModelError, ErrorUnsupportedNodeData, ErrorUnsupportedPointData, ErrorIncorrectPathData, KeyError, ErrorEmptyPathName, ErrorPathNotFound, and ErrorNoOdbPathDisplay. ValueError: When type=CIRCUMFERENTIAL or RADIAL, the three points specified in expression are collinear.

34.1.2

Members

The Path object has members with the same names and descriptions as the arguments to the Path method.

34.2

CurrentProbeValues object

The CurrentProbeValues object has no constructor. The CurrentProbeValues object is created when you import the Visualization module.
Access

import visualization session.currentProbeValues

34.2.1

Members

The CurrentProbeValues object has the following member: values A Sequence containing the values obtained while probing. These values are updated constantly as the user moves the mouse over the object being probed.

34.3

NodeQuery object

The NodeQuery object specifies nodes and their coordinates in a path. The NodeQuery object has no constructor or methods. ABAQUS creates the nodeQuery member when you import the visualization module.

34–3

ProbeOptions object

Access

import visualization session.nodeQuery

34.3.1

Members

The NodeQuery object has the following members: nodeId An Int specifying the ID of the most recently queried node. If the last query was unsuccessful, nodeID=−1. nodePos A sequence of Floats specifying the X-, Y-, and Z-coordinates of the most recently queried node.

34.4

ProbeOptions object

The ProbeOptions object is used to store settings associated with probing a model or an X–Y plot. The ProbeOptions object has no constructor. ABAQUS creates the defaultProbeOptions and the probeOptions members when you import the Visualization module. When probing is initiated for the first time, the values in the probeOptions member are initialized using the values from the defaultProbeOptions member.
Access

import visualization session.defaultProbeOptions session.probeOptions

34.4.1

setValues(...)

This method modifies the settings on the ProbeOptions object.
Arguments Required arguments

None.
Optional arguments

options A ProbeOptions object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None.

34–4

ProbeOptions object

probeEntity A SymbolicConstant specifying the entity being probed when probeObject=“ODB.” Possible values are NODE and ELEMENT. The default value is ELEMENT. probeOutputPosition A SymbolicConstant specifying the output position to probe for field output results when probeObject=“ODB.” Possible values are:

• •

NODAL when probeEntity=NODE. INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, and ELEMENT_CENTROID when probeEntity=ELEMENT. The default value for this case is INTEGRATION_POINT.

partInstance A Boolean specifying whether to display the part instance information. This member is valid when probeObject=“ODB.” The default value is ON. elementID A Boolean specifying whether to display the element ID information. This member is valid when probeObject=“ODB” and probeEntity=ELEMENT. The default value is ON. elementType A Boolean specifying whether to display the element type information. This member is valid when probeObject=“ODB” and probeEntity=ELEMENT. The default value is ON. elementConnectivity A Boolean specifying whether to display the element connectivity. This member is valid when probeObject=“ODB” and probeEntity=ELEMENT. The default value is OFF. elementFieldResults A Boolean specifying whether to display the element field output results. This member is valid when probeObject=“ODB”, probeEntity=ELEMENT, and isFieldOutputAvailable=ON. The default value is OFF. nodeId A Boolean specifying whether to display the node ID when probeObject=“ODB” and probeEntity= NODE. The default value is ON. baseCoordinates A Boolean specifying whether to display the base coordinates of a node when probeObject=“ODB” and probeEntity=NODE. The default value is OFF. deformedCoordinates A Boolean specifying whether to display the deformed coordinates of a node when probeObject=“ODB” and probeEntity=NODE. The default value is OFF. attachedElements A Boolean specifying whether to display the elements attached to a node when probeObject=“ODB” and probeEntity=NODE. The default value is OFF.

34–5

ProbeOptions object

nodeFieldResults A Boolean specifying whether to display the node field output results. This member is valid when probeObject=“ODB”, probeEntity=NODE, and isFieldOutputAvailable=ON. The default value is OFF. legend A Boolean specifying whether to display the legend for a curve being probed. This member is valid when probeObject=“XYPlot.” The default value is ON. xValue A Boolean specifying whether to display the x-coordinate value of the point on the curve being probed. This member is valid when probeObject=“XYPlot.” The default value is ON. yValue A Boolean specifying whether to display the y-coordinate value of the point on the curve being probed. This member is valid when probeObject=“XYPlot.” The default value is ON. sequenceID A Boolean specifying whether to display the sequence ID of the point on the curve being probed. This member is valid when probeObject=“XYPlot.” The default value is ON. interpolateXy A Boolean specifying whether to interpolate values within a line segment when probeObject=“XYPlot.” When interpolateXy=OFF, probing returns the nearest X–Y data point on the curve. When interpolateXy=ON, probing interpolates data to return a value at the nearest point on the curve. The default value is OFF.
Return value

None
Exceptions

None.

34.4.2

Members

The ProbeOptions object has the following members: probeEntity A SymbolicConstant specifying the entity being probed when probeObject=“ODB.” Possible values are NODE and ELEMENT. The default value is ELEMENT. probeOutputPosition A SymbolicConstant specifying the output position to probe for field output results when probeObject=“ODB.” Possible values are:



NODAL when probeEntity=NODE.

34–6

ProbeOptions object



INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, and ELEMENT_CENTROID when probeEntity=ELEMENT. The default value for this case is INTEGRATION_POINT.

partInstance A Boolean specifying whether to display the part instance information. This member is valid when probeObject=“ODB.” The default value is ON. elementID A Boolean specifying whether to display the element ID information. This member is valid when probeObject=“ODB” and probeEntity=ELEMENT. The default value is ON. elementType A Boolean specifying whether to display the element type information. This member is valid when probeObject=“ODB” and probeEntity=ELEMENT. The default value is ON. elementConnectivity A Boolean specifying whether to display the element connectivity. This member is valid when probeObject=“ODB” and probeEntity=ELEMENT. The default value is OFF. elementFieldResults A Boolean specifying whether to display the element field output results. This member is valid when probeObject=“ODB”, probeEntity=ELEMENT, and isFieldOutputAvailable=ON. The default value is OFF. nodeId A Boolean specifying whether to display the node ID when probeObject=“ODB” and probeEntity=NODE. The default value is ON. baseCoordinates A Boolean specifying whether to display the base coordinates of a node when probeObject=“ODB” and probeEntity=NODE. The default value is OFF. deformedCoordinates A Boolean specifying whether to display the deformed coordinates of a node when probeObject=“ODB” and probeEntity=NODE. The default value is OFF. attachedElements A Boolean specifying whether to display the elements attached to a node when probeObject=“ODB” and probeEntity=NODE. The default value is OFF. nodeFieldResults A Boolean specifying whether to display the node field output results. This member is valid when probeObject=“ODB”, probeEntity=NODE, and isFieldOutputAvailable=ON. The default value is OFF. legend A Boolean specifying whether to display the legend for a curve being probed. This member is valid when probeObject=“XYPlot.” The default value is ON.

34–7

ProbeReport object

xValue A Boolean specifying whether to display the x-coordinate value of the point on the curve being probed. This member is valid when probeObject=“XYPlot.” The default value is ON. yValue A Boolean specifying whether to display the y-coordinate value of the point on the curve being probed. This member is valid when probeObject=“XYPlot.” The default value is ON. sequenceID A Boolean specifying whether to display the sequence ID of the point on the curve being probed. This member is valid when probeObject=“XYPlot.” The default value is ON. interpolateXy A Boolean specifying whether to interpolate values within a line segment when probeObject=“XYPlot.” When interpolateXy=OFF, probing returns the nearest X–Y data point on the curve. When interpolateXy=ON, probing interpolates data to return a value at the nearest point on the curve. The default value is OFF. probeObject A read-only String specifying the type of the displayed object being probed. Possible values are “ODB” and “XYPlot.” isFieldOutputAvailable A read-only Boolean specifying whether field output is available for probing when probeObject=“XYPlot.”

34.5

ProbeReport object

The ProbeReport object is used to store settings associated with tabular reports of probe data. The ProbeReport object has no constructor. ABAQUS creates the defaultProbeReport and the probeReport members when you import the Visualization module. When probing is initiated for the first time, the values in the probeReport member are initialized using the values from the defaultProbeReport member.

Access

import visualization session.defaultProbeReport session.probeReport

34.5.1

setValues(...)

This method modifies the ProbeReport object.

34–8

ProbeReport object

Arguments Required arguments None. Optional arguments

options A ProbeReport object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None. numColumns An Int specifying the number of columns in the report file. The default value is 80. This argument is valid only when pageWidth=SPECIFY. numDigits An Int specifying the number of significant digits to be written for decimal values. The default value is 6. numFormat A SymbolicConstant specifying the number format to be used when formatting decimal values. Possible values are AUTOMATIC, ENGINEERING, and SCIENTIFIC. The default value is ENGINEERING. pageWidth A SymbolicConstant specifying the page width format. Possible values are NO_LIMIT and SPECIFY. The default value is NO_LIMIT. printTotal A Boolean specifying whether to print the total value of either the field output result (when probeObject=”ODB”) or the x- and y-coordinates (when probeObject=“XYPlot”). The default value is OFF. printMinMax A Boolean specifying whether to print the minimum and maximum values of either the field output result (when probeObject=”ODB”) or the x- and y-coordinates (when probeObject=“XYPlot”). The default value is OFF.

Return value

None

Exceptions

None.

34–9

SelectedProbeValues object

34.5.2

Members

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

34.6

SelectedProbeValues object

The SelectedProbeValues object has no constructor. The SelectedProbeValues object is created when you import the Visualization module.
Access

import visualization session.selectedProbeValues

34.6.1

Members

The SelectedProbeValues object has the following members: values A sequence containing sequences of Floats specifying the selected probe values. length An Int specifying the length of the values member. lastValues A sequence of Floats specifying the last sequence of the values member. fieldOutputAvailable A Boolean specifying whether any probe values have been selected (as is necessary prior to writing to a file).

34–10

BasicOptions object

35.

Plot Options commands
Plot options commands are used to control the appearance of plots in the Visualization module. Plots can be undeformed, deformed, contour, symbol, or material orientation.

35.1

BasicOptions object

The BasicOptions object stores values and attributes associated with an OdbDisplay object. The BasicOptions object has no constructor command. ABAQUS creates the defaultOdbDisplay.basicOptions member when you import the Visualization module. ABAQUS creates a basicOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.basicOptions. ABAQUS creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. BasicOptions objects are accessed in one of two ways:

• •

The default basic options. These settings are used as defaults when other basicOptions members are created. These settings can be set to customize user preferences. The basic options associated with a particular viewport.

Access

import visualization session.defaultOdbDisplay.basicOptions session.viewports[name].odbDisplay.basicOptions

35.1.1

setValues(...)

This method modifies the BasicOptions object.
Arguments Required arguments

None.
Optional arguments

options A BasicOptions object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None. cameraCsysName A String specifying the name of the coordinate system driving the moving camera.

35–1

BasicOptions object

cameraMovesWithCsys A Boolean specifying whether the camera moves with the coordinate system. The initial value is FALSE. cameraFollowsRotation A Boolean specifying whether the camera, when it moves, follows the rotation of the coordinate system. The initial value is TRUE. averagingThreshold A Float specifying the nodal averaging threshold percentage. averagingThreshold 100. The initial value is 75. Possible values are 0

quantityToPlot A SymbolicConstant specifying the quantity to plot. Possible values are FIELD_OUTPUT and DISCONTINUITIES. The initial value is FIELD_OUTPUT. curveRefinementLevel A SymbolicConstant specifying the refinement level for drawing curves. Possible values are EXTRA_COARSE, COARSE, MEDIUM, FINE, and EXTRA_FINE. The initial value is COARSE. noResultsColor A String specifying the color of elements that do not have any results. The initial value is “White.” featureAngle A Float specifying the feature angle to be used when visibleEdges=FEATURE. The initial value is 30. otherSymbolSize An Int specifying the size of various glyph symbols (boundary conditions, coupling constraints, etc.) . The initial value is 6. bcDisplay A Boolean specifying whether to display boundary conditions. The initial value is OFF. connectorDisplay A Boolean specifying whether to display connectors. The initial value is OFF. highlightConnectorPts A Boolean specifying whether to highlight connector points. The initial value is ON. showConnectorAxes A Boolean specifying whether to display connector orientations or coordinate systems. The initial value is ON. showConnectorType A Boolean specifying whether to display the text that describes the connector type. The initial value is ON. pointElements A Boolean specifying whether to display point type elements. The initial value is ON.

35–2

BasicOptions object

referencePoints A Boolean specifying whether to display reference points. referencePoints is valid only when pointElements=ON. The initial value is ON. massElements A Boolean specifying whether to display mass, heat capacity and inertia elements. massElements is valid only when pointElements=ON. The initial value is OFF. springElements A Boolean specifying whether to display spring and dashpot elements. springElements is valid only when pointElements=ON. The initial value is OFF. spotWelds A Boolean specifying whether to display spot weld and distributed coupling elements. spotWelds is valid only when pointElements=ON. The initial value is OFF. tracerParticles A Boolean specifying whether to display tracer particles. tracerParticles is valid only when pointElements=ON. The initial value is OFF. sweepElements A Boolean specifying whether to sweep the elements. The initial value is ON or OFF, depending on the characteristics of your model. sweepStartAngle A Float specifying the starting angle (in degrees) from which to sweep the model when sweepElements=ON. The initial value is 0. sweepEndAngle A Float specifying the angle (in degrees) through which to sweep the model when sweepElements=ON. The initial value is 360. numSweepSegments An Int specifying the number of segments to display when sweepElements=ON. The initial value is 10 or 20, depending on characteristics of your model. 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. sweepSectors A Boolean specifying whether to sweep the cyclic symmetry sectors. The initial value is OFF.

35–3

BasicOptions object

sectorSelectionType A SymbolicConstant specifying how sectors will be selected for sweeping. Possible values are SELECT_BY_NUMBER, SELECT_BY_ANGLE, and SELECT_ALL. The initial value is SELECT_BY_NUMBER. selectedSectorNumbers A sequence of Ints specifying which sectors to display when sectorSelectionType=SELECT_BY_NUMBER. Possible values are 1 selectedSectorNumbers the number of sectors. The initial value is 1. sweepSectorStartAngle A Float specifying the angle (in degrees) from which to sweep cyclic symmetry sectors when sweepSectors=ON. Possible values are multiples of the sector angle such that 0 sweepSectorStartAngle 360. The initial value is 0. sweepSectorEndAngle A Float specifying the angle (in degrees) through which to sweep cyclic symmetry sectors when sweepSectors=ON. Possible values are multiples of the sector angle such that 0 sweepSectorEndAngle 360. The initial value is 360. extrudeElements A Boolean specifying whether to extrude elements. The initial value is ON for models containing three-dimensional analytical rigid surfaces; the initial value is OFF in all other cases. extrudeDepth A Float specifying the depth (in model units) by which the model is to be extruded when extrudeElements=ON. The initial value is 1.0. couplingDisplay A Boolean specifying whether to display coupling constraints. The default value is ON. coordSystemDisplay A Boolean specifying whether to display coordinate systems. The default value is OFF. scratchCoordSystemDisplay A Boolean specifying whether to display coordinate systems that represent user-defined orientations. The default value is OFF. transformationType A SymbolicConstant specifying the transformation to apply to the PrimaryVariable. Possible values are DEFAULT, NODAL, and USER_SPECIFIED. The default value is DEFAULT. If transformationType=NODAL, ABAQUS will transform nodal vector fields into any orientation defined in the analysis with the *TRANSFORM option. Setting transformationType=NODAL has no effect on element-based results. If transformationType=USER_SPECIFIED, ABAQUS will transform tensor and vector fields into the coordinate system specified by datumCsys. datumCsys A DatumCsys object specifying the coordinate system to use for results transformation when transformationType=USER_SPECIFIED.

35–4

BasicOptions object

averageElementOutput A Boolean specifying whether to average the element output. The default value is ON. averageOnlyDisplayed A Boolean specifying whether to average only values on displayed elements. The default value is ON. computeOutput A SymbolicConstant defining the order or the computations to be performed. Possible values are EXTRAPOLATE_AVERAGE_COMPUTE, EXTRAPOLATE_COMPUTE_AVERAGE, EXTRAPOLATE_COMPUTE, EXTRAPOLATE_COMPUTE_DISCONTINUITIES, and RAW_DATA. The default value is EXTRAPOLATE_AVERAGE_COMPUTE. regionBoundaries A SymbolicConstant specifying the type of averaging region boundaries. Possible values are NONE, ODB_REGIONS, ELEMENT_SET, and DISPLAY_GROUPS. The default value is ODB_REGIONS. useRegionBoundaries A Boolean specifying whether to use region boundaries when averaging. The default value is ON, meaning that region boundaries will be used. userRegions Depending on the value of regionBoundaries, this argument specifies a list of either element set or display group names defining the averaging region boundaries.
Return value

None
Exceptions

If featureAngle is not in the valid range: RangeError: featureAngle must be a float in the range 0-90, inclusive

35.1.2

Members

The BasicOptions object can have the following members: regionAveraging A Boolean specifying whether to ignore region boundaries when computing values. The initial value is ON. cameraCsysName A String specifying the name of the coordinate system driving the moving camera. cameraMovesWithCsys A Boolean specifying whether the camera moves with the coordinate system. The initial value is FALSE.

35–5

BasicOptions object

cameraFollowsRotation A Boolean specifying whether the camera, when it moves, follows the rotation of the coordinate system. The initial value is TRUE. averagingThreshold A Float specifying the nodal averaging threshold percentage. averagingThreshold 100. The initial value is 75. Possible values are 0

quantityToPlot A SymbolicConstant specifying the quantity to plot. Possible values are FIELD_OUTPUT and DISCONTINUITIES. The initial value is FIELD_OUTPUT. extrapAlgorithm A SymbolicConstant for internal use only. The value is EXTRAP_COMPUTE_AVERAGE. curveRefinementLevel A SymbolicConstant specifying the refinement level for drawing curves. Possible values are EXTRA_COARSE, COARSE, MEDIUM, FINE, and EXTRA_FINE. The initial value is COARSE. noResultsColor A String specifying the color of elements that do not have any results. The initial value is “White.” featureAngle A Float specifying the feature angle to be used when visibleEdges=FEATURE. The initial value is 30. otherSymbolSize An Int specifying the size of various glyph symbols (boundary conditions, coupling constraints, etc.) . The initial value is 6. bcDisplay A Boolean specifying whether to display boundary conditions. The initial value is OFF. connectorDisplay A Boolean specifying whether to display connectors. The initial value is OFF. highlightConnectorPts A Boolean specifying whether to highlight connector points. The initial value is ON. showConnectorAxes A Boolean specifying whether to display connector orientations or coordinate systems. The initial value is ON. showConnectorType A Boolean specifying whether to display the text that describes the connector type. The initial value is ON. pointElements A Boolean specifying whether to display point type elements. The initial value is ON.

35–6

BasicOptions object

referencePoints A Boolean specifying whether to display reference points. referencePoints is valid only when pointElements=ON. The initial value is ON. massElements A Boolean specifying whether to display mass, heat capacity and inertia elements. massElements is valid only when pointElements=ON. The initial value is OFF. springElements A Boolean specifying whether to display spring and dashpot elements. springElements is valid only when pointElements=ON. The initial value is OFF. spotWelds A Boolean specifying whether to display spot weld and distributed coupling elements. spotWelds is valid only when pointElements=ON. The initial value is OFF. tracerParticles A Boolean specifying whether to display tracer particles. tracerParticles is valid only when pointElements=ON. The initial value is OFF. sweepElements A Boolean specifying whether to sweep the elements. The initial value is ON or OFF, depending on the characteristics of your model. sweepStartAngle A Float specifying the starting angle (in degrees) from which to sweep the model when sweepElements=ON. The initial value is 0. sweepEndAngle A Float specifying the angle (in degrees) through which to sweep the model when sweepElements=ON. The initial value is 360. numSweepSegments An Int specifying the number of segments to display when sweepElements=ON. The initial value is 10 or 20, depending on characteristics of your model. 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. sweepSectors A Boolean specifying whether to sweep the cyclic symmetry sectors. The initial value is OFF.

35–7

BasicOptions object

sectorSelectionType A SymbolicConstant specifying how sectors will be selected for sweeping. Possible values are SELECT_BY_NUMBER, SELECT_BY_ANGLE, and SELECT_ALL. The initial value is SELECT_BY_NUMBER. selectedSectorNumbers A sequence of Ints specifying which sectors to sectorSelectionType=SELECT_BY_NUMBER. Possible values selectedSectorNumbers the number of sectors. The initial value is 1. display when are 1

sweepSectorStartAngle A Float specifying the angle (in degrees) from which to sweep cyclic symmetry sectors when sweepSectors=ON. Possible values are multiples of the sector angle such that 0 sweepSectorStartAngle 360. The initial value is 0. sweepSectorEndAngle A Float specifying the angle (in degrees) through which to sweep cyclic symmetry sectors when sweepSectors=ON. Possible values are multiples of the sector angle such that 0 sweepSectorEndAngle 360. The initial value is 360. extrudeElements A Boolean specifying whether to extrude elements. The initial value is ON for models containing three-dimensional analytical rigid surfaces; the initial value is OFF in all other cases. extrudeDepth A Float specifying the depth (in model units) by which the model is to be extruded when extrudeElements=ON. The initial value is 1.0. couplingDisplay A Boolean specifying whether to display coupling constraints. The default value is ON. coordSystemDisplay A Boolean specifying whether to display coordinate systems. The default value is OFF. scratchCoordSystemDisplay A Boolean specifying whether to display coordinate systems that represent user-defined orientations. The default value is OFF. transformationType A SymbolicConstant specifying the transformation to apply to the PrimaryVariable. Possible values are DEFAULT, NODAL, and USER_SPECIFIED. The default value is DEFAULT. If transformationType=NODAL, ABAQUS will transform nodal vector fields into any orientation defined in the analysis with the *TRANSFORM option. Setting transformationType=NODAL has no effect on element-based results. If transformationType=USER_SPECIFIED, ABAQUS will transform tensor and vector fields into the coordinate system specified by datumCsys. modelCanExtrude A Boolean specifying whether the model contains any elements or surfaces that can be extruded.

35–8

ContourOptions object

sweepModelType An Int specifying the types of sweepable elements and surfaces contained in the model, if any. The value of sweepModelType is formed as the sum of the following:

• • • • •

0 – for no sweepable elements or surfaces. 1 – for axisymmetric elements or surfaces. 2 – for analytical rigid surfaces. 4 – for sectors. 8 – for asymmetric axisymmetric elements.

datumCsys A DatumCsys object specifying the coordinate system to use for results transformation when transformationType=USER_SPECIFIED.

35.2

ContourOptions object

The ContourOptions object stores values and attributes associated with a contour plot. The ContourOptions object has no constructor command. ABAQUS creates a defaultOdbDisplay.contourOptions member when you import the Visualization module. ABAQUS creates a contourOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.contourOptions. ABAQUS creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. ContourOptions objects are accessed in one of two ways:

• •

The default contour options. These settings are used as defaults when other contourOptions members are created. These settings can be set to customize user preferences. The contour options associated with a particular viewport.

Access

import visualization session.defaultOdbDisplay.contourOptions session.viewports[name].odbDisplay.contourOptions

35.2.1

setValues(...)

This method modifies the ContourOptions object.
Arguments Required arguments

None.

35–9

ContourOptions object

Optional arguments

options A ContourOptions object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None. contourType A SymbolicConstant specifying the contour type. Possible values are LINE, BANDED, and QUILT. The initial value is BANDED. contourMethod A SymbolicConstant specifying the contour rendering method. Possible values are TEXTURE_MAPPED and TESSELLATED. The initial value is TEXTURE_MAPPED. tickmarkPlots A Boolean specifying whether tick mark plots should be displayed on line-type elements. If tickmarkPlots=ON, ABAQUS displays a tick mark plot. If tickmarkPlots=OFF, ABAQUS displays contours on the element faces. The initial value is OFF. renderStyle A SymbolicConstant specifying the render style of the contour plot. Possible values are FILLED and SHADED. The initial value is FILLED. visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. contourStyle A SymbolicConstant specifying the interval style of the contour plot. Possible values are CONTINUOUS and UNIFORM. The default value is UNIFORM. numIntervals An Int specifying the number of intervals when contourStyle=UNIFORM. Possible values are 2 numIntervals 24. The initial value is 12. maxAutoCompute A Boolean specifying whether the contour range maximum value should be computed from the output data to be contoured. The initial value is ON. maxValue A Float specifying the contour range maximum value to be used in the plot when maxAutoCompute=ON. The initial value is autoMaxValue. minAutoCompute A Boolean specifying whether the contour range minimum value should be computed from the output data to be contoured. The initial value is ON. minValue A Float specifying the contour range minimum value to be used in the plot when maxAutoCompute=ON. The initial value is minAutoValue.

35–10

ContourOptions object

animationAutoLimits A SymbolicConstant specifying the method to be used when contour limits are automatically computed for animation. animationAutoLimits will only effect the minimum limit and/or maximum limit when minAutoCompute and/or maxAutoCompute=TRUE. Possible values are FIRST_AND_LAST, CURRENT_FRAME, and RECOMPUTE_EACH_FRAME. The initial value is FIRST_AND_LAST. edgeColorLine A String specifying the edge color to be used when contourType=LINE. The initial value is “White.” edgeColorBandedQuilt A String specifying the edge color to be used when contourType=BANDED or QUILT. The initial value is “Black.” edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. spectrumType A SymbolicConstant specifying the color spectrum to be used in the contour plot. Possible values are RAINBOW, REVERSED_RAINBOW, WHITE_TO_BLACK, BLACK_TO_WHITE, BLUE_TO_RED, RED_TO_BLUE, and WRAP_AROUND. The initial value is RAINBOW. outsideLimitsMode A SymbolicConstant specifying the color of contour values that exceed the limits of the plot. Possible values are SPECTRUM and SPECIFY. When outsideLimitsMode=SPECTRUM, the maximum and minimum contour spectrum colors are used for values that exceed the limits of the plot. When outsideLimitsMode=SPECIFY, the values of outsideLimitsAboveColor and outsideLimitsBelowColor are used for values that exceed the limits of the plot. outsideLimitsAboveColor A String specifying the color to be used for values that exceed the limits of the plot when outsideLimitsMode=SPECIFY. The initial value is “Grey80.” outsideLimitsBelowColor A String specifying the color to be used for values that exceed the limits of the plot when outsideLimitsMode=SPECIFY. The initial value is “Grey20.” intervalLineAttributes A sequence of sequences specifying the line style and line thickness for each interval in the plot when contourType=LINE. The size of the outer sequence must be equal to numIntervals-1. The inner sequence consists of two SymbolicConstants specifying the line style and line thickness. For possible values, refer to edgeLineStyle and edgeLineThickness. The initial value of each inner sequence is (SOLID, VERY_THIN).

35–11

ContourOptions object

contourEdges A Boolean specifying whether to plot the edges of each contour interval when contourType=BANDED. The initial value is OFF. contourEdgeColor A String specifying the color to be used to plot the contour edges when contourType=BANDED. The initial value is “Grey60.” contourEdgeStyle A SymbolicConstant specifying the edge line style to be used to plot the contour edges when contourType=BANDED. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. contourEdgeThickness A SymbolicConstant specifying the edge line thickness to be used to plot the edge of the contour intervals when contourType=BANDED. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. modelShape A SymbolicConstant specifying the shape to be used when drawing the contour plot on the model. Possible values are UNDEFORMED and DEFORMED. The initial value is DEFORMED. deformationScaling A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The initial value is AUTO. uniformScaleFactor A Float specifying the uniform deformation scaling constant deformationScaling=UNIFORM. The initial value is autoDeformationScaleValue. when

nonuniformScaleFactor A Sequence of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The initial value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue). labelFont A String specifying the label font to be used for all model labels. The initial value is “-*-couriermedium-r-normal-*-*-120–*-*-m-*-*-*”. elemLabels A Boolean specifying whether to plot the element labels. The initial value is OFF. elemLabelColor A String specifying the color to be used to plot the element labels. The initial value is “Cyan.” faceLabels A Boolean specifying whether to plot the face labels. The initial value is OFF. faceLabelColor A String specifying the color to be used to plot the face labels. The initial value is “Red.”

35–12

ContourOptions object

nodeLabels A Boolean specifying whether to plot the node labels. The initial value is OFF. nodeLabelColor A String specifying the color to be used to plot the node labels. The initial value is “Yellow.” nodeSymbols A Boolean specifying whether to plot the node symbols. The initial value is OFF. nodeSymbolType A SymbolicConstant specifying the node symbol types. Possible values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, and XMARKER. The initial value is HOLLOW_CIRCLE. nodeSymbolColor A String specifying the color to be used to plot the node symbols. The initial value is “Yellow.” nodeSymbolSize A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The initial value is SMALL. elementShrink A Boolean specifying whether elements are displayed in a shrunk format. The initial value is OFF. elementShrinkFactor An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0 elementShrinkPercentage 90. The initial value is 5. coordinateScale A Boolean specifying whether to scale coordinates. The initial value is OFF. coordinateScaleFactors A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The initial value is (1.0, 1.0, 1.0). translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency=ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3. tickmarkAxisLength A SymbolicConstant specifying the length of the tick mark plot axes. Possible values are SHORT, MEDIUM, and LONG. The initial value is MEDIUM. tickmarkBaseValue A Float specifying the base contour value defining the tick mark axis contour value that intersects the elements. Possible values are autoMinValue tickmarkBaseValue autoMaxValue. The initial value is 0.

35–13

ContourOptions object

tickmarkOrientation A SymbolicConstant specifying the orientation of the tick mark plots. Possible values are N1 and N2. The initial value is N2. tickmarkCurveColor A String specifying the color to be used to plot the tick mark curve. The initial value is “Cyan.”
Return value

None
Exceptions

RangeError.

35.2.2

Members

The ContourOptions object has the following members: contourType A SymbolicConstant specifying the contour type. Possible values are LINE, BANDED, and QUILT. The initial value is BANDED. contourMethod A SymbolicConstant specifying the contour rendering method. Possible values are TEXTURE_MAPPED and TESSELLATED. The initial value is TEXTURE_MAPPED. tickmarkPlots A Boolean specifying whether tick mark plots should be displayed on line-type elements. If tickmarkPlots=ON, ABAQUS displays a tick mark plot. If tickmarkPlots=OFF, ABAQUS displays contours on the element faces. The initial value is OFF. renderStyle A SymbolicConstant specifying the render style of the contour plot. Possible values are FILLED and SHADED. The initial value is FILLED. visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. contourStyle A SymbolicConstant specifying the interval style of the contour plot. CONTINUOUS and UNIFORM. The default value is UNIFORM. Possible values are

numIntervals An Int specifying the number of intervals when contourStyle=UNIFORM. Possible values are 2 numIntervals 24. The initial value is 12.

35–14

ContourOptions object

maxAutoCompute A Boolean specifying whether the contour range maximum value should be computed from the output data to be contoured. The initial value is ON. maxValue A Float specifying the contour range maximum value to be used in the plot when maxAutoCompute=ON. The initial value is autoMaxValue. minAutoCompute A Boolean specifying whether the contour range minimum value should be computed from the output data to be contoured. The initial value is ON. minValue A Float specifying the contour range minimum value to be used in the plot when maxAutoCompute=ON. The initial value is minAutoValue. animationAutoLimits A SymbolicConstant specifying the method to be used when contour limits are automatically computed for animation. animationAutoLimits will only effect the minimum limit and/or maximum limit when minAutoCompute and/or maxAutoCompute=TRUE. Possible values are FIRST_AND_LAST, CURRENT_FRAME, and RECOMPUTE_EACH_FRAME. The initial value is FIRST_AND_LAST. edgeColorLine A String specifying the edge color to be used when contourType=LINE. The initial value is “White.” edgeColorBandedQuilt A String specifying the edge color to be used when contourType=BANDED or QUILT. The initial value is “Black.” edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. spectrumType A SymbolicConstant specifying the color spectrum to be used in the contour plot. Possible values are RAINBOW, REVERSED_RAINBOW, WHITE_TO_BLACK, BLACK_TO_WHITE, BLUE_TO_RED, RED_TO_BLUE, and WRAP_AROUND. The initial value is RAINBOW. outsideLimitsMode A SymbolicConstant specifying the color of contour values that exceed the limits of the plot. Possible values are SPECTRUM and SPECIFY. When outsideLimitsMode=SPECTRUM, the maximum and minimum contour spectrum colors are used for values that exceed the limits of the plot. When outsideLimitsMode=SPECIFY, the values of outsideLimitsAboveColor and outsideLimitsBelowColor are used for values that exceed the limits of the plot.

35–15

ContourOptions object

outsideLimitsAboveColor A String specifying the color to be used for values that exceed the limits of the plot when outsideLimitsMode=SPECIFY. The initial value is “Grey80.” outsideLimitsBelowColor A String specifying the color to be used for values that exceed the limits of the plot when outsideLimitsMode=SPECIFY. The initial value is “Grey20.” intervalLineAttributes A sequence of sequences specifying the line style and line thickness for each interval in the plot when contourType=LINE. The size of the outer sequence must be equal to numIntervals-1. The inner sequence consists of two SymbolicConstants specifying the line style and line thickness. For possible values, refer to edgeLineStyle and edgeLineThickness. The initial value of each inner sequence is (SOLID, VERY_THIN). contourEdges A Boolean specifying whether to plot the edges of each contour interval when contourType=BANDED. The initial value is OFF. contourEdgeColor A String specifying the color to be used to plot the contour edges when contourType=BANDED. The initial value is “Grey60.” contourEdgeStyle A SymbolicConstant specifying the edge line style to be used to plot the contour edges when contourType=BANDED. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. contourEdgeThickness A SymbolicConstant specifying the edge line thickness to be used to plot the edge of the contour intervals when contourType=BANDED. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. modelShape A SymbolicConstant specifying the shape to be used when drawing the contour plot on the model. Possible values are UNDEFORMED and DEFORMED. The initial value is DEFORMED. deformationScaling A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The initial value is AUTO. uniformScaleFactor A Float specifying the uniform deformation scaling constant deformationScaling=UNIFORM. The initial value is autoDeformationScaleValue. when

nonuniformScaleFactor A Sequence of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The initial value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue).

35–16

ContourOptions object

labelFont A String specifying the label font to be used for all model labels. The initial value is “-*-couriermedium-r-normal-*-*-120–*-*-m-*-*-*”. elemLabels A Boolean specifying whether to plot the element labels. The initial value is OFF. elemLabelColor A String specifying the color to be used to plot the element labels. The initial value is “Cyan.” faceLabels A Boolean specifying whether to plot the face labels. The initial value is OFF. faceLabelColor A String specifying the color to be used to plot the face labels. The initial value is “Red.” nodeLabels A Boolean specifying whether to plot the node labels. The initial value is OFF. nodeLabelColor A String specifying the color to be used to plot the node labels. The initial value is “Yellow.” nodeSymbols A Boolean specifying whether to plot the node symbols. The initial value is OFF. nodeSymbolType A SymbolicConstant specifying the node symbol types. Possible values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, and XMARKER. The initial value is HOLLOW_CIRCLE. nodeSymbolColor A String specifying the color to be used to plot the node symbols. The initial value is “Yellow.” nodeSymbolSize A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The initial value is SMALL. averagedOrientationDisplay A Boolean specifying the display of the nodal averaged coordinate systems used when averaging element vector or tensor data. The default value is OFF. elementShrink A Boolean specifying whether elements are displayed in a shrunk format. The initial value is OFF. elementShrinkFactor An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0 elementShrinkPercentage 90. The initial value is 5. coordinateScale A Boolean specifying whether to scale coordinates. The initial value is OFF.

35–17

DeformedShapeOptions object

coordinateScaleFactors A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The initial value is (1.0, 1.0, 1.0). translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency=ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3. tickmarkAxisLength A SymbolicConstant specifying the length of the tick mark plot axes. Possible values are SHORT, MEDIUM, and LONG. The initial value is MEDIUM. tickmarkBaseValue A Float specifying the base contour value defining the tick mark axis contour value that intersects the elements. Possible values are autoMinValue tickmarkBaseValue autoMaxValue. The initial value is 0. tickmarkOrientation A SymbolicConstant specifying the orientation of the tick mark plots. Possible values are N1 and N2. The initial value is N2. tickmarkCurveColor A String specifying the color to be used to plot the tick mark curve. The initial value is “Cyan.” extrapolatedAveraging A Boolean specifying whether to auto-compute contour limits using extrapolated values alone or extrapolated values that are averaged. The initial value is OFF, which specifies the use of extrapolated values alone. autoDeformationScaleValue A Float specifying the deformed scale factor value when deformationScaling=AUTO. autoMaxValue A Float specifying the maximum value to be used in the plot. The value is computed from the output data to be contoured. autoMinValue A Float specifying the minimum value to be used in the plot. The value is computed from the output data to be contoured.

35.3

DeformedShapeOptions object

The DeformedShapeOptions object stores values and attributes associated with a deformed shape plot. The DeformedShapeOptions object has no constructor command. ABAQUS creates a defaultOdbDisplay.deformedShapeOptions member when you import the Visualization module.

35–18

DeformedShapeOptions object

ABAQUS creates a deformedOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.deformedShapeOptions. ABAQUS creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. DeformedShapeOptions objects are accessed in one of two ways:

• •

The default deformed options. These settings are used as defaults when other deformedOptions members are created. These settings can be set to customize user preferences. The deformed options associated with a particular viewport.

Access

import visualization session.defaultOdbDisplay.deformedShapeOptions session.viewports[name].odbDisplay.deformedShapeOptions

35.3.1

setValues(...)

This method modifies the DeformedShapeOptions object.
Arguments Required arguments

None.
Optional arguments

options A DeformedShapeOptions object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None. renderStyle A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The initial value is WIREFRAME. visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. deformationScaling A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The initial value is AUTO. uniformScaleFactor A Float specifying the uniform deformation scaling constant deformationScaling=UNIFORM. The initial value is autoDeformationScaleValue. when

35–19

DeformedShapeOptions object

nonuniformScaleFactor A Sequence of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The initial value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue). undeformedShape A Boolean specifying whether to plot the undeformed shape in addition to the deformed shape. The initial value is OFF. edgeColorWireHide A String specifying the color to be used to plot the edges of the deformed plot when renderStyle=WIREFRAME or HIDDEN. The initial value is “White.” edgeColorFillShade A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=FILLED or SHADED. The initial value is “Black.” edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. colorCodeOverride A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The initial value is ON. fillColor A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The initial value is “White.” labelFont A String specifying the label font to be used for all model labels. The initial value is “-*-couriermedium-r-normal-*-*-120–*-*-m-*-*-*”. elemLabels A Boolean specifying whether to plot the element labels. The initial value is OFF. elemLabelColor A String specifying the color to be used to plot the element labels. The initial value is “Cyan.” faceLabels A Boolean specifying whether to plot the face labels. The initial value is OFF. faceLabelColor A String specifying the color to be used to plot the face labels. The initial value is “Red.” nodeLabels A Boolean specifying whether to plot the node labels. The initial value is OFF.

35–20

DeformedShapeOptions object

nodeLabelColor A String specifying the color to be used to plot the node labels. The initial value is “Yellow.” nodeSymbols A Boolean specifying whether to plot the node symbols. The initial value is OFF. nodeSymbolType A SymbolicConstant specifying the node symbol types. Possible values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, and XMARKER. The initial value is HOLLOW_CIRCLE. nodeSymbolColor A String specifying the color to be used to plot the node symbols. The initial value is “Yellow.” nodeSymbolSize A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The initial value is SMALL. elementShrink A Boolean specifying whether elements are displayed in a shrunk format. The initial value is OFF. elementShrinkFactor An Int specifying the percentage to shrink the elements when elementShrink = ON. Possible values are 0 elementShrinkPercentage 90. The initial value is 5. coordinateScale A Boolean specifying whether to scale coordinates. The initial value is OFF. coordinateScaleFactors A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The initial value is (1.0, 1.0, 1.0). normals A Boolean specifying whether to draw arrows that indicate the directions of element and surface normals. The initial value is OFF. faceNormalColor A String specifying the color to be used to plot the normal to a nonbeam element or to a surface. The initial value is “Red.” beamN1Color A String specifying the color to be used to plot an arrow along the beam -direction. The initial value is “Blue.” beamN2Color A String specifying the color to be used to plot an arrow along the beam -direction. The initial value is “Red.” beamTangentColor A String specifying the color to be used to plot an arrow along the tangent to a beam. The initial value is “White.”

35–21

DeformedShapeOptions object

normalArrowLength A SymbolicConstant specifying the length of the normal arrows. Possible values are SHORT, MEDIUM, and LONG. The initial value is MEDIUM. normalLineThickness A SymbolicConstant specifying the thickness of the normal arrows. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. normalArrowheadStyle A SymbolicConstant specifying the arrowhead style of the normal arrows. Possible values are NONE, FILLED, and WIRE. The initial value is WIRE. deformedOffsetMode A SymbolicConstant specifying the offset of the deformed shape from the undeformed shape. Possible values are NONE, UNIFORM, and NONUNIFORM. NONE specifies that there should be no offset of the deformed shape from the undeformed shape. The initial value is NONE. uniformOffset A Float specifying the uniform offset value when deformedOffsetMode=UNIFORM. The initial value is 0.0. nonuniformOffset A Sequence of three Floats specifying the offset value in each of the three coordinate directions when deformedOffsetMode=NONUNIFORM. The initial value is (0.0, 0.0, 0.0). translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency=ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3.
Return value

None
Exceptions

RangeError.

35.3.2

Members

The DeformedShapeOptions object has the following members: renderStyle A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The initial value is WIREFRAME.

35–22

DeformedShapeOptions object

visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. deformationScaling A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The initial value is AUTO. uniformScaleFactor A Float specifying the uniform deformation scaling constant deformationScaling=UNIFORM. The initial value is autoDeformationScaleValue. when

nonuniformScaleFactor A Sequence of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The initial value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue). undeformedShape A Boolean specifying whether to plot the undeformed shape in addition to the deformed shape. The initial value is OFF. edgeColorWireHide A String specifying the color to be used to plot the edges of the deformed plot when renderStyle=WIREFRAME or HIDDEN. The initial value is “White.” edgeColorFillShade A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=FILLED or SHADED. The initial value is “Black.” edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. colorCodeOverride A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The initial value is ON. fillColor A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The initial value is “White.” labelFont A String specifying the label font to be used for all model labels. The initial value is “-*-couriermedium-r-normal-*-*-120–*-*-m-*-*-*”.

35–23

DeformedShapeOptions object

elemLabels A Boolean specifying whether to plot the element labels. The initial value is OFF. elemLabelColor A String specifying the color to be used to plot the element labels. The initial value is “Cyan.” faceLabels A Boolean specifying whether to plot the face labels. The initial value is OFF. faceLabelColor A String specifying the color to be used to plot the face labels. The initial value is “Red.” nodeLabels A Boolean specifying whether to plot the node labels. The initial value is OFF. nodeLabelColor A String specifying the color to be used to plot the node labels. The initial value is “Yellow.” nodeSymbols A Boolean specifying whether to plot the node symbols. The initial value is OFF. nodeSymbolType A SymbolicConstant specifying the node symbol types. Possible values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, and XMARKER. The initial value is HOLLOW_CIRCLE. nodeSymbolColor A String specifying the color to be used to plot the node symbols. The initial value is “Yellow.” nodeSymbolSize A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The initial value is SMALL. elementShrink A Boolean specifying whether elements are displayed in a shrunk format. The initial value is OFF. elementShrinkFactor An Int specifying the percentage to shrink the elements when elementShrink = ON. Possible values are 0 elementShrinkPercentage 90. The initial value is 5. coordinateScale A Boolean specifying whether to scale coordinates. The initial value is OFF. coordinateScaleFactors A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The initial value is (1.0, 1.0, 1.0). normals A Boolean specifying whether to draw arrows that indicate the directions of element and surface normals. The initial value is OFF.

35–24

DeformedShapeOptions object

faceNormalColor A String specifying the color to be used to plot the normal to a nonbeam element or to a surface. The initial value is “Red.” beamN1Color A String specifying the color to be used to plot an arrow along the beam value is “Blue.” beamN2Color A String specifying the color to be used to plot an arrow along the beam value is “Red.” -direction. The initial

-direction. The initial

beamTangentColor A String specifying the color to be used to plot an arrow along the tangent to a beam. The initial value is “White.” normalArrowLength A SymbolicConstant specifying the length of the normal arrows. Possible values are SHORT, MEDIUM, and LONG. The initial value is MEDIUM. normalLineThickness A SymbolicConstant specifying the thickness of the normal arrows. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. normalArrowheadStyle A SymbolicConstant specifying the arrowhead style of the normal arrows. Possible values are NONE, FILLED, and WIRE. The initial value is WIRE. deformedOffsetMode A SymbolicConstant specifying the offset of the deformed shape from the undeformed shape. Possible values are NONE, UNIFORM, and NONUNIFORM. NONE specifies that there should be no offset of the deformed shape from the undeformed shape. The initial value is NONE. uniformOffset A Float specifying the uniform offset value when deformedOffsetMode=UNIFORM. The initial value is 0.0. nonuniformOffset A Sequence of three Floats specifying the offset value in each of the three coordinate directions when deformedOffsetMode=NONUNIFORM. The initial value is (0.0, 0.0, 0.0). translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency=ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3. autoDeformationScaleValue A Float containing the deformation scale factor value when deformationScaling=AUTO.

35–25

OptionArg object

35.4

OptionArg object

The OptionArg object is used to store values and attributes as a temporary object to be associated with a viewCutOptions object. The OptionArg object has only a constructor command.
Access

import visualization

35.4.1

OptionArg(...)

This method creates an OptionArg object.
Path

OptionArg
Required arguments

None.
Optional arguments

renderStyle A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The initial value is WIREFRAME. visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. edgeColorWireHide A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=WIREFRAME or HIDDEN. The initial value is “Green.” edgeColorFillShade A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=FILLED or SHADED. The initial value is “Black.” edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN.

35–26

OrientationOptions object

colorCodeOverride A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The initial value is ON. fillColor A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The initial value is “Green.” translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency = ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3.
Return value

None An OptionArg object
Exceptions

RangeError.

35.4.2

Members

The OptionArg object has members with the same names and descriptions as the arguments to the OptionArg method.

35.5

OrientationOptions object

The OrientationOptions object stores values and attributes associated with a material orientation plot. The OrientationOptions object has no constructor command. ABAQUS creates a defaultOdbDisplay.materialOrientationOptions member when you import the Visualization module. ABAQUS creates a materialOrientationOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.materialOrientationOptions. ABAQUS creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. OrientationOptions objects are accessed in one of two ways:

• •

The default material orientation options. These settings are used as defaults when other materialOrientationOptions members are created. These settings can be set to customize user preferences. The material orientation options associated with a particular viewport.

35–27

OrientationOptions object

Access

import visualization session.defaultOdbDisplay.materialOrientationOptions session.viewports[name].odbDisplay.materialOrientationOptions

35.5.1

setValues(...)

This method modifies the OrientationOptions object.
Arguments Required arguments

None.
Optional arguments

options An OrientationOptions object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None. Axis1Color A String specifying the color of axis 1 of the material orientation triad. The initial value is “Cyan.” showAxis1 A Boolean specifying whether axis 1 of the material orientation triad should be displayed. The initial value is ON. Axis2Color A String specifying the color of axis 2 of the material orientation triad. The initial value is “Yellow.” showAxis2 A Boolean specifying whether axis 2 of the material orientation triad should be displayed. The initial value is ON. Axis3Color A String specifying the color of axis 3 of the material orientation triad. The initial value is “Red.” showAxis3 A Boolean specifying whether axis 3 of the material orientation triad should be displayed. The initial value is ON. displayLength A SymbolicConstant specifying the length of the material orientation triad. Possible values are SHORT, MEDIUM, and LONG. The initial value is MEDIUM. lineThickness A SymbolicConstant specifying the thickness of the material orientation triad. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN.

35–28

OrientationOptions object

arrowheadStyle A SymbolicConstant specifying the arrowhead style for the material orientation triad. Possible values are NONE, FILLED, and WIRE. The initial value is NONE. renderStyle A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME and SHADED. The initial value is WIREFRAME. visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. modelShape A SymbolicConstant specifying the shape to be used when drawing the contour plot on the model. Possible values are UNDEFORMED and DEFORMED. The initial value is DEFORMED. deformationScaling A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The initial value is AUTO. uniformScaleFactor A Float specifying the uniform deformation scaling constant deformationScaling=UNIFORM. The initial value is autoDeformationScaleValue. when

nonuniformScaleFactor A Sequence of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The initial value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue). edgeColorWireHide A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=WIREFRAME or HIDDEN. The initial value is “Green.” edgeColorFillShade A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=FILLED or SHADED. The initial value is “Black.” edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. colorCodeOverride A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The initial value is ON.

35–29

OrientationOptions object

fillColor A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The initial value is “Green.” labelFont A String specifying the label font to be used for all model labels. The initial value is “-*-couriermedium-r-normal-*-*-120–*-*-m-*-*-*”. elemLabels A Boolean specifying whether to plot the element labels. The initial value is OFF. elemLabelColor A String specifying the color to be used to plot the element labels. The initial value is “Cyan.” faceLabels A Boolean specifying whether to plot the face labels. The initial value is OFF. faceLabelColor A String specifying the color to be used to plot the face labels. The initial value is “Red.” nodeLabels A Boolean specifying whether to plot the node labels. The initial value is OFF. nodeLabelColor A String specifying the color to be used to plot the node labels. The initial value is “Yellow.” nodeSymbols A Boolean specifying whether to plot the node symbols. The initial value is OFF. nodeSymbolType A SymbolicConstant specifying the node symbol types. Possible values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, and XMARKER. The initial value is HOLLOW_CIRCLE. nodeSymbolColor A String specifying the color to be used to plot the node symbols. The initial value is “Yellow.” nodeSymbolSize A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The initial value is SMALL. elementShrink A Boolean specifying whether elements are displayed in a shrunk format. The initial value is OFF. elementShrinkFactor An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0 elementShrinkPercentage 90. The initial value is 5. coordinateScale A Boolean specifying whether to scale coordinates. The initial value is OFF.

35–30

OrientationOptions object

coordinateScaleFactors A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The initial value is (1.0, 1.0, 1.0). translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency=ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3.
Return value

None
Exceptions

RangeError.

35.5.2

Members

The OrientationOptions object has the following members: Axis1Color A String specifying the color of axis 1 of the material orientation triad. The initial value is “Cyan.” showAxis1 A Boolean specifying whether axis 1 of the material orientation triad should be displayed. The initial value is ON. Axis2Color A String specifying the color of axis 2 of the material orientation triad. The initial value is “Yellow.” showAxis2 A Boolean specifying whether axis 2 of the material orientation triad should be displayed. The initial value is ON. Axis3Color A String specifying the color of axis 3 of the material orientation triad. The initial value is “Red.” showAxis3 A Boolean specifying whether axis 3 of the material orientation triad should be displayed. The initial value is ON. displayLength A SymbolicConstant specifying the length of the material orientation triad. Possible values are SHORT, MEDIUM, and LONG. The initial value is MEDIUM.

35–31

OrientationOptions object

lineThickness A SymbolicConstant specifying the thickness of the material orientation triad. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. arrowheadStyle A SymbolicConstant specifying the arrowhead style for the material orientation triad. Possible values are NONE, FILLED, and WIRE. The initial value is NONE. renderStyle A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME and SHADED. The initial value is WIREFRAME. visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. modelShape A SymbolicConstant specifying the shape to be used when drawing the contour plot on the model. Possible values are UNDEFORMED and DEFORMED. The initial value is DEFORMED. deformationScaling A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The initial value is AUTO. uniformScaleFactor A Float specifying the uniform deformation scaling constant deformationScaling=UNIFORM. The initial value is autoDeformationScaleValue. when

nonuniformScaleFactor A Sequence of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The initial value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue). edgeColorWireHide A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=WIREFRAME or HIDDEN. The initial value is “Green.” edgeColorFillShade A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=FILLED or SHADED. The initial value is “Black.” edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN.

35–32

OrientationOptions object

colorCodeOverride A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The initial value is ON. fillColor A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The initial value is “Green.” labelFont A String specifying the label font to be used for all model labels. The initial value is “-*-couriermedium-r-normal-*-*-120–*-*-m-*-*-*”. elemLabels A Boolean specifying whether to plot the element labels. The initial value is OFF. elemLabelColor A String specifying the color to be used to plot the element labels. The initial value is “Cyan.” faceLabels A Boolean specifying whether to plot the face labels. The initial value is OFF. faceLabelColor A String specifying the color to be used to plot the face labels. The initial value is “Red.” nodeLabels A Boolean specifying whether to plot the node labels. The initial value is OFF. nodeLabelColor A String specifying the color to be used to plot the node labels. The initial value is “Yellow.” nodeSymbols A Boolean specifying whether to plot the node symbols. The initial value is OFF. nodeSymbolType A SymbolicConstant specifying the node symbol types. Possible values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, and XMARKER. The initial value is HOLLOW_CIRCLE. nodeSymbolColor A String specifying the color to be used to plot the node symbols. The initial value is “Yellow.” nodeSymbolSize A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The initial value is SMALL. elementShrink A Boolean specifying whether elements are displayed in a shrunk format. The initial value is OFF. elementShrinkFactor An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0 elementShrinkPercentage 90. The initial value is 5.

35–33

SymbolOptions object

coordinateScale A Boolean specifying whether to scale coordinates. The initial value is OFF. coordinateScaleFactors A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The initial value is (1.0, 1.0, 1.0). translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency=ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3. autoDeformationScaleValue A Float specifying the deformed scale factor value when deformationScaling=AUTO.

35.6

SymbolOptions object

The SymbolOptions object stores values and attributes associated with a symbol plot. The SymbolOptions object has no constructor command. ABAQUS creates a defaultOdbDisplay.symbolOptions member when you import the Visualization module. ABAQUS creates a symbolOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.symbolOptions. ABAQUS creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. SymbolOptions objects are accessed in one of two ways:

• •

The default symbol options. These settings are used as defaults when other symbolOptions members are created. These settings can be set to customize user preferences. The symbol options associated with a particular viewport.

Access

import visualization session.defaultOdbDisplay.symbolOptions session.viewports[name].odbDisplay.symbolOptions

35.6.1

setValues(...)

This method modifies the SymbolOptions object.
Arguments Required arguments

None.

35–34

SymbolOptions object

Optional arguments

options A SymbolOptions object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None. renderStyle A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME and SHADED. The initial value is WIREFRAME. visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. vectorQuantity A SymbolicConstant specifying the vector quantity to display. Possible values are RESULTANT and VECTOR_COMPONENT. The initial value is RESULTANT. vectorLineThickness A SymbolicConstant specifying the vector line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. vectorArrowheadStyle A SymbolicConstant specifying the vector arrowhead style. Possible values are NONE, FILLED, and WIRE. The initial value is WIRE. vectorColor A String specifying the vector color. The initial value is “Red.” vectorMaxValueAutoCompute A Boolean specifying whether the maximum vector value is to be computed automatically. The initial value is ON. vectorMaxValue A Float specifying the user-specified maximum vector value. The initial value is autoVectorMaxValue. vectorMinValueAutoCompute A Boolean specifying whether the minimum vector value is to be computed automatically. The initial value is ON. vectorMinValue A Float specifying the user-specified minimum vector value. The initial value is autoVectorMinValue. tensorQuantity A SymbolicConstant specifying the tensor quantity to display. Possible values are ALL_PRINCIPAL_COMPONENTS, PRINCIPAL_COMPONENT, ALL_DIRECT_COMPONENTS, and DIRECT_COMPONENT. The initial value is ALL_PRINCIPAL_COMPONENTS.

35–35

SymbolOptions object

arrowSymbolSize An Int specifying the length of vector and tensor symbols. The initial value is 6. tensorMaxPrinColor A String specifying the color of the maximum principal tensor symbols. The initial value is “Red.” tensorMinPrinColor A String specifying the color of the minimum principal tensor symbols. The initial value is “Cyan.” tensorMidPrinColor A String specifying the color of the intermediate principal tensor symbols. The initial value is “Yellow.” tensorSelectedPrinColor A String specifying the color of the selected principal tensor symbols. The initial value is “Red.” tensorLineThickness A SymbolicConstant specifying the line thickness of the tensor symbols. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. tensorArrowheadStyle A SymbolicConstant specifying the arrowhead style of the tensor symbols. Possible values are NONE, FILLED, and WIRE. The initial value is WIRE. tensorMaxValueAutoCompute A Boolean specifying whether the maximum tensor value is to be computed automatically. The initial value is ON. tensorMaxValue A Float specifying the user-specified maximum tensor value. autoTensorMaxValue. The initial value is

tensorMinValueAutoCompute A Boolean specifying whether the minimum tensor value is to be computed automatically. The initial value is ON. tensorMinValue A Float specifying the user-specified minimum tensor value. autoTensorMinValue. The initial value is

edgeColorWireHide A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=WIREFRAME or HIDDEN. The initial value is “Green.” edgeColorFillShade A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=FILLED or SHADED. The initial value is “Black.” edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID.

35–36

SymbolOptions object

edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. colorCodeOverride A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The initial value is ON. fillColor A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The initial value is “Green.” modelShape A SymbolicConstant specifying the shape to be used when drawing the symbols on the model. Possible values are UNDEFORMED and DEFORMED. The initial value is DEFORMED. deformationScaling A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The initial value is AUTO. uniformScaleFactor A Float specifying the uniform deformation scaling constant when deformationScaling=UNIFORM. The initial value is autoDeformationScaleValue. nonuniformScaleFactor A Sequence of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The initial value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue). elementShrink A Boolean specifying whether elements are displayed in a shrunk format. The initial value is OFF. elementShrinkFactor An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0 elementShrinkPercentage 90. The initial value is 5. coordinateScale A Boolean specifying whether to scale coordinates. The initial value is OFF. coordinateScaleFactors A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The initial value is (1.0, 1.0, 1.0). labelFont A String specifying the label font to be used for all model labels. The initial value is “-*-couriermedium-r-normal-*-*-120–*-*-m-*-*-*”. elemLabels A Boolean specifying whether to plot the element labels. The initial value is OFF. elemLabelColor A String specifying the color to be used to plot the element labels. The initial value is “Cyan.”

35–37

SymbolOptions object

faceLabels A Boolean specifying whether to plot the face labels. The initial value is OFF. faceLabelColor A String specifying the color to be used to plot the face labels. The initial value is “Red.” nodeLabels A Boolean specifying whether to plot the node labels. The initial value is OFF. nodeLabelColor A String specifying the color to be used to plot the node labels. The initial value is “Yellow.” nodeSymbols A Boolean specifying whether to plot the node symbols. The initial value is OFF. nodeSymbolType A SymbolicConstant specifying the node symbol types. Possible values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, and XMARKER. The initial value is HOLLOW_CIRCLE. nodeSymbolColor A String specifying the color to be used to plot the node symbols. The initial value is “Yellow.” nodeSymbolSize A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The initial value is SMALL. translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency=ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3.
Return value

None
Exceptions

RangeError.

35.6.2

Members

The SymbolOptions object has the following members: renderStyle A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME and SHADED. The initial value is WIREFRAME.

35–38

SymbolOptions object

visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. vectorQuantity A SymbolicConstant specifying the vector quantity to display. Possible values are RESULTANT and VECTOR_COMPONENT. The initial value is RESULTANT. vectorLineThickness A SymbolicConstant specifying the vector line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. vectorArrowheadStyle A SymbolicConstant specifying the vector arrowhead style. Possible values are NONE, FILLED, and WIRE. The initial value is WIRE. vectorColor A String specifying the vector color. The initial value is “Red.” vectorMaxValueAutoCompute A Boolean specifying whether the maximum vector value is to be computed automatically. The initial value is ON. vectorMaxValue A Float specifying the user-specified maximum vector value. autoVectorMaxValue. The initial value is

vectorMinValueAutoCompute A Boolean specifying whether the minimum vector value is to be computed automatically. The initial value is ON. vectorMinValue A Float specifying the user-specified minimum vector value. autoVectorMinValue. The initial value is

tensorQuantity A SymbolicConstant specifying the tensor quantity to display. Possible values are ALL_PRINCIPAL_COMPONENTS, PRINCIPAL_COMPONENT, ALL_DIRECT_COMPONENTS, and DIRECT_COMPONENT. The initial value is ALL_PRINCIPAL_COMPONENTS. arrowSymbolSize An Int specifying the length of vector and tensor symbols. The initial value is 6. tensorMaxPrinColor A String specifying the color of the maximum principal tensor symbols. The initial value is “Red.” tensorMinPrinColor A String specifying the color of the minimum principal tensor symbols. The initial value is “Cyan.”

35–39

SymbolOptions object

tensorMidPrinColor A String specifying the color of the intermediate principal tensor symbols. The initial value is “Yellow.” tensorSelectedPrinColor A String specifying the color of the selected principal tensor symbols. The initial value is “Red.” tensorLineThickness A SymbolicConstant specifying the line thickness of the tensor symbols. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. tensorArrowheadStyle A SymbolicConstant specifying the arrowhead style of the tensor symbols. Possible values are NONE, FILLED, and WIRE. The initial value is WIRE. tensorMaxValueAutoCompute A Boolean specifying whether the maximum tensor value is to be computed automatically. The initial value is ON. tensorMaxValue A Float specifying the user-specified maximum tensor value. autoTensorMaxValue. The initial value is

tensorMinValueAutoCompute A Boolean specifying whether the minimum tensor value is to be computed automatically. The initial value is ON. tensorMinValue A Float specifying the user-specified minimum tensor value. autoTensorMinValue. The initial value is

edgeColorWireHide A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=WIREFRAME or HIDDEN. The initial value is “Green.” edgeColorFillShade A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=FILLED or SHADED. The initial value is “Black.” edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. colorCodeOverride A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The initial value is ON.

35–40

SymbolOptions object

fillColor A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The initial value is “Green.” modelShape A SymbolicConstant specifying the shape to be used when drawing the symbols on the model. Possible values are UNDEFORMED and DEFORMED. The initial value is DEFORMED. deformationScaling A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The initial value is AUTO. uniformScaleFactor A Float specifying the uniform deformation scaling constant when deformationScaling=UNIFORM. The initial value is autoDeformationScaleValue. nonuniformScaleFactor A Sequence of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The initial value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue). elementShrink A Boolean specifying whether elements are displayed in a shrunk format. The initial value is OFF. elementShrinkFactor An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0 elementShrinkPercentage 90. The initial value is 5. coordinateScale A Boolean specifying whether to scale coordinates. The initial value is OFF. coordinateScaleFactors A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The initial value is (1.0, 1.0, 1.0). labelFont A String specifying the label font to be used for all model labels. The initial value is “-*-couriermedium-r-normal-*-*-120–*-*-m-*-*-*”. elemLabels A Boolean specifying whether to plot the element labels. The initial value is OFF. elemLabelColor A String specifying the color to be used to plot the element labels. The initial value is “Cyan.” faceLabels A Boolean specifying whether to plot the face labels. The initial value is OFF. faceLabelColor A String specifying the color to be used to plot the face labels. The initial value is “Red.” nodeLabels A Boolean specifying whether to plot the node labels. The initial value is OFF.

35–41

UndeformedShapeOptions object

nodeLabelColor A String specifying the color to be used to plot the node labels. The initial value is “Yellow.” nodeSymbols A Boolean specifying whether to plot the node symbols. The initial value is OFF. nodeSymbolType A SymbolicConstant specifying the node symbol types. Possible values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, and XMARKER. The initial value is HOLLOW_CIRCLE. nodeSymbolColor A String specifying the color to be used to plot the node symbols. The initial value is “Yellow.” nodeSymbolSize A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The initial value is SMALL. translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency=ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3. autoDeformationScaleValue A Float specifying the deformed scale factor value when deformationScaling=AUTO. autoVectorMaxValue A Float or the SymbolicConstant NOT_SET specifying the vector maximum value when vectorMaxValueAutoCompute=ON. The initial value is NOT_SET. autoVectorMinValue A Float or the SymbolicConstant NOT_SET specifying the vector minimum value when vectorMinValueAutoCompute=ON. The initial value is NOT_SET. autoTensorMaxValue A Float or the SymbolicConstant NOT_SET specifying the tensor maximum value when tensorMaxValueAutoCompute=ON. The initial value is NOT_SET. autoTensorMinValue A Float or the SymbolicConstant NOT_SET specifying the tensor minimum value when tensorMinValueAutoCompute=ON. The initial value is NOT_SET.

35.7

UndeformedShapeOptions object

The UndeformedShapeOptions object stores values and attributes associated with an undeformed shape plot. The UndeformedShapeOptions object has no constructor command. ABAQUS creates a

35–42

UndeformedShapeOptions object

defaultOdbDisplay.undeformedOptions member when you import the Visualization module. ABAQUS creates an undeformedOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.undeformedShapeOptions. ABAQUS creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. UndeformedShapeOptions objects are accessed in one of two ways:

• •

The default undeformed options. These settings are used as defaults when other undeformedOptions members are created. These settings can be set to customize user preferences. The undeformed options associated with a particular viewport.

Access

import visualization session.defaultOdbDisplay.undeformedShapeOptions session.viewports[name].odbDisplay.undeformedShapeOptions

35.7.1

setValues(...)

This method modifies the UndeformedShapeOptions object.
Arguments Required arguments

None.
Optional arguments

options An UndeformedShapeOptions object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None. renderStyle A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The initial value is WIREFRAME. visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. edgeColorWireHide A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=WIREFRAME or HIDDEN. The initial value is “Green.” edgeColorFillShade A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=FILLED or SHADED. The initial value is “Black.”

35–43

UndeformedShapeOptions object

edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. colorCodeOverride A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The initial value is ON. fillColor A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The initial value is “Green.” labelFont A String specifying the label font to be used for all model labels. The initial value is “-*-couriermedium-r-normal-*-*-120–*-*-m-*-*-*”. elemLabels A Boolean specifying whether to plot the element labels. The initial value is OFF. elemLabelColor A String specifying the color to be used to plot the element labels. The initial value is “Cyan.” faceLabels A Boolean specifying whether to plot the face labels. The initial value is OFF. faceLabelColor A String specifying the color to be used to plot the face labels. The initial value is “Red.” nodeLabels A Boolean specifying whether to plot the node labels. The initial value is OFF. nodeLabelColor A String specifying the color to be used to plot the node labels. The initial value is “Yellow.” nodeSymbols A Boolean specifying whether to plot the node symbols. The initial value is OFF. nodeSymbolType A SymbolicConstant specifying the node symbol types. Possible values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, and XMARKER. The initial value is HOLLOW_CIRCLE. nodeSymbolColor A String specifying the color to be used to plot the node symbols. The initial value is “Yellow.” nodeSymbolSize A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The initial value is SMALL.

35–44

UndeformedShapeOptions object

elementShrink A Boolean specifying whether elements are displayed in a shrunk format. The initial value is OFF. elementShrinkFactor An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0 elementShrinkPercentage 90. The initial value is 5. coordinateScale A Boolean specifying whether to scale coordinates. The initial value is OFF. coordinateScaleFactors A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The initial value is (1.0, 1.0, 1.0). normals A Boolean specifying whether to draw arrows that indicate the directions of element and surface normals. The initial value is OFF. faceNormalColor A String specifying the color to be used to plot the normal to a nonbeam element or to a surface. The initial value is “Red.” beamN1Color A String specifying the color to be used to plot an arrow along the beam -direction. The initial value is “Blue.” beamN2Color A String specifying the color to be used to plot an arrow along the beam -direction. The initial value is “Red.” beamTangentColor A String specifying the color to be used to plot an arrow along the tangent to a beam. The initial value is “White.” normalArrowLength A SymbolicConstant specifying the length of the normal arrows. Possible values are SHORT, MEDIUM, and LONG. The initial value is MEDIUM. normalLineThickness A SymbolicConstant specifying the thickness of the normal arrows. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. normalArrowheadStyle A SymbolicConstant specifying the arrowhead style of the normal arrows. Possible values are NONE, FILLED, and WIRE. The initial value is WIRE. translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency = ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3.

35–45

UndeformedShapeOptions object

Return value

None
Exceptions

RangeError.

35.7.2

Members

The UndeformedShapeOptions object has the following members: renderStyle A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The initial value is WIREFRAME. visibleEdges A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. NONE can be used only when renderStyle=SHADED. The initial value is FEATURE. edgeColorWireHide A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=WIREFRAME or HIDDEN. The initial value is “Green.” edgeColorFillShade A String specifying the color to be used to plot the edges of the undeformed plot when renderStyle=FILLED or SHADED. The initial value is “Black.” edgeLineStyle A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The initial value is SOLID. edgeLineThickness A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. colorCodeOverride A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The initial value is ON. fillColor A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The initial value is “Green.” labelFont A String specifying the label font to be used for all model labels. The initial value is “-*-couriermedium-r-normal-*-*-120–*-*-m-*-*-*”.

35–46

UndeformedShapeOptions object

elemLabels A Boolean specifying whether to plot the element labels. The initial value is OFF. elemLabelColor A String specifying the color to be used to plot the element labels. The initial value is “Cyan.” faceLabels A Boolean specifying whether to plot the face labels. The initial value is OFF. faceLabelColor A String specifying the color to be used to plot the face labels. The initial value is “Red.” nodeLabels A Boolean specifying whether to plot the node labels. The initial value is OFF. nodeLabelColor A String specifying the color to be used to plot the node labels. The initial value is “Yellow.” nodeSymbols A Boolean specifying whether to plot the node symbols. The initial value is OFF. nodeSymbolType A SymbolicConstant specifying the node symbol types. Possible values are FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, and XMARKER. The initial value is HOLLOW_CIRCLE. nodeSymbolColor A String specifying the color to be used to plot the node symbols. The initial value is “Yellow.” nodeSymbolSize A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The initial value is SMALL. elementShrink A Boolean specifying whether elements are displayed in a shrunk format. The initial value is OFF. elementShrinkFactor An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0 elementShrinkPercentage 90. The initial value is 5. coordinateScale A Boolean specifying whether to scale coordinates. The initial value is OFF. coordinateScaleFactors A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The initial value is (1.0, 1.0, 1.0). normals A Boolean specifying whether to draw arrows that indicate the directions of element and surface normals. The initial value is OFF.

35–47

ViewCutOptions object

faceNormalColor A String specifying the color to be used to plot the normal to a nonbeam element or to a surface. The initial value is “Red.” beamN1Color A String specifying the color to be used to plot an arrow along the beam value is “Blue.” beamN2Color A String specifying the color to be used to plot an arrow along the beam value is “Red.” -direction. The initial

-direction. The initial

beamTangentColor A String specifying the color to be used to plot an arrow along the tangent to a beam. The initial value is “White.” normalArrowLength A SymbolicConstant specifying the length of the normal arrows. Possible values are SHORT, MEDIUM, and LONG. The initial value is MEDIUM. normalLineThickness A SymbolicConstant specifying the thickness of the normal arrows. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The initial value is VERY_THIN. normalArrowheadStyle A SymbolicConstant specifying the arrowhead style of the normal arrows. Possible values are NONE, FILLED, and WIRE. The initial value is WIRE. translucency A Boolean specifying whether to set translucency. The initial value is OFF. translucencyFactor A Float specifying the translucency factor when translucency = ON. Possible values are 0.0 translucencyFactor 1.0. The initial value is 0.3.

35.8

ViewCutOptions object

The ViewCutOptions object stores values and attributes associated with a view cut plot. The ViewCutOptions object has no constructor command. ABAQUS creates a defaultOdbDisplay.viewCutOptions member when you import the Visualization module. ABAQUS creates an viewCutOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.viewCutOptions. ABAQUS creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. ViewCutOptions objects are accessed in one of two ways:



The default view cut options. These settings are used as defaults when other viewCutOptions members are created. These settings can be set to customize user preferences.

35–48

ViewCutOptions object



The view cut options associated with a particular viewport.

Access

import visualization session.defaultOdbDisplay.viewCutOptions session.viewports[name].odbDisplay.viewCutOptions

35.8.1

setValues(...)

This method modifies the ViewCutOptions object.
Arguments Required arguments

None.
Optional arguments

options A ViewCutOptions object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None. belowOptions An OptionArg object from which values are to be used for defining the options applicable on the model below the cut. The default value is None. useBelowOptions A Boolean specifying whether to use the options defined for displaying the model below the cut. The initial value is FALSE. onOptions An OptionArg object from which values are to be used for defining the options applicable on the model on the cut. The default value is None. useOnOptions A Boolean specifying whether to use the options defined for displaying the model on the cut. The initial value is FALSE. aboveOptions An OptionArg object from which values are to be used for defining the options applicable on the model above the cut. The default value is None. useAboveOptions A Boolean specifying whether to use the options defined for displaying the model above the cut. The initial value is FALSE.
Return value

None

35–49

ViewCutOptions object

Exceptions

RangeError.

35.8.2

Members

The ViewCutOptions object can have the following members: useBelowOptions A Boolean specifying whether to use the options defined for displaying the model below the cut. The initial value is FALSE. useOnOptions A Boolean specifying whether to use the options defined for displaying the model on the cut. The initial value is FALSE. useAboveOptions A Boolean specifying whether to use the options defined for displaying the model above the cut. The initial value is FALSE. belowOptions An OptionArg object from which values are to be used for defining the options applicable on the model below the cut. The default value is None. onOptions An OptionArg object from which values are to be used for defining the options applicable on the model on the cut. The default value is None. aboveOptions An OptionArg object from which values are to be used for defining the options applicable on the model above the cut. The default value is None.

35–50

Kernel plug-in registration commands

36.

Plug-in registration commands
Plug-in commands register kernel and GUI plug-ins in either the Plug-ins menu or in a toolbox.

36.1

Kernel plug-in registration commands

Kernel plug-in commands register kernel plug-ins in either the Plug-ins menu or in a toolbox.
Access

from abaqusGui import getAFXApp toolset=getAFXApp().getAFXMainWindow().getPluginToolset()

36.1.1

registerKernelMenuButton(...)

This method registers a kernel plug-in in the Plug-ins menu.
Path

toolset.registerKernelMenuButton
Arguments Required arguments

moduleName A String specifying the name of the module to be imported. The module must contain the function to be executed. functionName A String specifying the name of the function to be executed. The function must be located in moduleName. buttonText A String specifying the text to be displayed in the Plug-ins menu. Use a pipe ( | ) between words to specify submenus. The default value is the empty string.
Optional arguments

icon An FXXPMIcon object specifying an icon to be displayed to the left of the text in the menu. For more information, see FXXPMIcon in the ABAQUS GUI Toolkit Reference Manual. The default value is None. applicableModules The SymbolicConstant ALL or a sequence of one or more Strings specifying the list of modules to which this plug-in applies. If a plug-in is not applicable to a module, it will be hidden when the user

36–1

Kernel plug-in registration commands

switches into that module. Possible values of the Strings in the sequence are “Part”, “Property”, “Assembly”, “Step”, “Interaction”, “Load”, “Mesh”, “Job”, “Visualization”, and “Sketch”. The default value is ALL. version A String specifying the version of the plug-in. The version is displayed in the About Plug-ins dialog box. The default value is “N/A”. author A String specifying the author of the plug-in. The author is displayed in the About Plug-ins dialog box. The default value is “N/A”. description A String specifying the description of the plug-in. The description is displayed in the About Plug-ins dialog box. The default value is “N/A”. helpUrl A String specifying the universal resource locator (URL) that points to the help for this plug-in. This URL can be loaded in a web browser from the View button in the About Plug-ins dialog box. The default value is “N/A”.
Return value

None
Exceptions

None.

36.1.2

registerKernelToolButton(...)

Registers a kernel plug-in in a toolbox.
Path

toolset.registerKernelToolButton
Arguments Required arguments

toolboxName A String specifying the name of the toolbox in which the button will be shown. The name appears in the toolbox title bar. moduleName A String specifying the name of the module to be imported. The module must contain the function to be executed.

36–2

Kernel plug-in registration commands

functionName A String specifying the name of the function to be executed. The function must be located in moduleName.
Optional arguments

buttonText A String specifying the text to be displayed in the Plug-ins menu. Use a pipe ( | ) between words to specify submenus. The default value is the empty string. icon A FXXPMIcon object specifying an icon to be displayed to the left of the text in the menu. For more information, see FXXPMIcon in the ABAQUS GUI Toolkit Reference Manual. The default value is None. applicableModules The SymbolicConstant ALL or a sequence of one or more Strings specifying the list of modules to which this plug-in applies. If a plug-in is not applicable to a module, it will be hidden when the user switches into that module. Possible values of the Strings in the sequence are “Part”, “Property”, “Assembly”, “Step”, “Interaction”, “Load”, “Mesh”, “Job”, “Visualization”, and “Sketch”. The default value is ALL. version A String specifying the version of the plug-in. The version is displayed in the About Plug-ins dialog box. The default value is “N/A”. author A String specifying the author of the plug-in. The author is displayed in the About Plug-ins dialog box. The default value is “N/A”. description A String specifying the description of the plug-in. The description is displayed in the About Plug-ins dialog box. The default value is “N/A”. helpUrl A String specifying the universal resource locator (URL) that points to the help for this plug-in. This URL can be loaded in a web browser from the View button in the About Plug-ins dialog box. The default value is “N/A”.

Return value

None

Exceptions

None.

36–3

GUI plug-in registration commands

36.2

GUI plug-in registration commands

GUI plug-in commands register GUI plug-ins either in the Plug-ins menu or in a toolbox.

36.2.1

registerGuiMenuButton(...)

Registers a GUI plug-in in the Plug-ins menu.
Path

toolset.registerGuiMenuButton
Arguments Required arguments

object The GUI object to which a (messageId, SEL_COMMAND) message will be sent. The object must have been inherited from FXObject. buttonText A String specifying the text to be displayed in the Plug-ins menu. Use a pipe ( | ) between words to specify submenus. The default value is the empty string.
Optional arguments

messageId An Int specifying the ID to be used when sending a command to the GUI object. The default value is AFXMode.ID_ACTIVATE. icon A FXXPMIcon object specifying an icon to be displayed to the left of the text in the menu. For more information, see FXXPMIcon in the ABAQUS GUI Toolkit Reference Manual. The default value is None. kernelInitString A String specifying the string sent to the kernel the first time this plug-in is invoked. The string is intended to initialize the kernel (typically by importing modules) in preparation for commands that will be sent by this plug-in’s GUI. The default value is the empty string. applicableModules The SymbolicConstant ALL or a sequence of one or more Strings specifying the list of modules to which this plug-in applies. If a plug-in is not applicable to a module, it will be hidden when the user switches into that module. Possible values of the Strings in the sequence are “Part”, “Property”, “Assembly”, “Step”, “Interaction”, “Load”, “Mesh”, “Job”, “Visualization”, and “Sketch”. The default value is ALL.

36–4

GUI plug-in registration commands

version A String specifying the version of the plug-in. The version is displayed in the About Plug-ins dialog box. The default value is “N/A”. author A String specifying the author of the plug-in. The author is displayed in the About Plug-ins dialog box. The default value is “N/A”. description A String specifying the description of the plug-in. The description is displayed in the About Plug-ins dialog box. The default value is “N/A”. helpUrl A String specifying the universal resource locator (URL) that points to the help for this plug-in. This URL can be loaded in a web browser from the View button in the About Plug-ins dialog box. The default value is “N/A”.
Return value

None
Exceptions

None.

36.2.2

registerGuiToolButton(...)

Registers a GUI plug-in in a toolbox.
Path

toolset.registerGuiToolButton
Arguments Required arguments

toolboxName A String specifying the name of the toolbox in which the button will be shown. The name appears in the toolbox title bar. object The GUI object to which a (messageId, SEL_COMMAND) message will be sent. The object must have been inherited from FXObject.
Optional arguments

messageId An Int specifying the ID to be used when sending a command to the GUI object. The default value is AFXMode.ID_ACTIVATE.

36–5

GUI plug-in registration commands

buttonText A String specifying the text to be displayed in the Plug-ins menu. Use a pipe ( | ) between words to specify submenus. The default value is the empty string. icon A FXXPMIcon object specifying an icon to be displayed to the left of the text in the menu. For more information, see FXXPMIcon in the ABAQUS GUI Toolkit Reference Manual. The default value is None. kernelInitString A String specifying the string sent to the kernel the first time this plug-in is invoked. The string is intended to initialize the kernel (typically by importing modules) in preparation for commands that will be sent by this plug-in’s GUI. The default value is the empty string. applicableModules The SymbolicConstant ALL or a sequence of one or more Strings specifying the list of modules to which this plug-in applies. If a plug-in is not applicable to a module, it will be hidden when the user switches into that module. Possible values of the Strings in the sequence are “Part”, “Property”, “Assembly”, “Step”, “Interaction”, “Load”, “Mesh”, “Job”, “Visualization”, and “Sketch”. The default value is ALL. version A String specifying the version of the plug-in. The version is displayed in the About Plug-ins dialog box. The default value is “N/A”. author A String specifying the author of the plug-in. The author is displayed in the About Plug-ins dialog box. The default value is “N/A”. description A String specifying the description of the plug-in. The description is displayed in the About Plug-ins dialog box. The default value is “N/A”. helpUrl A String specifying the universal resource locator (URL) that points to the help for this plug-in. This URL can be loaded in a web browser from the View button in the About Plug-ins dialog box. The default value is “N/A”.
Return value

None
Exceptions

None.

36–6

PrintOptions object

37.

Print commands
The print commands are used to print selected canvas objects to a file or to a Windows or PostScript printer and to control the format of the printed output.

37.1

PrintOptions object

The PrintOptions object stores the common settings that ABAQUS uses for all print methods. The PrintOptions object has no constructor. ABAQUS creates the printOptions member when a session is started.
Access

session.printOptions

37.1.1

setValues(...)

This method modifies the PrintOptions object.
Arguments Required arguments

None.
Optional arguments

rendition A SymbolicConstant specifying how the image is rendered. Possible values are BLACK_AND_WHITE, GREYSCALE, and COLOR. The initial value is COLOR. vpDecorations A Boolean specifying whether the output includes the viewport border and title. The initial value is ON. vpBackground A Boolean specifying whether the output includes viewport backgrounds. The initial value is OFF. printCommand A String specifying the default print command that will be used by the printToPrinter method if no printCommand argument is provided. The initial value is “lpr.” deleteTemporaryFiles A Boolean specifying whether to delete the temporary files created when an image is printed. Possible values are TRUE and FALSE. The default value is TRUE. You should set the deleteTemporaryFiles argument to FALSE if your printer does not support print spooling.

37–1

EpsOptions object

Return value

None
Exceptions

None.

37.1.2

Members

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

37.2

EpsOptions object

The EpsOptions object stores the settings that ABAQUS uses when printing using Encapsulated PostScript format. The EpsOptions object has no constructor. ABAQUS creates the epsOptions member when a session is started.
Access

session.epsOptions

37.2.1

setValues(...)

This method modifies the EpsOptions object.
Arguments Required arguments

None.
Optional arguments

imageSize A pair of Floats or the SymbolicConstant SIZE_ON_SCREEN specifying the width and height of the image in the units specified by units. Possible numeric values are imageSize (minWidth, minHeight). The initial value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is 10 mm (approximately 0.4 inches).

37–2

PageSetupOptions object

units A SymbolicConstant specifying the units of the imageSize argument. This argument is ignored if imageSize is SIZE_ON_SCREEN. Possible values are INCHES and MM. The initial value is INCHES. resolution A SymbolicConstant specifying the resolution of the image in dots per inch (dpi). Possible values are DPI_75, DPI_150, DPI_300, DPI_450, and DPI_600. The initial value is DPI_150. fontType A SymbolicConstant specifying the PostScript font substitution rules to be applied. Possible values are PS_ALWAYS, PS_IF_AVAILABLE, and AS_DISPLAYED. The initial value is PS_IF_AVAILABLE. imageFormat A SymbolicConstant specifying how the viewport display will be represented. Possible values are VECTOR and RASTER. The initial value is VECTOR. shadingQuality A SymbolicConstant specifying how fine the shading of curved surfaces will be for vector images. Possible values are EXTRA COARSE, COARSE, MEDIUM, FINE, and EXTRA FINE. The initial value is MEDIUM.
Return value

None
Exceptions

RangeError. If either element of imageSize is out of range: RangeError: imageSize must be SIZE_ON_SCREEN or a sequence of 2 Floats >= (minWidth, minHeight)

37.2.2

Members

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

37.3

PageSetupOptions object

The PageSetupOptions object stores the settings that ABAQUS uses when printing using a Windows printer. The PageSetupOptions object has no constructor. ABAQUS creates the pageSetupOptions member when a session is started.

37–3

PageSetupOptions object

Access

session.pageSetupOptions

37.3.1

setValues(...)

This method modifies the PageSetupOptions object.
Arguments Required arguments

None.
Optional arguments

imageSize A pair of Floats or a SymbolicConstant specifying the size of the printed image in the currently selected units (inches or millimeters). Possible values are FIT_TO_PAGE, SIZE_ON_SCREEN, or (minWidth, minHeight) imageSize (paper size − margins). The initial value is FIT_TO_PAGE. Note: The minimum value of width and height (minWidth and minHeight) is 10 mm (approximately 0.4 inches). units A SymbolicConstant specifying the units to use for the margins and image size. Possible values are INCHES and MM. The initial value is INCHES. quality A SymbolicConstant specifying the quality of the image. MEDIUM, and FINE. The initial value is MEDIUM. Possible values are COARSE,

topMargin A Float specifying the top margin of the paper in the currently selected units (inches or millimeters). Possible values are topMargin . The initial value is 0.5 inches. bottomMargin A Float specifying the bottom margin of the paper in the currently selected units (inches or millimeters). Possible values are bottomMargin 0. The initial value is 0.5 inches. leftMargin A Float specifying the left margin of the paper in the currently selected units (inches or millimeters). Possible values are leftMargin 0. The initial value is 0.5 inches. rightMargin A Float specifying the right margin of the paper in the currently selected units (inches or millimeters). Possible values are rightMargin 0. The initial value is 0.5 inches.

37–4

PngOptions object

orientation A SymbolicConstant specifying the orientation of the image. Possible values are PORTRAIT and LANDSCAPE. The initial value is PORTRAIT. logo A Boolean specifying whether the output includes the ABAQUS logo. The default value is ON. date A Boolean specifying whether the output includes the date. The default value is ON.
Return value

None
Exceptions

RangeError. Note: The minimum value of width and height (minWidth and minHeight) is 10 mm (approximately 0.4 inches). If leftMargin + rightMargin is out of range: RangeError: leftMargin and rightMargin must produce image width >= minWidth If topMargin + bottomMargin is out of range: RangeError: topMargin and bottomMargin must produce image height >= minHeight

37.3.2

Members

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

37.4

PngOptions object

The PngOptions object stores the settings that ABAQUS uses when printing in PNG format. The PngOptions object has no constructor. ABAQUS creates the pngOptions member when a session is started.
Access

session.pngOptions

37.4.1

setValues(...)

This method modifies the PngOptions object.

37–5

PsOptions object

Arguments Required arguments

None.
Optional arguments

imageSize A pair of Ints or the SymbolicConstant SIZE_ON_SCREEN specifying the width and height of the image in pixels. Possible values are (minWidth, minHeight) imageSize (1280, 1024). The initial value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is the number of pixels that occupy 10 mm at the current screen resolution. The value is typically around 50 pixels and may be different for width and height.
Return value

None
Exceptions

RangeError. If either the width or height arguments of imageSize are out of range (where minWidth and minHeight are the number of pixels corresponding to approximately 10 mm for a given display): RangeError: imageSize must be SIZE_ON_SCREEN or a sequence of 2 Ints in the range (minWidth, minHeight) <= (width, height) <= (1280, 1024).

37.4.2

Members

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

37.5

PsOptions object

The PsOptions object stores the settings that ABAQUS uses when printing using PostScript format. The PsOptions object has no constructor. ABAQUS creates the psOptions member when a session is started.
Access

session.psOptions

37–6

PsOptions object

37.5.1

setValues(...)

This method modifies the PsOptions object.
Arguments Required arguments

None.
Optional arguments

paperSize A SymbolicConstant specifying the paper size. Possible values are LETTER, LEGAL, LEDGER, A0, A1, A2, A3, A4, and A5. The initial value is LETTER. topMargin A Float specifying the top margin of the paper in inches. Possible values are topMargin initial value is 0.5 inches. . The

bottomMargin A Float specifying the bottom margin of the paper in inches. Possible values are bottomMargin 0. The initial value is 0.5 inches. leftMargin A Float specifying the left margin of the paper in inches. Possible values are leftMargin initial value is 0.5 inches. 0. The

rightMargin A Float specifying the right margin of the paper in inches. Possible values are rightMargin The initial value is 0.5 inches.

0.

orientation A SymbolicConstant specifying the orientation of the image. Possible values are PORTRAIT and LANDSCAPE. The initial value is PORTRAIT. logo A Boolean specifying whether the output includes the ABAQUS logo. The default value is ON. date A Boolean specifying whether the output includes the date. The default value is ON. resolution A SymbolicConstant specifying the resolution of the image in dots per inch (dpi). Possible values are DPI_75, DPI_150, DPI_300, DPI_450, and DPI_600. The initial value is DPI_150. fontType A SymbolicConstant specifying the PostScript font substitution rules to be applied. Possible values are PS_ALWAYS, PS_IF_AVAILABLE, and AS_DISPLAYED. The initial value is PS_IF_AVAILABLE.

37–7

SvgOptions object

imageFormat A SymbolicConstant specifying how the viewport display will be represented. Possible values are VECTOR and RASTER. The initial value is VECTOR. shadingQuality A SymbolicConstant specifying how fine the shading of curved surfaces will be for vector images. Possible values are EXTRA COARSE, COARSE, MEDIUM, FINE, and EXTRA FINE. The initial value is MEDIUM.
Return value

None
Exceptions

RangeError. Note: The minimum value of width and height (minWidth and minHeight) is 10 mm (approximately 0.4 inches). If leftMargin + rightMargin is out of range: RangeError: leftMargin and rightMargin must produce image width >= minWidth If topMargin + bottomMargin is out of range: RangeError: topMargin and bottomMargin must produce image height >= minHeight

37.5.2

Members

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

37.6

SvgOptions object

The SvgOptions object stores the settings that ABAQUS uses when printing in SVG format. The SvgOptions object has no constructor. ABAQUS creates the svgOptions member when a session is started.
Access

session.svgOptions

37.6.1

setValues(...)

This method modifies the SvgOptions object.

37–8

TiffOptions object

Arguments Required arguments

None.
Optional arguments

imageSize A pair of Ints or the SymbolicConstant SIZE_ON_SCREEN specifying the width and height of the image in pixels. Possible values are (minWidth, minHeight) imageSize (1280, 1024). The initial value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is the number of pixels that occupy 10 mm at the current screen resolution. The value is typically around 50 pixels and may be different for width and height.
Return value

None
Exceptions

RangeError. If either the width or height arguments of imageSize are out of range (where minWidth and minHeight are the number of pixels corresponding to approximately 10 mm for a given display): RangeError: imageSize must be SIZE_ON_SCREEN or a sequence of 2 Ints in the range (minWidth, minHeight) <= (width, height) <= (1280, 1024).

37.6.2

Members

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

37.7

TiffOptions object

The TiffOptions object stores the settings that ABAQUS uses when printing in TIFF format. The TiffOptions object has no constructor. ABAQUS creates the tiffOptions member when a session is started.
Access

session.tiffOptions

37–9

TiffOptions object

37.7.1

setValues(...)

This method modifies the TiffOptions object.
Arguments Required arguments

None.
Optional argument

imageSize A pair of Ints or the SymbolicConstant SIZE_ON_SCREEN specifying the width and height of the image in pixels. Possible values are (minWidth, minHeight) imageSize (1280, 1024). The initial value is SIZE_ON_SCREEN. Note: The minimum value of width and height (minWidth and minHeight) is the number of pixels that occupy 10 mm at the current screen resolution. The value is typically around 50 pixels and may be different for width and height.
Return value

None
Exceptions

RangeError. If either the width or height arguments of imageSize are out of range (where minWidth and minHeight are the number of pixels corresponding to approximately 10 mm for a given display): RangeError: imageSize must be SIZE_ON_SCREEN or a sequence of 2 Ints in the range (minWidth, minHeight) <= (width, height) <= (1280, 1024).

37.7.2

Members

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

37–10

Reinforcement object

38.

Property commands
The Property commands are used to create and manage reinforcements and to assign properties to a part (see also Chapter 38, “Property commands,” and Chapter 40, “Section commands”). The Property commands are methods of a Part object.

38.1

Reinforcement object

The Reinforcement object is used to specify a reinforcement on a part.
Access

import section mdb.models[name].parts[name].reinforcement

38.1.1

Reinforcement(...)

This method creates a Reinforcement object. The only type of reinforcement currently available is a skin.
Path

mdb.models[name].parts[name].Reinforcement
Required arguments

name A String specifying the reinforcement repository key. region A surface to which the reinforcement (skin) is assigned. sectionName A String specifying the name of the section.
Optional arguments

offset A Float specifying the shell offset value. materialOrientation A tuple consisting of a Datum coordinate system, a SymbolicConstant specifying the shell normal direction, and a Float specifying the angle of the additional rotation. Possible values for the SymbolicConstant are AXIS_1, AXIS_2, and AXIS_3. The default value for the tuple is None.

38–1

Reinforcement object

rebarOrientation A tuple consisting of a Datum coordinate system, a SymbolicConstant specifying the shell normal direction, and a Float specifying the angle of the additional rotation. Possible values for the SymbolicConstant are AXIS_1, AXIS_2, and AXIS_3. The default value for the tuple is None.
Return value

A Reinforcement object.
Exceptions

None. RangeError and InvalidNameError.

38.1.2

setValues(...)

This method modifies the Reinforcement object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the Reinforcement method, except for the name argument.
Return value

None
Exceptions

RangeError.

38.1.3
offset

Members

The Reinforcement object has the following members: A Float specifying the shell offset value. sectionName A String specifying the name of the section.

38–2

SectionAssignment object

38.2

SectionAssignment object

The SectionAssignment object is used to specify a section assignment on a part or part instance.
Access

import section mdb.models[name].parts[name].sectionAssignments[i] import odbAccess session.odbs[name].rootAssembly.instances[name].sectionAssignments[i] session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.\ sectionAssignments[i]

38.2.1

SectionAssignment(...)

This method creates a SectionAssignment object.
Path

mdb.models[name].parts[name].SectionAssignment
Required arguments

region A Set object specifying the region to which the section is assigned. sectionName A String specifying the name of the section.
Optional arguments

None.
Return value

A SectionAssignment object.
Exceptions

None.

38.2.2

setValues(...)

This method modifies the SectionAssignment object.

38–3

Property assignment commands

Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the SectionAssignment method.

Return value

None

Exceptions

None.

38.2.3

Members

The SectionAssignment object has members with the same names and descriptions as the arguments to the SectionAssignment method.

38.3

Property assignment commands

The Property assignment commands are used to assign and unassign properties to parts. The part and section modules must be imported to give access to the Property assignment commands.

Access

import part import section

38.3.1

assignBeamSectionOrientation(...)

This method assigns a beam section orientation to a region of a part.

Path

mdb.models[name].parts[name].assignBeamSectionOrientation

38–4

Property assignment commands

Arguments Required arguments

region A sequence of geomSequences of Edge objects or a sequence of sequences of one-dimensional elements. 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 cross-section.
Optional arguments

-direction of the beam

None.
Return value

None
Exceptions

None.

38.3.2

assignMaterialOrientation(...)

This method assigns a material orientation to a region.
Path

mdb.models[name].parts[name].assignMaterialOrientation
Arguments Required argument

region A sequence of geomSequences of Vertex, Edge, Face, and Cell objects or a sequence of sequences of elements. localCsys A Datum object specifying the local coordinate system or None, indicating the global coordinate system.

38–5

Property assignment 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.

38.3.3

assignRebarOrientation(...)

This method assigns a rebar reference orientation to a region.
Path

mdb.models[name].parts[name].assignRebarOrientation
Arguments Required argument

region A sequence of geomSequences of Vertex, Edge, Face, and Cell objects or a sequence of sequences of elements. localCsys A Datum 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.

38–6

Property assignment commands

Return value

None
Exceptions

None.

38.3.4

flipNormal(...)

This method flips the normals of shell or membrane elements of an orphan mesh or of two-dimensional geometric regions.
Path

mdb.models[name].parts[name].flipNormal
Arguments Required argument

regions A sequence of geomSequences of Edge or Face objects or a sequence of sequences of two-dimensional element objects. The elements can be quadrilaterals, triangles, or line elements of axisymmetric parts.
Optional argument

referenceRegion A two-dimensional element object whose normal is to be matched. If unspecified, all the normals associated with the given regions will be flipped. The referenceRegion argument is applicable only if the argument regions contain a sequence of quadrilateral or triangular elements.
Return value

None
Exceptions

None.

38.3.5

flipTangent(...)

This method flips the tangents of beam or truss elements of an orphan mesh or of one-dimensional geometric regions.

38–7

Property assignment commands

Path

mdb.models[name].parts[name].flipTangent
Arguments Required argument

regions A sequence of geomSequences of Edge objects or a sequence of sequences of one-dimensional elements.
Optional arguments

None.
Return value

None
Exceptions

None.

38.3.6

unassignBeamSectionOrientation(...)

This method deletes a beam section orientation assignment.
Path

mdb.models[name].parts[name].unassignBeamSectionOrientation
Arguments Required argument

index An Int specifying the number of the beam section orientation assignment to be deleted.
Optional arguments

None.
Return value

None
Exceptions

None.

38–8

Property assignment commands

38.3.7

unassignMaterialOrientation(...)

This method deletes a material orientation assignment.
Path

mdb.models[name].parts[name].unassignMaterialOrientation
Arguments Required argument

index An Int specifying the number of the material assignment to be deleted.
Optional arguments

None.
Return value

None
Exceptions

None.

38.3.8

unassignRebarOrientation(...)

This method deletes a rebar orientation assignment.
Path

mdb.models[name].parts[name].unassignRebarOrientation
Arguments Required argument

index An Int specifying the number of the rebar reference orientation assignment to be deleted.
Optional arguments

None.
Return value

None

38–9

Property assignment commands

Exceptions

None.

38–10

Assembly object

39.

Region commands
Region commands are used to create part and assembly sets or surfaces from elements, nodes, and geometry. For more information, see “Specifying a region,” Section 6.6 of the ABAQUS Scripting User’s Manual. Part and assembly objects have the following member, a repository of Set objects:

• • • •

sets

In turn, a Set object can contain any one of the following types: elements nodes geometry

A Set object can contain a number of entities of a single type (nodes, elements, or geometry) or a combination of node and element types. However, except for nodes and elements, a Set object cannot contain a combination of types. The following are members of the Set object:

• • • • • • •

nodes elements cells faces edges vertices referencePoints

Region commands are also used to create surfaces on the assembly. Surfaces are sets with additional “sidedness” information. Part sets contain regions of a part. You can assign section definitions to a set created by selecting a region of a part. The part sets can be accessed from the instance; however, the section definition you assigned to a region is copied automatically to all instances of that part in the assembly. Assembly sets contain regions of an assembly and are used by many commands that operate on the assembly. For example, you can apply a load or boundary condition to a set created by selecting a region of the assembly. Sets can include regions from multiple part instances.

39.1

Assembly object

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

39–1

Part object

Access

import regionToolset

39.1.1

clashSets(...)

This command prints a message describing the relationship between the contents of two sets. Possible outcomes are:

• • • • • •

Both sets are the same. Set 2 is a subset of set 1. Set 2 is a superset of set 1. Set 2 intersects set 1. Set 2 touches set 1 (their boundaries intersect). Set 2 and set 1 are disjoint.

This command accepts only positional arguments and has no keywords.
Arguments Required arguments

arg1 A Set or Surface object specifying set 1. arg2 A Set or Surface object specifying set 2.
Optional arguments

None.
Return value

None
Exceptions

None.

39.2

Part object

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

39–2

Region object

Access

import regionToolset

39.2.1

clashSets(...)

This command prints a message describing the relationship between the contents of two sets. Possible outcomes are:

• • • • • •

Both sets are the same. Set 2 is a subset of set 1. Set 2 is a superset of set 1. Set 2 intersects set 1. Set 2 touches set 1 (their boundaries intersect). Set 2 and set 1 are disjoint.

This command accepts only positional arguments and has no keywords.
Arguments Required arguments

arg1 A Set or Surface object specifying set 1. arg2 A Set or Surface object specifying set 2.
Optional arguments

None.
Return value

None
Exceptions

None.

39.3

Region object

The purpose of the Region object is to simplify the syntax of a script that passes a picked region (as opposed to a named region) to a Load, BC, IC, etc. You use a Region object to collect either set-like entities or surface-like entities in the model. Although you can mix both set-like and surface-like regions in a single Region object, the Load, BC, IC, etc. commands will reject a mixed-type region.

39–3

Region object

You use a Region object to identify a region of the model for a Load, BC, IC, etc. without having to specify a named set or surface. Wherever a particular Load, BC, IC, etc. command accepts a named set or a named surface, that command will also accept a Region object. For example, myRegion = regionToolset.Region(edges=edges1) mdb.models['Model-1'].DisplacementBC(name='BC-1', createStepName='Initial', region=myRegion, u1=SET, u2=SET) myRegion = regionToolset.Region(elements=e[1:100]) p = mdb.models['mirror'].parts['COLLAR_MIRROR-1'] p.assignSection(region=myRegion, sectionName='Section-1') ABAQUS does not provide a regions repository; as an alternative, you should assign a variable to a Region object and refer to the variable. The life cycle of a Region object is similar to the life cycle of a Leaf object used by display groups; as a result, you should use a Region object immediately after you create it. The contents of a Region object are not intended to survive regeneration. If you use an out-of-date Region object, the script is unlikely to function correctly.
Access

import regionToolset

39.3.1

Region(...)

This command creates a set-like region. For example, myRegion = regionToolset.Region(vertices=v[2:4], edges=e[4:5]+6:9) The arguments are the same as the arguments to the Set method, except for the name argument. In most cases, the constructor will be called with only one argument of sequences. The arguments xVertices, xEdges, and xFaces are used to exclude lower-dimension entities and to provide finer control on the content of the region. For example, the following statement defines a region enclosing a square face but without two of its edges: region = regionToolset.Region(faces=f[3:4], xEdges=e[1:3])
Path

Region
Required arguments

None.

39–4

Region object

Optional arguments

elements A sequence of Element objects. The default value is None. nodes A sequence of Node objects. The default value is None. vertices A sequence of Vertex objects. The default value is None. edges A sequence of Edge objects. The default value is None. faces A sequence of Face objects. The default value is None. reinforcement A Boolean specifying whether faces refers to the reinforcement faces and not to the underlying faces. The default value is FALSE indicating that faces refers to the underlying faces. cells A sequence of Cell objects. The default value is None. referencePoints A sequence of ReferencePoint objects. The default value is an empty sequence. xVertices A sequence of Vertex objects that excludes specific vertices from the region. The default value is None. xEdges A sequence of Vertex objects that excludes specific edges from the region. The default value is None. xFaces A sequence of Vertex objects that excludes specific faces from the region. The default value is None.
Return value

A Region object.
Exceptions

None.

39.3.2

Region(...)
myRegion = regionToolset.Region(side1Faces=f[12:14])

This command creates a surface-like region. For example,

39–5

Region object

The arguments are the same as the arguments to the Surface method, except for the name argument.
Path

Region
Required arguments

None.
Optional arguments

In most cases, you will provide only one argument of sequences. side1Faces A sequence of Face objects (surface applies to SIDE1 of face). The default value is None. side2Faces A sequence of Face objects (surface applies to SIDE2 of face). The default value is None. side12Faces A sequence of Face objects (surface applies to both SIDE1 and SIDE2 of face). The default value is None. side1Edges A sequence of Edge objects (surface applies to SIDE1 of edge). The default value is None. side2Edges A sequence of Edge objects (surface applies to SIDE2 of edge). The default value is None. end1Edges A sequence of Edge objects (surface applies to END1 of edge). The default value is None. end2Edges A sequence of Edge objects (surface applies to END2 of edge). The default value is None. circumEdges A sequence of Edge objects (surface applies circumferentially to edge). The default value is None. face1Elements A sequence of Element objects (surface applies to FACE1 of element). The default value is None. face2Elements A sequence of Element objects (surface applies to FACE2 of element). The default value is None. face3Elements A sequence of Element objects (surface applies to FACE3 of element). The default value is None. face4Elements A sequence of Element objects (surface applies to FACE4 of element). The default value is None. face5Elements A sequence of Element objects (surface applies to FACE5 of element). The default value is None. face6Elements A sequence of Element objects (surface applies to FACE6 of element). The default value is None.

39–6

Set object

side1Elements A sequence of Element objects (surface applies to SIDE1 of element). The default value is None. side2Elements A sequence of Element objects (surface applies to SIDE2 of element). The default value is None. side12Elements A sequence of Element objects (surface applies to both SIDE1 and SIDE2 of element). The default value is None. end1Elements A sequence of Element objects (surface applies to END1 of element). The default value is None. end2Elements A sequence of Element objects (surface applies to END2 of element). The default value is None. circumElements A sequence of Element objects (surface applies to circumference of element). The default value is None.
Return value

A Region object.
Exceptions

None.

39.3.3

Members

The Region object has no members.

39.4

Set object

If a set spans more than one part instance, the vertex, edge, face, cell, element, and node members return a sequence of sequences for each part instance. Each sequence contains entities from a single instance. For example: assembly=mdb.models['Transmission'].assembly clutchElements=assembly.instances['Clutch'].elements clutchSet=clutchElements[16:18]+clutchElements[78:80] housingElements=assembly.instances['Housing'].elements housingSet=housingElements[45:48] transmissionSet=assembly.Set(name='TransmissionSet', elements=(clutchSet, housingSet)) len(transmissionSet.element)=2

39–7

Set object

transmissionSet.elements[0]=16,17,78,79 transmissionSet.elements[1]=45,46,47
Access

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

39.4.1

Set(...)

This method creates a set from a sequence of objects in a model database.
Path

mdb.models[name].parts[name].Set mdb.models[name].rootAssembly.Set
Required argument

name A String specifying the repository key.
Optional arguments

At least one sequence argument must be provided—elements, nodes, vertices, edges, faces, cells, or referencePoints. The arguments xVertices, xEdges, and xFaces are used to exclude lower-dimension entities and to provide finer control on the content of the set. For example, the following statement defines a region enclosing a square face but without two of its edges: set = mdb.models['Model-1'].rootAssembly.Set( name='mySet', faces=f[3:4], xEdges=e[1:3]) nodes A sequence of MeshNode objects. The default value is None. elements A sequence of MeshElement objects. The default value is None. region A Region object specifying other objects to be included in the set. The default value is None. vertices A sequence of Vertex objects. The default value is None. edges A sequence of Edge objects. The default value is None.

39–8

Set object

faces A sequence of Face objects. The default value is None. cells A sequence of Cell objects. The default value is None. xVertices A sequence of Vertex objects that excludes specific vertices from the set. The default value is None. xEdges A sequence of Edge objects that excludes specific edges from the set. The default value is None. xFaces A sequence of Face objects that excludes specific faces from the set. The default value is None. referencePoints A sequence of ReferencePoint objects. The default value is an empty sequence. reinforcement A Boolean specifying whether faces refers to the reinforcement faces and not to the underlying faces. The default value is FALSE indicating that faces refers to the underlying faces.
Return value

A Set object.
Exceptions

InvalidNameError.

39.4.2

SetByMerge(...)

This method creates a set that is the result of merging two or more sets.
Path

mdb.models[name].parts[name].SetByMerge mdb.models[name].rootAssembly.SetByMerge
Required arguments

name A String specifying the repository key. sets A sequence of Set objects.
Optional arguments

None.

39–9

Set object

Return value

A Set object.
Exceptions

InvalidNameError.

39.4.3

SetFromColor(...)

This method creates a set containing faces of the part marked with a specified color attribute. Third-party applications can assign color attributes to faces, and the color attribute can be imported into ABAQUS from an ACIS file. You can use this method to create sets only on parts; however, you can access the sets from instances of the parts in the assembly.
Path

mdb.models[name].parts[name].SetFromColor
Required arguments

name A String specifying the repository key. color A sequence of three Ints specifying the RGB color. Values can range from 0 to 255. The first integer is for red, the second for green, and the third for blue. For example, a face colored in yellow is identified by: color=(255,255,0)
Optional arguments

None.
Return value

A Set object.
Exceptions

InvalidNameError.

39.4.4

SetFromElementLabels(...)

This method creates a set from a sequence of element labels in a model database.

39–10

Set object

Path

mdb.models[name].parts[name].SetFromElementLabels mdb.models[name].rootAssembly.SetFromElementLabels
Required arguments

name A String specifying the repository key. 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

A Set object.
Exceptions

InvalidNameError.

39.4.5

SetFromNodeLabels(...)

This method creates a set from a sequence of node labels in a model database.
Path

mdb.models[name].parts[name].SetFromNodeLabels mdb.models[name].rootAssembly.SetFromNodeLabels
Required arguments

name A String specifying the repository key. nodeLabels A sequence of node labels. A node label is a sequence of Int node identifiers. For example, for a part:

39–11

Surface object

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

A Set object.
Exceptions

InvalidNameError.

39.4.6

Members

The Set object can have the following members: elements An array of MeshElement objects. nodes An array of MeshNode objects. vertices A VertexArray object. edges An EdgeArray object. faces A FaceArray object. cells A CellArray object. referencePoints An array of ReferencePoint objects.

39.5

Surface object

The Surface object stores surfaces selected from the assembly. A surface is comprised of geometric or discrete entities but not both. An instance of a Surface object is available from the surface member of the Assembly object.

39–12

Surface object

Access

import part mdb.models[name].parts[name].surfaces[name] import assembly mdb.models[name].rootAssembly.allSurfaces[name] mdb.models[name].rootAssembly.instances[name].surfaces[name] mdb.models[name].rootAssembly.surfaces[name]

39.5.1

Surface(...)

This method creates a surface from a sequence of objects in a model database. The surface will apply to the sides specified by the arguments.
Path

mdb.models[name].parts[name].Surface mdb.models[name].rootAssembly.Surface
Required argument

On three-dimensional solid faces, you can use the following arguments:

• • • • • • • • • • • • •

side1Faces side2Faces side1Faces side2Faces side12Faces end1Edges end2Edges circumEdges side1Edges side2Edges face1Elements face2Elements face3Elements

On three-dimensional shell faces, you can use the following arguments:

On three-dimensional wire edges, you can use the following arguments:

On two-dimensional or axisymmetric edges, you can use the following arguments:

On two-dimensional or axisymmetric shell elements, you can use the following arguments:

39–13

Surface object

• • • • • • • • • • • • • • •

face14Elements

On solid elements, you can use the following arguments: face1Elements face2Elements face3Elements face4Elements face5Elements face6Elements

On three-dimensional shell elements, you can use the following arguments: side1Elements side2Elements side12Elements

On three-dimensional wire elements, you can use the following arguments: end1Elements end2Elements circumElements

On two-dimensional or axisymmetric wire elements, you can use the following arguments: side1Elements side2Elements A String specifying the repository key. The default value is an empty string.
Optional arguments

name

side1Elements A sequence of MeshElement objects (surface applies to SIDE1 of element). The default value is None. side2Elements A sequence of MeshElement objects (surface applies to SIDE2 of element). The default value is None. side12Elements A sequence of MeshElement objects (surface applies to both SIDE1 and SIDE2 of element). The default value is None. end1Elements A sequence of MeshElement objects (surface applies to END1 of element). The default value is None.

39–14

Surface object

end2Elements A sequence of MeshElement objects (surface applies to END2 of element). The default value is None. circumElements A sequence of MeshElement objects (surface applies to circumference of element). The default value is None. face1Elements A sequence of MeshElement objects (surface applies to FACE1 of element). The default value is None. face2Elements A sequence of MeshElement objects (surface applies to FACE2 of element). The default value is None. face3Elements A sequence of MeshElement objects (surface applies to FACE3 of element). The default value is None. face4Elements A sequence of MeshElement objects (surface applies to FACE4 of element). The default value is None. face5Elements A sequence of MeshElement objects (surface applies to FACE5 of element). The default value is None. face6Elements A sequence of MeshElement objects (surface applies to FACE6 of element). The default value is None. side1Faces A sequence of Face objects (surface applies to SIDE1 of face). The default value is None. side2Faces A sequence of Face objects (surface applies to SIDE2 of face). The default value is None. side12Faces A sequence of Face objects (surface applies to both SIDE1 and SIDE2 of face). The default value is None. side1Edges A sequence of Edge objects (surface applies to SIDE1 of edge). The default value is None. side2Edges A sequence of Edge objects (surface applies to SIDE2 of edge). The default value is None. end1Edges A sequence of Edge objects (surface applies to END1 of edge). The default value is None. end2Edges A sequence of Edge objects (surface applies to END2 of edge). The default value is None.

39–15

Surface object

circumEdges A sequence of Edge objects (surface applies circumferentially to edge). The default value is None.
Return value

A Surface object.
Exceptions

InvalidNameError.

39.5.2

SurfaceByMerge(...)

This method creates a surface that is the result of merging two or more surfaces.
Path

mdb.models[name].parts[name].SurfaceByMerge mdb.models[name].rootAssembly.SurfaceByMerge
Required arguments

name A String specifying the repository key. surfaces A sequence of Surface objects.
Optional arguments

None.
Return value

A Surface object.
Exceptions

InvalidNameError.

39.5.3

SurfaceFromElsets(...)

This method creates a surface from a sequence of element sets in a model database.
Path

mdb.models[name].rootAssembly.SurfaceFromElsets

39–16

Surface object

Required arguments

name A String specifying the repository key. elementSetSeq A sequence of element sets. For example, elementSetSeq=((elset1, S1),(elset2, S2)) where elset1=mdb.models[name].rootAssembly.sets['Clutch'] and S1 and S2 indicate the side of the element set.
Optional arguments

None.
Return value

A Surface object.
Exceptions

InvalidNameError.

39.5.4
sides

Members

The Surface object can have the following members: A sequence of SymbolicConstants representing the sides; for example, (SIDE1, SIDE2). instances A sequence of Ints specifying the instances. This member is not applicable for a Surface object on an output database. edges An EdgeArray object. face A FaceArray object. elements An array of MeshElement objects. nodes An array of MeshNode objects.

39–17

Section object

40.

Section commands
The Section commands are used to create sections and profiles with their associated properties and behavior. The various section objects are all derived from the Section object. The various profile objects are all derived from the Profile object. See Chapter 38, “Property commands,” for the property assignment commands.

40.1

Section object

The Section object defines the properties of a section. The Section object is the abstract base type for other Section objects. The Section object has no explicit constructor. The methods and members of the Section object are common to all objects derived from the Section.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.1.1

sectionsFromOdb(...)

This method creates Section objects by reading an output database. The new sections are placed in the sections repository.
Path

mdb.models[name].sectionsFromOdb
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 Section objects.

40–1

BeamSection object

Exceptions

None.

40.1.2
name

Members

The Section object has the following member: A String specifying the repository key.

40.2

BeamSection object

The BeamSection object defines the properties of a beam section.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.2.1

BeamSection(...)

This method creates a BeamSection object.
Path

mdb.models[name].BeamSection session.odbs[name].BeamSection
Required arguments

name A String specifying the repository key. profile A String specifying the name of the profile. integration A SymbolicConstant specifying the integration method for the section. Possible values are DURING_ANALYSIS and BEFORE_ANALYSIS.
Optional arguments

poissonRatio A Float specifying the Poisson’s ratio of the section. The default value is 0.0.

40–2

BeamSection object

thermalExpansion A Boolean specifying whether to use thermal expansion data. 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 A sequence of sequences of Floats specifying the items described below. The default value is an empty sequence. density A Float specifying the density of the section. The default value is None. material A String specifying the name of the material. The default value is the empty string. referenceTemperature A Float specifying the reference temperature of the section. The default value is None. temperatureVar A SymbolicConstant specifying the temperature variation for the section. Possible values are LINEAR and INTERPOLATED. The default value is LINEAR. outputPts A sequence of pairs of Floats specifying the positions at which output is requested. The default value is an empty sequence. alphaDamping A Float specifying the factor to create mass proportional damping in direct-integration dynamics. The default value is 0.0. betaDamping A Float specifying the factor to create stiffness proportional damping in direct-integration dynamics. The default value is 0.0. compositeDamping A Float specifying the fraction of critical damping to be used in calculating composite damping factors for the modes (for use in modal dynamics). The default value is 0.0. centroid A pair of Floats specifying the X–Y coordinates of the centroid. The default value is (0.0, 0.0). shearCenter A pair of Floats specifying the X–Y coordinates of the shear center. The default value is (0.0, 0.0). Table data The table data specify the following:

• •

E, the Young’s modulus of the section. G, the torsional shear modulus of the section.

40–3

BeamSection object

• • • • •

Thermal expansion coefficient, if using thermal expansion. 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 BeamSection object.
Exceptions

None.

40.2.2

setValues(...)

This method modifies the BeamSection object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the BeamSection method, except for the name argument.
Return value

None
Exceptions

None.

40.2.3

Members

The BeamSection object has members with the same names and descriptions as the arguments to the BeamSection method. In addition, the BeamSection object can have the following member: beamTransverseShear A TransverseShearBeam object specifying the transverse shear stiffness properties.
40.2.4 Corresponding analysis keywords

*BEAM SECTION *BEAM GENERAL SECTION

40–4

CohesiveSection object

40.3

CohesiveSection object

The CohesiveSection object defines the properties of a cohesive section.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.3.1

CohesiveSection(...)

This method creates a CohesiveSection object.
Path

mdb.models[name].CohesiveSection session.odbs[name].CohesiveSection
Required arguments

name A String specifying the repository key. material A String specifying the name of the material. response A SymbolicConstant specifying the geometric assumption that defines the constitutive behavior of the cohesive elements. Possible values are TRACTION_SEPARATION, CONTINUUM, and GASKET.
Optional arguments

initialThicknessType A SymbolicConstant specifying the method used to compute the initial thickness. Possible values are SOLVER_DEFAULT, GEOMETRY, and SPECIFY. If initialThicknessType=GEOMETRY, ABAQUS computes the thickness from the nodal coordinates of the elements. If initialThicknessType=SPECIFY, ABAQUS uses the value given for initialThickness. If initialThicknessType=SOLVER_DEFAULT, ABAQUS uses the analysis product default. The default value is SOLVER_DEFAULT. initialThickness A Float specifying the initial thickness for the section. The initialThickness argument applies only when initialThicknessType=SPECIFY. The default value is 1.0.

40–5

CompositeShellSection object

outOfPlaneThickness A Float specifying the out-of-plane thickness for the section. The default value is None.
Return value

A CohesiveSection object.
Exceptions

RangeError and InvalidNameError.

40.3.2

setValues(...)

This method modifies the CohesiveSection object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the CohesiveSection method, except for the name argument.
Return value

None
Exceptions

RangeError.

40.3.3

Members

The CohesiveSection object has members with the same names and descriptions as the arguments to the CohesiveSection method.
40.3.4 Corresponding analysis keywords

*COHESIVE SECTION

40.4

CompositeShellSection object
The

The CompositeShellSection object defines the properties of a composite shell section. CompositeShellSection object is derived from the GeometryShellSection object.

40–6

CompositeShellSection object

Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.4.1

CompositeShellSection(...)

This method creates a CompositeShellSection object.
Path

mdb.models[name].CompositeShellSection session.odbs[name].CompositeShellSection
Required arguments

name A String specifying the repository key. layup A list of SectionLayer objects specifying the shell cross-section.
Optional arguments

preIntegrate A Boolean specifying whether the shell section properties are specified by the user prior to the analysis (ON) or integrated during the analysis (OFF). The default value is OFF. poissonDefinition A SymbolicConstant specifying whether to use the default value for the Poisson’s ratio. Possible values are DEFAULT and VALUE. The default value is DEFAULT. If poissonDefinition=DEFAULT, the default value for the Poisson’s ratio is 0.5 in an ABAQUS/Standard analysis and is obtained from the material definition in an ABAQUS/Explicit analysis. poisson A Float specifying the Poisson’s ratio. Possible values are −1.0 poisson 0.5. This argument is valid only when poissonDefinition=VALUE. The default value is 0.5. integrationRule A SymbolicConstant specifying the shell section integration rule. Possible values are SIMPSON and GAUSS. The default value is SIMPSON. temperature A SymbolicConstant specifying the mode used for temperature and field variable input across the section thickness. Possible values are GRADIENT and POINTWISE. The default value is GRADIENT.

40–7

CompositeShellSection object

nTemp An Int specifying the number of temperature points to be input. This argument is valid only when temperature=POINTWISE. The default value is None. thicknessModulus A Float specifying the effective thickness modulus. This argument is relevant only for continuum shells and must be used in conjunction with the argument poisson. The default value is None.
Return value

A CompositeShellSection object.
Exceptions

None.

40.4.2

setValues(...)

This method modifies the CompositeShellSection object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as CompositeShellSection method, except for the name argument.
Return value

the

arguments

to

the

None
Exceptions

None.

40.4.3

Members

The CompositeShellSection object has members with the same names and descriptions as the arguments to the CompositeShellSection method. In addition, the CompositeShellSection object can have the following members: rebarLayers A RebarLayers objects specifying reinforcement properties. transverseShear A TransverseShearShell object specifying the transverse shear stiffness properties.

40–8

GasketSection object

40.4.4

Corresponding analysis keywords

*SHELL SECTION *SHELL GENERAL SECTION

40.5

GasketSection object

The GasketSection object defines the properties of a gasket section.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.5.1

GasketSection(...)

This method creates a GasketSection object.
Path

mdb.models[name].GasketSection session.odbs[name].GasketSection
Required arguments

name A String specifying the repository key. material A String specifying the name of the material of which the gasket is made or material that defines gasket behavior.
Optional arguments

crossSection A Float specifying the cross-sectional area, width, or out-of-plane thickness, if applicable, depending on the gasket element type. The default value is 1.0. initialGap A Float specifying the initial gap. The default value is 0. initialThickness A SymbolicConstant DEFAULT or a Float specifying the initial gasket thickness. If DEFAULT is specified, the initial thickness is determined using nodal coordinates. The default value is DEFAULT.

40–9

GasketSection object

initialVoid A Float specifying the initial void. The default value is 0. stabilizationStiffness A SymbolicConstant DEFAULT or a Float specifying the default stabilization stiffness used in all but link elements to stabilize gasket elements that are not supported at all nodes, such as those that extend outside neighboring components. If DEFAULT is specified, a value is used equal to 10–9 times the initial compressive stiffness in the thickness direction. The default value is DEFAULT.
Return value

A GasketSection object.
Exceptions

InvalidNameError and ValueError.

40.5.2

setValues(...)

This method modifies the GasketSection object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the GasketSection method, except for the name argument.
Return value

None
Exceptions

ValueError.

40.5.3

Members

The GasketSection object has members with the same names and descriptions as the arguments to the GasketSection method.
40.5.4 Corresponding analysis keywords

*GASKET SECTION

40–10

GeometryShellSection object

40.6

GeometryShellSection object

The GeometryShellSection object defines the properties of a geometry shell section. The GeometryShellSection object is derived from the ShellSection object. The GeometryShellSection object has no explicit constructor and no methods. The GeometryShellSection object is an abstract base type.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.6.1

Members

The GeometryShellSection object can have the following members: preIntegrate A Boolean specifying whether the shell section properties are specified by the user prior to the analysis (ON) or integrated during the analysis (OFF). The default value is OFF. poissonDefinition A SymbolicConstant specifying whether to use the default value for the Poisson’s ratio. Possible values are DEFAULT and VALUE. The default value is DEFAULT. If poissonDefinition=DEFAULT, the default value for the Poisson’s ratio is 0.5 in an ABAQUS/Standard analysis and is obtained from the material definition in an ABAQUS/Explicit analysis. poisson A Float specifying the Poisson’s ratio. Possible values are −1.0 poisson is valid only when poissonDefinition=VALUE. The default value is 0.5. 0.5. This argument

integrationRule A SymbolicConstant specifying the shell section integration rule. Possible values are SIMPSON and GAUSS. The default value is SIMPSON. temperature A SymbolicConstant specifying the mode used for temperature and field variable input across the section thickness. Possible values are GRADIENT and POINTWISE. The default value is GRADIENT. nTemp An Int specifying the number of temperature points to be input. This argument is valid only when temperature=POINTWISE. The default value is None.

40–11

HomogeneousShellSection object

thicknessModulus A Float specifying the effective thickness modulus. This argument is relevant only for continuum shells and must be used in conjunction with the argument poisson. The default value is None. rebarLayers A RebarLayers objects specifying reinforcement properties. transverseShear A TransverseShearShell object specifying the transverse shear stiffness properties. name A String specifying the repository key.

40.7

HomogeneousShellSection object
The

The HomogeneousShellSection object defines the properties of a shell section. HomogeneousShellSection object is derived from the GeometryShellSection object.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.7.1

HomogeneousShellSection(...)

This method creates a HomogeneousShellSection object.
Path

mdb.models[name].HomogeneousShellSection session.odbs[name].HomogeneousShellSection
Required arguments

name A String specifying the repository key. thickness A Float specifying the thickness of the section. material A String specifying the name of the section material.

40–12

HomogeneousShellSection object

Optional arguments

preIntegrate A Boolean specifying whether the shell section properties are specified by the user prior to the analysis (ON) or integrated during the analysis (OFF). The default value is OFF. poissonDefinition A SymbolicConstant specifying whether to use the default value for the Poisson’s ratio. Possible values are DEFAULT and VALUE. The default value is DEFAULT. If poissonDefinition=DEFAULT, the default value for the Poisson’s ratio is 0.5 in an ABAQUS/Standard analysis and is obtained from the material definition in an ABAQUS/Explicit analysis. poisson A Float specifying the Poisson’s ratio. Possible values are −1.0 poisson is valid only when poissonDefinition=VALUE. The default value is 0.5. 0.5. This argument

integrationRule A SymbolicConstant specifying the shell section integration rule. Possible values are SIMPSON and GAUSS. The default value is SIMPSON. temperature A SymbolicConstant specifying the mode used for temperature and field variable input across the section thickness. Possible values are GRADIENT and POINTWISE. The default value is GRADIENT. nTemp An Int specifying the number of temperature points to be input. This argument is valid only when temperature=POINTWISE. The default value is None. thicknessModulus A Float specifying the effective thickness modulus. This argument is relevant only for continuum shells and must be used in conjunction with the argument poisson. The default value is None. numIntPts An Int specifying the number of integration points to be used through the section. Possible values are numIntPts 0. The default value is 5 if integrationRule=SIMPSON or 7 if integrationRule=GAUSS.

Return value

A HomogeneousShellSection object.

Exceptions

None.

40–13

HomogeneousSolidSection object

40.7.2

setValues(...)

This method modifies the HomogeneousShellSection object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the HomogeneousShellSection method, except for the name argument.
Return value

arguments

to

the

None
Exceptions

None.

40.7.3

Members

The HomogeneousShellSection object has members with the same names and descriptions as the arguments to the HomogeneousShellSection method. In addition, the HomogeneousShellSection object can have the following members: rebarLayers A RebarLayers objects specifying reinforcement properties. transverseShear A TransverseShearShell object specifying the transverse shear stiffness properties.
40.7.4 Corresponding analysis keywords

*SHELL SECTION *SHELL GENERAL SECTION

40.8

HomogeneousSolidSection object
The

The HomogeneousSolidSection object defines the properties of a solid section. HomogeneousSolidSection object is derived from the SolidSection object.
Access

import section

40–14

HomogeneousSolidSection object

mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.8.1

HomogeneousSolidSection(...)

This method creates a HomogeneousSolidSection object.
Path

mdb.models[name].HomogeneousSolidSection session.odbs[name].HomogeneousSolidSection
Required arguments

name A String specifying the repository key. material A String specifying the name of the material.
Optional argument

thickness A Float specifying the thickness of the section. Possible values are thickness value is 1.0.
Return value

0.0. The default

A HomogeneousSolidSection object.
Exceptions

InvalidNameError and RangeError.

40.8.2

setValues(...)

This method modifies the HomogeneousSolidSection object.
Arguments Required arguments

None.
Optional arguments

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

arguments

to

the

40–15

LayerProperties object

Return value

None
Exceptions

RangeError.

40.8.3

Members

The HomogeneousSolidSection object has members with the same names and descriptions as the arguments to the HomogeneousSolidSection method.
40.8.4 Corresponding analysis keywords

*SOLID SECTION

40.9

LayerProperties object

The LayerProperties object defines the properties of a layer of reinforcement for membrane, shell, and surface sections.
Access

import section mdb.models[name].sections[name].rebarLayers.layerTable[i] import odbSection session.odbs[name].sections[name].rebarLayers.layerTable[i]

40.9.1

LayerProperties(...)

This method creates a LayerProperties object.
Path

section.LayerProperties odbSection.LayerProperties
Required arguments

layerName A String specifying the name of the rebar layer. material A String specifying the name of the rebar material.

40–16

MembraneSection object

barArea A Float specifying the area per bar. orientationAngle A Float or a String specifying the orientation of the rebar. A Float specifies the angular orientation; a String specifies an orientation name.
Optional arguments

barSpacing A Float specifying the spacing of the rebar. This argument is only valid if the rebarSpacing argument on the parent RebarLayers object is set to CONSTANT. The default value is 0.0. layerPosition A Float specifying the position of the rebar from the middle surface of the shell. layerPosition applies only for homogeneous shell sections and composite shell sections. The default value is 0.0. spacingAngle A Float specifying the spacing angle of the rebar. This argument is only valid if the rebarSpacing argument on the parent RebarLayers object is set to ANGULAR. The default value is 0.0.
Return value

A LayerProperties object.
Exceptions

None.

40.9.2

Members

The LayerProperties object has members with the same names and descriptions as the arguments to the LayerProperties method.
40.9.3 Corresponding analysis keywords

*REBAR LAYER

40.10

MembraneSection object

The MembraneSection object defines the properties of a membrane section.
Access

import section mdb.models[name].sections[name]

40–17

MembraneSection object

import odbSection session.odbs[name].sections[name]

40.10.1

MembraneSection(...)

This method creates a MembraneSection object.
Path

mdb.models[name].MembraneSection session.odbs[name].MembraneSection
Required arguments

name A String specifying the repository key. material A String specifying the name of the material.
Optional arguments

thickness A Float specifying the thickness for the section. Possible values are thickness 0.0. The default value is 1.0. poissonDefinition A SymbolicConstant specifying whether to use the default value for the Poisson’s ratio. Possible values are DEFAULT and VALUE. The default value is DEFAULT. If poissonDefinition=DEFAULT, the default value for the Poisson’s ratio is 0.5 in an ABAQUS/Standard analysis and is obtained from the material definition in an ABAQUS/Explicit analysis. poisson A Float specifying the section Poisson’s ratio. Possible values are −1.0 poisson 0.5. This argument is valid only when poissonDefinition=VALUE. The default value is 0.5.
Return value

A MembraneSection object.
Exceptions

RangeError and InvalidNameError.

40.10.2

setValues(...)

This method modifies the MembraneSection object.

40–18

PEGSection object

Arguments Required arguments None. Optional arguments

The optional arguments to setValues are the same as the arguments to the MembraneSection method, except for the name argument.
Return value

None
Exceptions

RangeError.

40.10.3

Members

The MembraneSection object has members with the same names and descriptions as the arguments to the MembraneSection method. In addition, the MembraneSection object can have the following member: rebarLayers A RebarLayers object specifying reinforcement properties.
40.10.4 Corresponding analysis keywords

*MEMBRANE SECTION

40.11

PEGSection object

The PEGSection object defines the properties of a solid section.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.11.1

PEGSection(...)

This method creates a PEGSection object.

40–19

PEGSection object

Path

mdb.models[name].PEGSection session.odbs[name].PEGSection
Required arguments

name A String specifying the repository key. material A String specifying the name of the material.
Optional arguments

thickness A Float specifying the thickness of the section. Possible values are thickness value is 1.0.

0.0. The default

wedgeAngle1 A Float specifying the value of the x component of the angle between the bounding planes, The default value is 0.0. wedgeAngle2 A Float specifying the value of the y component of the angle between the bounding planes, The default value is 0.0.
Return value

.

.

A PEGSection object.
Exceptions

InvalidNameError and RangeError.

40.11.2

setValues(...)

This method modifies the PEGSection object.
Arguments Required arguments

None.
Optional arguments

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

40–20

RebarLayers object

Return value

None
Exceptions

RangeError.

40.11.3

Members

The PEGSection object has members with the same names and descriptions as the arguments to the PEGSection method.
40.11.4 Corresponding analysis keywords

*SOLID SECTION

40.12

RebarLayers object

The RebarLayers object defines the rebar properties of a section.
Access

import section mdb.models[name].sections[name].rebarLayers import odbSection session.odbs[name].sections[name].rebarLayers

40.12.1

RebarLayers(...)

This method creates a RebarLayers object.
Path

mdb.models[name].sections[name].RebarLayers session.odbs[name].sections[name].RebarLayers
Required arguments

rebarSpacing A SymbolicConstant specifying the rebar spacing. Possible values are CONSTANT and ANGULAR. layerTable A list of LayerProperties objects specifying the layers of reinforcement.

40–21

SectionLayer object

Optional arguments

None.
Return value

A RebarLayers object.
Exceptions

None.

40.12.2

setValues(...)

This method modifies the RebarLayers object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the RebarLayers method.
Return value

None
Exceptions

None.

40.12.3

Members

The RebarLayers object has members with the same names and descriptions as the arguments to the RebarLayers method.
40.12.4 Corresponding analysis keywords

*REBAR LAYER

40.13

SectionLayer object

The SectionLayer object defines the material layer in a composite shell.

40–22

SectionLayer object

Access

import section mdb.models[name].sections[name].layup[i] import odbSection session.odbs[name].sections[name].layup[i]

40.13.1

SectionLayer(...)

This method creates a SectionLayer object.
Path

section.SectionLayer odbSection.SectionLayer
Required arguments

material A String specifying the name of the section layer material. thickness A Float specifying the thickness of the section layer. orientAngle A Float or a String specifying the orientation of the section layer. A Float specifies the angular orientation; a String specifies an orientation name.
Optional argument

numIntPts An Int specifying the number of integration points to be used through the section. This argument is valid only if the preIntegrate argument on the parent CompositeShellSection object is set to ON. The default value is 3.
Return value

A SectionLayer object.
Exceptions

None.

40.13.2

Members

The SectionLayer object has members with the same names and descriptions as the arguments to the SectionLayer method.

40–23

SolidSection object

40.13.3

Corresponding analysis keywords

*SHELL SECTION *SHELL GENERAL SECTION

40.14

ShellSection object

The ShellSection object defines the properties of a shell section. The ShellSection object is the abstract base type for other ShellSection objects. The ShellSection object is derived from the Section object. The ShellSection object has no explicit constructor and no methods or members.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.14.1

Members

The ShellSection object can have the following members: transverseShear A TransverseShearShell object specifying the transverse shear stiffness properties. name A String specifying the repository key.

40.15

SolidSection object

The SolidSection object defines the properties of a solid section. The SolidSection object is derived from the Section object. The SolidSection object has no explicit constructor, no members, and no methods. The SolidSection object is an abstract base type.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40–24

SurfaceSection object

40.15.1
name

Members

The SolidSection object has the following member: A String specifying the repository key.

40.16

SurfaceSection object

The SurfaceSection object defines the properties of a surface section.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.16.1

SurfaceSection(...)

This method creates a SurfaceSection object.
Path

mdb.models[name].SurfaceSection session.odbs[name].SurfaceSection
Required argument

name A String specifying the repository key.
Optional arguments

None.
Return value

A SurfaceSection object.
Exceptions

RangeError and InvalidNameError.

40–25

TransverseShearBeam object

40.16.2

Members

The SurfaceSection object has members with the same names and descriptions as the arguments to the SurfaceSection method. In addition, the SurfaceSection object can have the following member: rebarLayers A RebarLayers object specifying reinforcement properties.
40.16.3 Corresponding analysis keywords

*SURFACE SECTION

40.17

TransverseShearBeam object

The TransverseShearBeam object defines the transverse shear stiffness properties of a beam section.
Access

import section mdb.models[name].sections[name].beamTransverseShear import odbSection session.odbs[name].sections[name].beamTransverseShear

40.17.1

TransverseShearBeam(...)

This method creates a TransverseShearBeam object.
Path

mdb.models[name].sections[name].TransverseShearBeam session.odbs[name].sections[name].TransverseShearBeam
Required arguments

k23 A float specifying the k23 shear stiffness of the section. k13 A float specifying the k13 shear stiffness of the section.
Optional arguments

None.
Return value

A TransverseShearBeam object.

40–26

TransverseShearShell object

Exceptions

None.

40.17.2

setValues(...)

This method modifies the TransverseShearBeam object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues TransverseShearBeam method.
Return value

are

the

same

as

the

arguments

to

the

None
Exceptions

None.

40.17.3

Members

The TransverseShearBeam object has members with the same names and descriptions as the arguments to the TransverseShearBeam method.
40.17.4 Corresponding analysis keywords

*TRANSVERSE SHEAR STIFFNESS

40.18

TransverseShearShell object

The TransverseShearShell object defines the transverse shear stiffness properties of a shell section.
Access

import section mdb.models[name].sections[name].transverseShear import odbSection session.odbs[name].sections[name].transverseShear

40–27

TransverseShearShell object

40.18.1

TransverseShearShell(...)

This method creates a TransverseShearShell object.
Path

mdb.models[name].sections[name].TransverseShearShell session.odbs[name].sections[name].TransverseShearShell
Required arguments

k11 A float specifying the shear stiffness of the section in the first direction. k22 A float specifying the shear stiffness of the section in the second direction. k12 A float specifying the coupling term in the shear stiffness of the section.
Optional arguments

None.
Return value

A TransverseShearShell object.
Exceptions

None.

40.18.2

setValues(...)

This method modifies the TransverseShearShell object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues TransverseShearShell method.
Return value

are

the

same

as

the

arguments

to

the

None

40–28

TrussSection object

Exceptions

None.

40.18.3

Members

The TransverseShearShell object has members with the same names and descriptions as the arguments to the TransverseShearShell method.
40.18.4 Corresponding analysis keywords

*TRANSVERSE SHEAR STIFFNESS

40.19

TrussSection object

The TrussSection object defines the properties of a truss section.
Access

import section mdb.models[name].sections[name] import odbSection session.odbs[name].sections[name]

40.19.1

TrussSection(...)

This method creates a TrussSection object.
Path

mdb.models[name].TrussSection session.odbs[name].TrussSection
Required arguments

name A String specifying the repository key. material A String specifying the name of the material. area A Float specifying the cross-sectional area for the section. Possible values are area default value is 1.0. 0. The

40–29

TrussSection object

Optional arguments

None.
Return value

A TrussSection object.
Exceptions

RangeError and InvalidNameError.

40.19.2

setValues(...)

This method modifies the TrussSection object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the TrussSection method, except for the name argument.
Return value

None
Exceptions

RangeError.

40.19.3

Members

The TrussSection object has members with the same names and descriptions as the arguments to the TrussSection method.
40.19.4 Corresponding analysis keywords

*SOLID SECTION

40–30

Session object

41.

Session commands
Session commands are used to create objects that are not stored with the model; for example, viewports and display groups. ABAQUS/CAE retains Session objects only for the duration of the session; they are not saved when the model database is saved.

41.1

Session object

The Session object has no constructor. ABAQUS creates the session member when a session is started.
Access

session

41.1.1

printToFile(...)

This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
Arguments Required argument

fileName A String specifying the file to which the image is to be written. If no file extension is supplied, an extension is added based on the selected image format (.ps, .eps, .png, .tif, or .svg).
Optional arguments

format A SymbolicConstant specifying the image format. Possible values are PS, EPS, PNG, TIFF, and SVG. The default value is PS. canvasObjects A sequence of canvas objects (viewports, text strings, or arrows) to print. The default is to print all canvas objects.
Return value

None
Exceptions

None.

41–1

Session object

41.1.2

printToPrinter(...)

This method prints canvas objects to a Windows printer or to a PostScript printer. The attributes used for printing to a Windows printer are stored in the PrintOptions object and the PageSetupOptions object; the attributes used for printing to a PostScript printer are stored in the PrintOptions object and the PsOptions object.
Arguments Required arguments

None.
Optional arguments

printCommand A String specifying the operating system command or printer name to issue for printing to the printer. The default value is “lpr” or the value specified by the printOptions method. If you create a script to print directly to a Windows printer, the printCommand must take the following form: session.printToPrinter.setValues(printCommand='PRINTER[number of characters in name]:printername PROPERTIES[number of characters in properties: document properties') The PROPERTIES is a list of characters that represents the printing preferences for the selected Windows printer. The properties are not required in a script; the printed output will use the current settings for the selected printer. You can use ’PRINTER[7]: DEFAULT’ to specify the default Windows printer. numCopies An Int specifying the number of copies to print. Possible values are 1 numCopies 100. The default value is 1. canvasObjects A sequence of canvas objects (viewports, text strings, or arrows) to print. The default is to print all canvas objects.
Return value

None
Exceptions

If printCommand is invalid: SystemError: invalid print command If the print command fails: SystemError: print command failed

41–2

Session object

If numCopies is out of range: RangeError: numCopies must be in the range 1 <= value <= 100

41.1.3

saveOptions(...)

This method saves your customized display settings.
Arguments Required arguments

directory A SymbolicConstant specifying the directory in which ABAQUS saves the file that will be used to restore your customized settings (abaqus_v6.gpr). Possible values are HOME and CURRENT.
Optional arguments

None.
Return value

None
Exceptions

None.

41.1.4

writeVrmlFile(...)

This method exports the current viewport objects to a file.
Arguments Required argument

fileName A String specifying the file to which the graphics data is to be written. If no file extension is supplied, an extension is added based on the selected format (.wrl, .wrz).
Optional arguments

format A Boolean specifying the format. Possible values are 0 (Uncompressed) and 1 (Compressed). canvasObjects A sequence of canvas objects (viewports, text strings, or arrows) to export.
Return value

None

41–3

Session object

Exceptions

None.

41.1.5

Members

The Session object can have the following members: attachedToGui A Boolean specifying whether an ABAQUS interactive session is running. currentViewportName A String specifying the name of the current viewport. replayInProgress A Boolean specifying whether ABAQUS is executing a replay file. sessionState A Dictionary specifying the viewports and their associated models. The Dictionary key specifies the viewport name. The Dictionary value is a Dictionary specifying the model name. colors A repository of Color objects. journalOptions A JournalOptions object specifying how to record selection of geometry in the journal and replay files. nodeQuery A NodeQuery object specifying nodes and their coordinates in a path. sketcherOptions A SketcherOptions object specifying sketcher cursor behavior. viewerOptions A ViewerOptions object. aviOptions An AVIOptions object. imageAnimationOptions An ImageAnimationOptions object. quickTimeOptions A QuickTimeOptions object. arrows A repository of Arrow objects. arrowDefaults An ArrowDefaults object. texts A repository of Text objects.

41–4

Session object

textDefaults A TextDefaults object. viewports A repository of Viewport objects. customData A RepositorySupport object. defaultFieldReportOptions A FieldReportOptions object. fieldReportOptions A FieldReportOptions object. odbs A repository of Odb objects. scratchOdbs A repository of ScratchOdb objects. defaultOdbDisplay A DefaultOdbDisplay object. paths A repository of Path objects. currentProbeValues A CurrentProbeValues object. defaultProbeOptions A ProbeOptions object. probeOptions A ProbeOptions object. probeReport A ProbeReport object. defaultProbeReport A ProbeReport object. selectedProbeValues A SelectedProbeValues object. printOptions A PrintOptions object. epsOptions An EpsOptions object. pageSetupOptions A PageSetupOptions object. pngOptions A PngOptions object.

41–5

Color object

psOptions A PsOptions object. svgOptions A SvgOptions object. tiffOptions A TiffOptions object. xyDataObjects A repository of XYData objects. xyPlots A repository of XYPlot objects. defaultXYPlotOptions A XYPlotOptions object. defaultXYReportOptions A XYReportOptions object. xyReportOptions A XYReportOptions object. views A repository of View objects. networkDatabaseConnectors A repository of NetworkDatabaseConnector objects. displayGroups A repository of DisplayGroup objects. graphicsInfo A GraphicsInfo object. defaultGraphicsOptions A GraphicsOptions object. graphicsOptions A GraphicsOptions object. defaultViewportAnnotationOptions A ViewportAnnotationOptions object. queues A repository of Queue objects.

41.2

Color object

The Color object contains the RGB definition of a system color.

41–6

JournalOptions object

Access

session.colors[name]

41.2.1

setByRGB(...)

This method changes the RGB value of a user-defined color. However, users cannot define colors, and this method does not modify system-defined colors.
Arguments Required arguments

rgb A tuple of Floats specifying the new RGB value for the color.
Optional arguments

None.
Return value

None
Exceptions

None.

41.2.2
name

Members

The Color object has the following members: A String specifying the name of the color. rgb A sequence of three Floats specifying the RGB value of the color. The Float values must be between 0.0 and 1.0 .

41.3

JournalOptions object

A JournalOptions object specifies how to record selection of geometry in the journal and replay files. journalOptions can also be used to set the numeric formatting options for field report output, geometry commands output, and a default format for other numeric output. The JournalOptions object has no constructor. ABAQUS creates the journalOptions member when a session is started.

41–7

JournalOptions object

Access

session.journalOptions

41.3.1

setValues(...)

This method modifies the JournalOptions object.
Arguments Required arguments

None.
Optional arguments

replayGeometry A SymbolicConstant specifying the format of the geometry in the replay file. Possible values are COORDINATE and INDEX. The default value is INDEX. recoverGeometry A SymbolicConstant specifying the format of the geometry in the recovery file. Possible values are COORDINATE and INDEX. The default value is INDEX. defaultFormat A NumberFormat object specifying the default format for numeric output. The default values are the same as the default values for the NumberFormat object. fieldReportFormat A NumberFormat object specifying the default format for numbers in a field report output. The default values are the same as the default values for the NumberFormat object. geometryFormat A NumberFormat object specifying the default format for numbers in geometry commands output. The default values are the same as the default values for the NumberFormat object.
Return value

None
Exceptions

None.

41.3.2

Members

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

41–8

NetworkDatabaseConnector object

41.4

NetworkDatabaseConnector object

The NetworkDatabaseConnector object allows you to access an output database on a remote system.
Access

session.networkDatabaseConnectors[name]

41.4.1

NetworkDatabaseConnector(...)

This method creates a NetworkDatabaseConnector object that you can use to access a remote output database. You can create a network database connector from any platform: Windows, UNIX, or Linux. However, the network database connector server must reside on a UNIX or Linux platform; you cannot access an output database that resides on a remote Windows system. You can access only a remote output database; you cannot access a remote model database.
Path

session.NetworkDatabaseConnector
Required arguments

name A String specifying the repository key. hostName A String specifying the name of the remote computer. directory A String specifying the directory on the remote computer.
Optional arguments

remoteAbaqusDriverName A String specifying the name of command to execute ABAQUS/CAE on the remote computer. remoteLoginMechanism A SymbolicConstant specifying the remote shell command on the local system. Possible values are RSH and SSH. The default value is RSH. sshPath A String specifying the path to the ssh command on the local system. The default value is the empty string. serverPort An Int specifying the server port on the remote computer. The default value of 0 allows the host and remote systems to establish their own port numbers.

41–9

NetworkDatabaseConnector object

connectionPort An Int specifying the connection port on the remote computer. The default value is 0. serverTimeout An Int specifying the timeout in seconds for the remote server. The server exits if it does not receive any communication from the client during the time specified. The default value is 86400 (one day). allowAutomaticStartup A Boolean specifying whether to start the remote network database connector server. The default value is TRUE.
Return value

A NetworkDatabaseConnector object.
Exceptions

None.

41.4.2

start(...)

This method starts the remote network database connector server on the remote host.
Arguments Required arguments

None.
Optional arguments

serverPort An Int specifying the server port on the remote computer. The default value of 0 allows the host and remote systems to establish their own port numbers. serverTimeout An Int specifying the timeout in seconds for the remote server. The server exits if it does not receive any communication from the client during the time specified. The default value is 86400 (one day).
Return value

None
Exceptions

None.

41–10

NetworkDatabaseConnector object

41.4.3

stop()

This method stops the remote network database connector server on the remote host.
Arguments

None.
Return value

None
Exceptions

None.

41.4.4

setValues(...)

This method modifies the NetworkDatabaseConnector object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the NetworkDatabaseConnector method, except for the name argument.
Return value

arguments

to

the

None
Exceptions

None.

41.4.5

Members

The NetworkDatabaseConnector object has members with the same names and descriptions as the arguments to the NetworkDatabaseConnector method. In addition, the NetworkDatabaseConnector object has the following member: connected A Boolean specifying if the connection between the client and the server is established.

41–11

NumberFormat object

41.5

NumberFormat object

TheNumberFormat object is a formatting template used to define formatting options for certain numeric output.

41.5.1

NumberFormat(...)

This method creates a NumberFormat object.

Path

NumberFormat
Required arguments

None.
Optional arguments

blankPad A Boolean specifying whether the printed digits should be padded with blank characters to ensure equal sized fields. The blankPad argument is useful when your printed output includes columns. The default value is ON. format A SymbolicConstant specifying the formatting type. Possible values are ENGINEERING, SCIENTIFIC, and AUTOMATIC. The default value is ENGINEERING. numDigits An Int specifying the number of digits to be displayed in the result. numDigits value is 6. . The default

precision An Int specifying the number of decimal places to which the number is to be truncated for display. precision . The default value is 0, indicating that no truncation is applied.

Return value

A NumberFormat object.

Exceptions

None.

41–12

NumberFormat object

41.5.2

Members

The NumberFormat object has members with the same names and descriptions as the arguments to the NumberFormat method.

41–13

Sketch object

42.
42.1

Sketcher commands
Sketch object

A Sketch object contains the entities that are used to create a sketch. The objects of most interest are Geometry objects. Line, Arc, Circle, Fillet, Spline, and other objects are derived from the Geometry object and are contained in the geometry repository.
Access

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

42.1.1

Print()
the sketch Id (a positive integer), the number of geometry curves, the number of dimensions, the number of vertices, and the number of interesting points.

This method prints the following statistics about a sketch:

• • • • •

Path

mdb.models[name].Print
Arguments

None.
Return value

None
Exceptions

None.

42.1.2

Sketch(...)

This method creates a Sketch object.

42–1

Sketch object

Path

mdb.models[name].Sketch
Required arguments

name A String specifying the repository key. sheetSize A Float specifying the sheet size.
Optional arguments

gridSpacing A Float specifying the spacing between grid lines. Possible values are Floats 0. The default value is approximately 2 percent of sheetSize. transform A sequence of sequences of Floats specifying the three-dimensional orientation of the sketch. The sequence is a 3 × 4 transformation matrix specifying the axis of rotation and the translation vector. Possible values are any Floats. The default value for the axis of rotation is the identity matrix (1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, 1.0) The default value for the translation vector is (0.0, 0.0, 0.0) The default values position the sketch on the X–Y plane centered at the origin.
Return value

A Sketch object (None if the Sketch cannot be created).
Exceptions

None.

42.1.3

Sketch(...)

This method copies one Sketch object to a new Sketch object. Note: If the name of the sketch to be copied is __edit__, ABAQUS creates an exact copy that contains both reference geometry and a non-identity transform matrix. Otherwise, the Sketch copy constructor

42–2

Sketch object

strips the reference geometry from the copied sketch and sets the transform matrix to identity, creating a standalone copy.
Path

mdb.models[name].Sketch
Required arguments

name A String specifying the repository key. objectToCopy A Sketch object to be copied.
Optional arguments

None.
Return value

A Sketch object (None if the Sketch cannot be copied).
Exceptions

InvalidNameError.

42.1.4

SketchFromGeometryFile(...)

This method creates a Sketch object and places it in the sketches repository.
Path

mdb.models[name].SketchFromGeometryFile
Required arguments

name A String specifying the repository key. geometryFile An AcisFile object specifying a file containing geometry. The geometry in the file is converted to two-dimensional sketch geometry in the X–Y plane.
Optional arguments

None.
Return value

A Sketch object.

42–3

Sketch object

Exceptions

InvalidNameError.

42.1.5

assignCenterline(...)

This method identifies the construction line to be used as a centerline for revolved features.
Arguments Required argument

line A SketchGeometry object specifying a construction line that indicates the centerline revolved features.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.6

assignCenterOfTwist(...)

This method defines the isolated point to be used as the center of twist when an extruded feature is created with twist.
Arguments Required argument

point A Vertex object specifying an isolated point that indicates the center of twist for extruded features that use a twist angle.
Optional arguments

None.
Return value

None

42–4

Sketch object

Exceptions

None.

42.1.7

autoTrimCurve(...)

This method automatically trims a selected Geometry object at the specified location. If the object does not intersect other Geometry objects, the entire selected object will be deleted.
Arguments Required arguments

curve The Geometry object to be trimmed. parameter A Float specifying the location on curve where the trimming should be applied. This should be a normalized parameter.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.8

breakCurve(...)

This method breaks a selected Geometry object using another selected Geometry object. If both the selected Geometry objects intersect, both will be broken. The location for the break is determined by the specified parameter values.
Arguments Required arguments

curve1 The Geometry object to be broken. parameter1 A Float specifying the location near where curve1 should be broken. This should be a normalized parameter.

42–5

Sketch object

curve2 The Geometry object that defines where curve1 should be broken; curve2 is also broken if actual intersection exists between curve1 and curve2. parameter2 A Float specifying the location on curve2 near where curve1 should be broken. This should be a normalized parameter.
Optional arguments

None.

Return value

None

Exceptions

None.

42.1.9

setFilletRadius(...)

This method modifies the radius of the fillet arc.
Arguments Required arguments

curve A Geometry object specifying the fillet arc. radius A Float specifying the radius. Possible values are Floats > 0.
Optional arguments

None.

Return value

None

Exceptions

None.

42–6

Sketch object

42.1.10

changeDimension(...)

This method changes the value of a Dimension object and moves the corresponding Vertex objects by the vector computed by subtracting the old dimension value from the new one and taking into account the dimension type (e.g., HORIZONTAL).
Arguments Required arguments

dimension A Dimension object specifying the dimension to be changed. value A Float specifying the new dimension value.
Optional argument

vertexList A sequence of Vertex objects to be moved. The vertexList argument can be omitted only if dimension is of type RADIAL.
Return value

None
Exceptions

None.

42.1.11

constraintReferences(...)

This method creates a placement constraint between one or two vertices on the sketch and the reference geometry. The placement constraint determines the relative position between the sketch and the model and how the sketch is repositioned when the model is modified and regenerated.
Arguments Required argument

vertex1 A Vertex object specifying the first constraining point.
Optional argument

vertex2 A Vertex object specifying the second constraining point.

42–7

Sketch object

Return value

None
Exceptions

None.

42.1.12

copyMirror(...)

This method creates copies of the given Geometry objects, mirrors them about a selected line, and inserts them into the Sketch object’s appropriate repositories.
Arguments Required arguments

mirrorLine A Line object about which mirroring will be carried out. objectList A sequence of Geometry objects to be copied and mirrored.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.13

copyMove(...)

This method creates copies of the given Geometry objects, moves them from their original position, and inserts them into the Sketch object’s appropriate repositories.
Arguments Required arguments

vector A sequence of sequences of two Floats specifying the translation vector. objectList A sequence of Geometry objects to be copied and moved.

42–8

Sketch object

Optional arguments None. Return value

None
Exceptions

None.

42.1.14

copyRotate(...)

This method creates copies of the given Geometry objects, rotates them, and inserts them into the Sketch object’s appropriate repositories.
Arguments Required arguments

centerPoint A pair of Floats specifying the center of rotation. angle A Float specifying the angle of rotation in degrees. objectList A sequence of Geometry objects to be copied and moved.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.15

copyScale(...)

This method creates copies of the given Geometry objects, scales them by the specified value about a selected point, and inserts them into the Sketch object’s appropriate repositories.

42–9

Sketch object

Arguments Required arguments

scaleValue A Float specifying the value for scaling. scaleCenter A pair of Floats specifying the center of scaling. objectList A sequence of Geometry objects to be copied and scaled.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.16

delete(...)

This method deletes the given Geometry or Dimension objects.
Arguments Required argument

objectList A sequence of Geometry or Dimension objects to be deleted.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.17

linearPattern(...)

This method copies Geometry objects in a linear pattern along one or two directions.

42–10

Sketch object

Arguments Required arguments objectList A sequence of Geometry objects to copy. number1 An Int specifying the total number of copies, including the original objects, that appear along the first direction in the pattern. Possible values are 1 number1 1000. spacing1 A Float specifying the spacing between copies along the first direction in the pattern. Possible values are 0.0 spacing1. angle1 A Float specifying the angle in degrees of the first direction in the pattern. Possible values are –360.0 angle1 360.0. Optional arguments

number2 An Int specifying the total number of copies, including the original objects, that appear along the second direction in the pattern. Possible values are 1 number2 1000. The default value is 1. The value of either number1 or number2 must be greater than one. spacing2 A Float specifying the spacing between copies along the first direction in the pattern. Possible values are 0.0 spacing2 . The default value is spacing1. angle2 A Float specifying the angle in degrees of the first direction in the pattern. Possible values are –360.0 angle2 360.0. The default value is 90° beyond the value of angle1.
Return value

None
Exceptions

AbaqusError Number must be greater than 1 for at least one direction

42.1.18

mergeVertices(...)

This method merges the Vertex objects that lie within the specified distance of each other. If only one Vertex object is selected, it will merge all Vertex objects that lie within the specified distance of that vertex. If more than one vertex is selected, the search will be restricted to only the selected Vertex objects.

42–11

Sketch object

Arguments Required arguments

value A Float specifying the search radius. vertexList A sequence of Vertex objects to be merged.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.19

mirrorVertices(...)

This method moves the given Vertex objects by mirroring them about a selected line.
Arguments Required arguments

mirrorLine A Line object about which mirroring will be carried out. vertexList A sequence of Vertex objects to be mirrored.
Optional arguments

None.
Return value

None
Exceptions

None.

42–12

Sketch object

42.1.20

moveVertices(...)

This method moves the given Vertex objects by offsetting them from their original coordinates by a given vector.
Arguments Required arguments

vector A sequence of sequences of two Floats specifying the offset vector. vertexList A sequence of Vertex objects to be moved.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.21

offIPs()

This method turns off the calculation of InterestingPoint objects on the sketch; for example, at the intersection of curves. When creating many new entities on a sketch, this method may be used to speed up the creation process.
Arguments

None.
Return value

None
Exceptions

None.

42–13

Sketch object

42.1.22

offset(...)

This method creates copies of the selected Geometry objects, offsets them by the specified distance in the specified direction, and inserts them into the Sketch object’s appropriate repositories. If connected objects are selected, trim or extend is carried out to complete the offset.
Arguments Required arguments

distance A Float indicating the distance to be offset. objectList A sequence of Geometry objects to be copied and offset. side A SymbolicConstant specifying which side the offset should occur. Possible values are LEFT and RIGHT.
Optional argument

filletCorners A Bool indicating whether the corners need to be rounded instead of being extended.
Return value

None
Exceptions

None.

42.1.23

onIPs()

This method turns on the calculation of InterestingPoint objects on the sketch after it has been turned off.
Arguments

None.
Return value

None
Exceptions

None.

42–14

Sketch object

42.1.24

radialPattern(...)

This method copies Geometry objects in a radial pattern about a specified center point.
Arguments Required arguments

objectList A sequence of Geometry objects to copy. number An Int specifying the total number of copies, including the original objects, that appear in the radial pattern. Possible values are 2 number2 1000. 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. centerPoint A pair of Floats specifying the center of the radial pattern.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.25

resetView()

This method resets the view to be perpendicular to the sketching plane.
Arguments

None.
Return value

None

42–15

Sketch object

Exceptions

None.

42.1.26

rectangle(...)

This method creates four Line objects that form a rectangle with diagonal corners defined by the given points and inserts them into the Sketch object’s geometry repository.
Arguments Required arguments

point1 A pair of Floats specifying the first corner of the rectangle. point2 A pair of Floats specifying the second corner of the rectangle.
Optional arguments

None.
Return value

An Int specifying the success or failure of the method. A value of 0 indicates failure.
Exceptions

None.

42.1.27

retrieveSketch(...)

This method copies all Geometry and Dimension objects from the given Sketch object to another Sketch object. The new Geometry and Dimension objects are added to the existing ones (if any); none of the objects in the Sketch object are effected by the retrieve operation.
Arguments Required argument

sketch A Sketch object.
Optional arguments

None.

42–16

Sketch object

Return value

None
Exceptions

None.

42.1.28

rotateVertices(...)

This method rotates the given Vertex objects by the given angle and about the given point.
Arguments Required arguments

centerPoint A pair of Floats specifying the center of rotation. angle A Float specifying the angle of rotation in degrees. vertexList A sequence of Vertex objects to be moved.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.29

scaleVertices(...)

This method scales the given Vertex objects by the given scale factor and about the given point.
Arguments Required arguments

scaleValue A Float specifying the value of scale. scaleCenter A pair of Floats specifying the center of scale.

42–17

Sketch object

vertexList A sequence of Vertex objects to be scaled.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.30

setPrimaryObject(...)

This method makes the Sketch object the primary object in the current viewport. The sketch remains the primary object in the current viewport until an unsetPrimaryobject command is issued.
Arguments Required argument

option A SymbolicConstant specifying how the sketch is displayed. Possible values are:

• •

STANDALONE: Indicates a new stand-alone sketch. The current viewport is cleared and is replaced by the stand-alone sketch. The view direction is set to − . SUPERIMPOSE: Indicates that the sketch is superimposed on the current viewport. The view direction is changed to be perpendicular to the sketch plane. The change is effected smoothly as an animated sequence of many small viewing steps.

Optional arguments

None.
Return value

None
Exceptions

None.

42.1.31

trimExtendCurve(...)

This method trims or extends a selected Geometry object using another selected Geometry object. After the trim or extend operation if the first Geometry object intersects the second Geometry object, the second

42–18

Sketch object

Geometry object will be broken at the intersection. Trim or extend occurs at the candidate location closest to the specified parameter value.
Arguments Required arguments

curve1 The Geometry object to be trimmed or extended. parameter1 A Float specifying the location on curve1 where trim or extend should be applied. This should be a normalized parameter. curve2 The Geometry object to which curve1 is trimmed or extended. curve2 is not trimmed or extended. However, if curve1 intersects curve2 after the trim or extend operation, curve2 will be broken at the intersection parameter2 A Float specifying the location on curve2 near where curve1 should be trimmed or extended. This should be a normalized parameter.
Optional arguments

None.
Return value

None
Exceptions

None.

42.1.32

undo()

This method undoes the effects of the last Sketch object method.
Arguments

None.
Return value

None
Exceptions

None.

42–19

Sketch object

42.1.33

unsetPrimaryObject()

This method removes the Sketch object from the current viewport, reversing the effects of the setPrimaryobject command. If the option argument was set to SUPERIMPOSE, the viewport will be returned to the view orientation that was in place when the setPrimaryobject command was issued. If the option argument was set to STANDALONE, the viewport will be left empty.
Arguments

None.
Return value

None
Exceptions

None.

42.1.34

writeAcisFile(...)

This method exports the geometry of the sketch to a named file in ACIS format.
Arguments Required argument

fileName A String specifying the file name.
Optional argument

version A Float that corresponds to the ACIS version. For example, the float ’4.2’ corresponds to ACIS version 4.2. The default value is the current version of ACIS.
Return value

None
Exceptions

InvalidNameError.

42.1.35

writeIgesFile(...)

This method exports the geometry of the sketch to a named file in IGES format.

42–20

Sketch object

Arguments Required argument

filename A String specifying the file name.
Optional argument

flavor A SymbolicConstant specifying a particular flavor of IGES to export. STANDARD, AUTOCAD, SOLIDWORKS, JAMA, and MSBO.
Return value

Possible values are

None
Exceptions

InvalidNameError.

42.1.36

Members

The Sketch object can have the following members: numGeoms An Int specifying the number of objects in geometry. numVertices An Int specifying the number of objects in vertex. dimensions An array of SketchDimension objects. geometry An array of SketchGeometry objects (lines, arcs, circles, and splines). referenceGeometry An array of SketchGeometry objects. referenceVertices An array of Vertex objects. sketchOptions A SketchOptions object indicating the sketch option settings. vertices An array of Vertex objects.

42–21

SketchDimension object

42.2

SketchDimension object

The SketchDimension object stores the dimensions associated with a sketch.
Access

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

42.2.1

AngularDimension(...)

This method constructs a Dimension object of type ANGULAR between two Geometry objects, with dimension text. An angular dimension indicates the angle in degrees between any two lines, measured in a counterclockwise direction.
Path

mdb.models[name].sketches[name].AngularDimension
Required arguments

line1 A Geometry object specifying the first line. line2 A Geometry object specifying the second line. textPoint A pair of Floats specifying the location of the dimension text.
Optional arguments

None.
Return value

A SketchDimension object (None if the dimension cannot be created).
Exceptions

None.

42.2.2

HorizontalDimension(...)

This method constructs a Dimension object of type HORIZONTAL between two vertices, with dimension text. A horizontal dimension indicates the horizontal distance along the X-axis between two vertices.

42–22

SketchDimension object

Path

mdb.models[name].sketches[name].HorizontalDimension
Required arguments

vertex1 A Vertex object specifying the first endpoint. vertex2 A Vertex object specifying the second endpoint. textPoint A pair of Floats specifying the location of the dimension text.
Optional arguments

None.
Return value

A SketchDimension object (None if the dimension cannot be created).
Exceptions

None.

42.2.3

ObliqueDimension(...)

This method constructs a Dimension object of type OBLIQUE between two vertices, with dimension text. An oblique dimension indicates the distance between two vertices.
Path

mdb.models[name].sketches[name].ObliqueDimension
Required arguments

vertex1 A Vertex object specifying the first endpoint. vertex2 A Vertex object specifying the second endpoint. textPoint A pair of Floats specifying the location of the dimension text.
Optional arguments

None.

42–23

SketchDimension object

Return value

A SketchDimension object (None if the dimension cannot be created).
Exceptions

None.

42.2.4

RadialDimension(...)

This method constructs a Dimension object of type RADIAL on a circular arc, with dimension text. A radial dimension indicates the radius of an arc or circle.
Path

mdb.models[name].sketches[name].RadialDimension
Required arguments

curve A Geometry object specifying the circular arc. textPoint A pair of Floats specifying the location of the dimension text.
Optional arguments

None.
Return value

A SketchDimension object (None if the dimension cannot be created).
Exceptions

None.

42.2.5

VerticalDimension(...)

This method constructs a Dimension object of type VERTICAL between two vertices, with dimension text. A vertical dimension indicates the vertical distance along the Y-axis between two vertices.
Path

mdb.models[name].sketches[name].VerticalDimension

42–24

SketchGeometry object

Required arguments

vertex1 A Vertex object specifying the first endpoint. vertex2 A Vertex object specifying the second endpoint. textPoint A pair of Floats specifying the location of the dimension text.
Optional arguments

None.
Return value

A SketchDimension object (None if the dimension cannot be created).
Exceptions

None.

42.2.6

Members

The SketchDimension object has no members.

42.3

SketchGeometry object

The SketchGeometry object stores the geometry of a sketch, such as lines, circles, arcs, and construction lines.
Access

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

42.3.1

Arc3Points(...)

This method constructs an arc using a two endpoints and an intermediate third point on the arc.
Path

mdb.models[name].sketches[name].Arc3Pointss

42–25

SketchGeometry object

Required arguments

point1 A pair of Floats specifying the first endpoint of the arc. point2 A pair of Floats specifying the second endpoint of the arc. point3 A pair of Floats specifying the third point on the arc.
Optional arguments

None.
Return value

A SketchGeometry object (None if the arc cannot be created).
Exceptions

If incompatible data are given, the second endpoint is ignored.

42.3.2

ArcByCenterEnds(...)

This method constructs an arc using a center point and two vertices. The Arc object is added to the geometry repository of the Sketch object. The arc is created in a clockwise fashion from point1 to point2.
Path

mdb.models[name].sketches[name].ArcByCenterEnds
Required arguments

center A pair of Floats specifying the center point of the arc. point1 A pair of Floats specifying the first endpoint of the arc. point2 A pair of Floats specifying the second endpoint of the arc.
Optional arguments

None.
Return value

A SketchGeometry object (None if the arc cannot be created).

42–26

SketchGeometry object

Exceptions

If incompatible data are given, the second endpoint is ignored.

42.3.3

ArcByStartEndTangent(...)

This method constructs an arc using two vertices. The Arc object is added to the geometry repository of the Sketch object.
Path

mdb.models[name].sketches[name].ArcByStartEndTangent
Required arguments

point1 A pair of Floats specifying the first endpoint of the arc. point2 A pair of Floats specifying the second endpoint of the arc. vector A sequence of sequences of two Floats specifying the start direction for constructing the arc.
Optional arguments

None.
Return value

A SketchGeometry object (None if the arc cannot be created).
Exceptions

None.

42.3.4

CircleByCenterPerimeter(...)

This method constructs a circle using a center point and a point on the perimeter. The Circle object is added to the geometry repository of the Sketch object.
Path

mdb.models[name].sketches[name].CircleByCenterPerimeter
Required arguments

center A pair of Floats specifying the center point of the circle.

42–27

SketchGeometry object

point1 A pair of Floats specifying a point on the perimeter of the circle.
Optional arguments

None.
Return value

A SketchGeometry object (None if the circle cannot be created).
Exceptions

None.

42.3.5

ConstructionCircleByCenterPerimeter(...)

This method constructs a construction circle using a center point and a point on the perimeter. The Circle object is added to the geometry repository of the Sketch object.
Path

mdb.models[name].sketches[name].ConstructionCircleByCenterPerimeter
Required arguments

center A pair of Floats specifying the center point of the construction circle. point1 A pair of Floats specifying a point on the perimeter of the construction circle.
Optional arguments

None.
Return value

A SketchGeometry object (None if the circle cannot be created).
Exceptions

None.

42.3.6

EllipseByCenterPerimeter(...)

This method constructs an ellipse using a center point, a major axis point, and a minor axis point. The Ellipse object is added to the geometry repository of the Sketch object.

42–28

SketchGeometry object

Path

mdb.models[name].sketches[name].EllipseByCenterPerimeter
Required arguments

center A pair of Floats specifying the center point of the ellipse. axisPoint1 A pair of Floats specifying the major or minor axis point of the ellipse. axisPoint2 A pair of Floats specifying the minor or major axis point of the ellipse.
Optional arguments

None.
Return value

A SketchGeometry object (None if the ellipse cannot be created).
Exceptions

None.

42.3.7

FilletByRadius(...)

This method constructs a fillet arc of a given radius between two curves. The Fillet object is added to the geometry repository of the Sketch object.
Path

mdb.models[name].sketches[name].FilletByRadius
Required arguments

radius A Float specifying the radius of the fillet arc. Possible values are Floats > 0. curve1 A Geometry object specifying the first curve. nearPoint1 A pair of Floats specifying a point on the sketch near where the user wishes the fillet to intersect with curve1. This point does not need to be on curve1; it is used as a hint to draw the fillet. curve2 A Geometry object specifying the second curve.

42–29

SketchGeometry object

nearPoint2 A pair of Floats specifying a point on the sketch near where the user wishes the fillet to intersect with curve2. This point does not need to be on curve2; it is used as a hint to draw the fillet.
Optional arguments

None.
Return value

A SketchGeometry object (None if the fillet cannot be created).
Exceptions

If the radius given cannot be used to create a fillet between the two curves given: Range Error: cannot construct the Fillet specified

42.3.8

AngularConstructionLine(...)

This method creates an oblique construction line that runs through a given point at a given angle to the horizontal.
Path

mdb.models[name].sketches[name].AngularConstructionLine
Required arguments

point A pair of Floats specifying a point on the line. angle A Float specifying the angle between the horizontal and the line.
Optional arguments

None.
Return value

A SketchGeometry object (None if the line cannot be created).
Exceptions

None.

42.3.9

Line(...)

This method creates a line between two given points.

42–30

SketchGeometry object

Path

mdb.models[name].sketches[name].Line
Required arguments

point1 A pair of Floats specifying the first endpoint. point2 A pair of Floats specifying the second endpoint.
Optional arguments

None.
Return value

A SketchGeometry object (None if the line cannot be created).
Exceptions

None.

42.3.10

HorizontalConstructionLine(...)

This method creates a horizontal construction line that runs through a given point.
Path

mdb.models[name].sketches[name].HorizontalConstructionLine
Required argument

point A pair of Floats specifying a point on the line.
Optional arguments

None.
Return value

A SketchGeometry object (None if the line cannot be created).
Exceptions

None.

42–31

SketchGeometry object

42.3.11

ObliqueConstructionLine(...)

This method creates an oblique construction line that runs between two given points.
Path

mdb.models[name].sketches[name].ObliqueConstructionLine
Required arguments

point1 A pair of Floats specifying the first endpoint. point2 A pair of Floats specifying the second endpoint.
Optional arguments

None.
Return value

A SketchGeometry object (None if the line cannot be created).
Exceptions

None.

42.3.12

VerticalConstructionLine(...)

This method creates a vertical construction line that runs through a given point.
Path

mdb.models[name].sketches[name].VerticalConstructionLine
Required argument

point A pair of Floats specifying a point on the line.
Optional arguments

None.
Return value

A SketchGeometry object (None if the line cannot be created).

42–32

SketchGeometry object

Exceptions

None.

42.3.13

Spline(...)

This method creates a spline curve running through a sequence of points. The Spline object is added to the geometry repository of the Sketch object.
Path

mdb.models[name].sketches[name].Spline
Required argument

points A sequence of sequences of two Floats specifying the points through which the spline passes.
Optional arguments

None.
Return value

A SketchGeometry object (None if the spline cannot be created).
Exceptions

None.

42.3.14

Spot(...)

This method creates a spot construction point located at the specified coordinates. The Spot object is added to the geometry repository of the Sketch object.
Path

mdb.models[name].sketches[name].Spot
Required argument

point A pair of Floats specifying the coordinates of the spot construction point.
Optional arguments

None.

42–33

SketchOptions object

Return value

A SketchGeometry object (None if the spot cannot be created).
Exceptions

None.

42.3.15

Members

The SketchGeometry object has no members.

42.4

SketchOptions object

The SketchOptions object is used to store values and attributes associated with a particular sketch. The SketchOptions object has no constructor.
Access

import sketch mdb.models[name].sketches[name].sketchOptions

42.4.1

setValues(...)

This method modifies the SketchOptions object.
Arguments Required arguments

None.
Optional arguments

sheetSize A Float specifying the sheet size. Possible values are Floats specified with the Sketch method.

0. The initial value is the sheetSize

gridSpacing A Float specifying the spacing between grid lines. Possible values are Floats is approximately 2.5% of sheetSize. grid A Boolean specifying whether the grid is shown. The initial value is ON.

0. The initial value

42–34

SketchOptions object

gridFrequency An Int specifying how often grid lines are shown. Possible values are gridFrequency initial value is 1. dimensionTextHeight A Float specifying the height of the dimension text in points. Possible values are Floats initial value is 12.

0. The

0. The

decimalPlaces An Int specifying how many decimal places are shown in dimensions. Possible values are 0 decimalPlaces 6. The initial value depends on the value of sheetSize. constructionGeometry A Boolean specifying whether construction geometry is shown. The initial value is ON. gridSnap A Boolean specifying whether the cursor snaps to the grid. The initial value is ON. preselection A Boolean specifying whether geometry will be preselected. The initial value is ON. gridOrigin A sequence of Floats specifying the X–Y coordinates for the origin of the grid. The default value is (0.0, 0.0). gridAngle A Float specifying the angle of the grid relative to the computer screen. The default value is 0.0. viewStyle A SymbolicConstant specifying the type of sketch displayed in the viewport. Possible values are REGULAR or AXISYM. The default value is REGULAR. sheetAuto A Boolean specifying if the sheet size and the grid spacing are automatically computed. The default value is ON.
Return value

None
Exceptions

RangeError.

42.4.2

Members

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

42–35

SketcherOptions object

42.5

SketcherOptions object

The SketcherOptions object specifies the sketcher cursor behavior. The SketcherOptions object has no constructor or methods. ABAQUS creates the sketcherOptions member when you import the sketch module.
Access

import sketch session.sketcherOptions

42.5.1

Members

The SketcherOptions object has the following members: gridSnap A Boolean specifying whether the cursor should snap to the grid. The default value is ON. preselection A Boolean specifying whether the cursor should preselect vertices and interesting points in the sketch. The default value is ON.

42–36

Step object

43.

Step commands (step)
The Step commands described in this chapter are used to create and configure analysis steps. Chapter 45, “Step commands (output),” describes the commands used to create and configure output requests and to configure diagnostic printing, monitoring, and restart. Chapter 44, “Step commands (miscellaneous),” describes the commands used to configure adaptive meshing and solution controls.

43.1

Step object

The Step object stores the parameters that determine the context of the step. The Step object is the abstract base type for other Step objects. The Step object has no explicit constructor. The methods and members of the Step object are common to all objects derived from the Step.
Access

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

43.1.1
name

Members

The Step object can have the following members: A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC

43–1

Step object

• • • • • • • • • • • • • • • • • • •

DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects.

43–2

AnalysisStep object

interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.

43.2

AnalysisStep object

The AnalysisStep object is the abstract base type for other Step objects, except the InitialStep object. It has no explicit constructor, no methods, and has only inherited members.
Access

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

43.2.1
name

Members

The AnalysisStep object can have the following members: A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC

43–3

AnalysisStep object

• • • • • • • • • • • • • • • • • • •

DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects.

43–4

AnnealStep object

interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.

43.3

AnnealStep object

The AnnealStep object anneals a structure by setting the velocities and all appropriate state variables to zero.
Access

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

43.3.1

AnnealStep(...)

This method creates an AnnealStep object.
Path

mdb.models[name].AnnealStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. refTemp A Float specifying the post-anneal reference temperature. The default value is the current temperature at all nodes in the model after the annealing has completed.

43–5

AnnealStep object

maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE.
Return value

An AnnealStep object.
Exceptions

RangeError.

43.3.2

setValues(...)

This method modifies the AnnealStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the AnnealStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.3.3

Members

The AnnealStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. refTemp A Float specifying the post-anneal reference temperature. The default value is the current temperature at all nodes in the model after the annealing has completed.

43–6

AnnealStep object

name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

43–7

BuckleStep object

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.3.4 Corresponding analysis keywords

*ANNEAL *STEP

43.4

BuckleStep object

The BuckleStep object controls eigenvalue buckling estimation.
Access

import step

43–8

BuckleStep object

mdb.models[name].steps[name]

43.4.1

BuckleStep(...)

This method creates a BuckleStep object.
Path

mdb.models[name].BuckleStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. numEigen An Int specifying the number of eigenvalues to be estimated.
Optional arguments

description A String describing the new step. The default value is an empty string. eigensolver A SymbolicConstant specifying the eigensolver. Possible values are SUBSPACE and LANCZOS. The default value is SUBSPACE. minEigen A Float specifying the minimum eigenvalue of interest or None. The default value is None. maxEigen A Float specifying the maximum eigenvalue of interest or None. The default value is None. vectors An Int specifying the number of vectors used in the iteration. The default value is the minimum of (2n, n + 8), where n is the number of eigenvalues requested. maxIterations An Int specifying the maximum number of iterations. The default value is 30. blockSize An Int specifying the size of the Lanczos block steps. The default value is DEFAULT. maxBlocks An Int specifying the maximum number of Lanczos block steps within each Lanczos run. The default value is DEFAULT. Note: minEigen, blockSize, and maxBlocks are ignored unless eigensolver=LANCZOS.

43–9

BuckleStep object

matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE.
Return value

A BuckleStep object.
Exceptions

RangeError.

43.4.2

setValues(...)

This method modifies the BuckleStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the BuckleStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.4.3

Members

The BuckleStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. numEigen An Int specifying the number of eigenvalues to be estimated.

43–10

BuckleStep object

description A String describing the new step. The default value is an empty string. eigensolver A SymbolicConstant specifying the eigensolver. Possible values are SUBSPACE and LANCZOS. The default value is SUBSPACE. minEigen A Float specifying the minimum eigenvalue of interest or None. The default value is None. maxEigen A Float specifying the maximum eigenvalue of interest or None. The default value is None. vectors An Int specifying the number of vectors used in the iteration. The default value is the minimum of (2n, n + 8), where n is the number of eigenvalues requested. maxIterations An Int specifying the maximum number of iterations. The default value is 30. blockSize An Int specifying the size of the Lanczos block steps. The default value is DEFAULT. maxBlocks An Int specifying the maximum number of Lanczos block steps within each Lanczos run. The default value is DEFAULT. Note: minEigen, blockSize, and maxBlocks are ignored unless eigensolver=LANCZOS. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• •

ANNEAL BUCKLE

43–11

BuckleStep object

• • • • • • • • • • • • • • • • • • • • • •

COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object.

43–12

ComplexFrequencyStep object

solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.4.4 Corresponding analysis keywords

*BUCKLE *STEP

43.5

ComplexFrequencyStep object

The ComplexFrequencyStep object is used to perform eigenvalue extraction to calculate the complex eigenvalues and corresponding complex mode shapes of a system.
Access

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

43.5.1

ComplexFrequencyStep(...)

This method creates a ComplexFrequencyStep object.
Path

mdb.models[name].ComplexFrequencyStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

43–13

ComplexFrequencyStep object

numEigen An Int specifying the number of complex eigenmodes to be calculated or a SymbolicConstant ALL. The default value is ALL.
Optional arguments

description A String describing the new step. The default value is an empty string. shift A Float specifying the shift point in cycles per time or None. The default value is None. frictionDamping A Boolean specifying whether to add to the damping matrix contributions due to friction effects. The default value is OFF. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE. minEigen A Float specifying the minimum frequency of interest in cycles per time or None. The default value is None. maxEigen A Float specifying the maximum frequency of interest in cycles per time or None. The default value is None.
Return value

A ComplexFrequencyStep object.
Exceptions

RangeError.

43.5.2

setValues(...)

This method modifies the ComplexFrequencyStep object.
Arguments Required arguments

None.

43–14

ComplexFrequencyStep object

Optional arguments The optional arguments to setValues are the same as the arguments to the ComplexFrequencyStep method, except for the name, previous, and maintainAttributes arguments. Return value

None
Exceptions

RangeError.

43.5.3

Members

The ComplexFrequencyStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. numEigen An Int specifying the number of complex eigenmodes to be calculated or a SymbolicConstant ALL. The default value is ALL. description A String describing the new step. The default value is an empty string. shift A Float specifying the shift point in cycles per time or None. The default value is None. frictionDamping A Boolean specifying whether to add to the damping matrix contributions due to friction effects. The default value is OFF. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. minEigen A Float specifying the minimum frequency of interest in cycles per time or None. The default value is None. maxEigen A Float specifying the maximum frequency of interest in cycles per time or None. The default value is None. name A String specifying the repository key.

43–15

ComplexFrequencyStep object

explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects.

43–16

CoupledTempDisplacementStep object

historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.5.4 Corresponding analysis keywords

*COMPLEX FREQUENCY *STEP

43.6

CoupledTempDisplacementStep object

The CoupledTempDisplacementStep object is used to analyze problems where the simultaneous solution of the temperature and stress/displacement fields is necessary.
Access

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

43–17

CoupledTempDisplacementStep object

43.6.1

CoupledTempDisplacementStep(...)

This method creates a CoupledTempDisplacementStep object.
Path

mdb.models[name].CoupledTempDisplacementStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. response A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT. timePeriod A Float specifying the total time period for the step. nlgeom A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF. stabilizationMethod A SymbolicConstant specifying the stabilization type. Possible values are NONE, DISSIPATED_ENERGY_FRACTION and DAMPING_FACTOR. The default value is NONE. stabilizationMagnitude A Float specifying the damping intensity of the automatic damping algorithm if the problem is expected to be unstable and stabilizationMethod≠NONE. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. initialInc A Float specifying the initial time increment. The default value is the total time period for the step.

43–18

CoupledTempDisplacementStep object

minInc A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. deltmx A Float specifying the maximum temperature change to be allowed in an increment in a transient analysis. The default value is 0.0. cetol A Float specifying the maximum difference in the creep strain increment calculated from the creep strain rates at the beginning and end of the increment. The default value is 0.0. creepIntegration A SymbolicConstant specifying the type of integration to be used for creep and swelling effects throughout the step. Possible values are IMPLICIT, EXPLICIT, and NONE. The default value is IMPLICIT. solutionTechnique A SymbolicConstant specifying the type of solution technique. Possible values are FULL_NEWTON, SEPARATED, and CONTACT_ITERATIONS. The default value is FULL_NEWTON. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP for a transient analysis and RAMP for a steady-state analysis. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE. contactSolutions An Int specifying the maximum number of right-hand-side solutions during any contact iteration. The default value is 1.

43–19

CoupledTempDisplacementStep object

contactIterations An Int specifying the maximum number of contact iterations allowed before new global matrix assemblage and factorization. The default value is 30.
Return value

A CoupledTempDisplacementStep object.
Exceptions

RangeError.

43.6.2

setValues(...)

This method modifies the CoupledTempDisplacementStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the CoupledTempDisplacementStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.6.3

Members

The CoupledTempDisplacementStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. response A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT.

43–20

CoupledTempDisplacementStep object

timePeriod A Float specifying the total time period for the step. nlgeom A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF. stabilizationMethod A SymbolicConstant specifying the stabilization type. Possible values are NONE, DISSIPATED_ENERGY_FRACTION and DAMPING_FACTOR. The default value is NONE. stabilizationMagnitude A Float specifying the damping intensity of the automatic damping algorithm if the problem is expected to be unstable and stabilizationMethod≠NONE. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. initialInc A Float specifying the initial time increment. The default value is the total time period for the step. minInc A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. deltmx A Float specifying the maximum temperature change to be allowed in an increment in a transient analysis. The default value is 0.0. cetol A Float specifying the maximum difference in the creep strain increment calculated from the creep strain rates at the beginning and end of the increment. The default value is 0.0. creepIntegration A SymbolicConstant specifying the type of integration to be used for creep and swelling effects throughout the step. Possible values are IMPLICIT, EXPLICIT, and NONE. The default value is IMPLICIT. solutionTechnique A SymbolicConstant specifying the type of solution technique. Possible values are FULL_NEWTON, SEPARATED, and CONTACT_ITERATIONS. The default value is FULL_NEWTON.

43–21

CoupledTempDisplacementStep object

matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP for a transient analysis and RAMP for a steady-state analysis. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. contactSolutions An Int specifying the maximum number of right-hand-side solutions during any contact iteration. The default value is 1. contactIterations An Int specifying the maximum number of contact iterations allowed before new global matrix assemblage and factorization. The default value is 30. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE

43–22

CoupledTempDisplacementStep object

• • • • • • • • • • • • • • • •

DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects.

43–23

CoupledThermalElectricStep object

loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.6.4 Corresponding analysis keywords

*COUPLED TEMPERATURE-DISPLACEMENT *SOLUTION TECHNIQUE *STEP

43.7

CoupledThermalElectricStep object

The CoupledThermalElectricStep object is used to analyze problems where the electrical potential and temperature fields must be solved simultaneously.
Access

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

43.7.1

CoupledThermalElectricStep(...)

This method creates a CoupledThermalElectricStep object.
Path

mdb.models[name].CoupledThermalElectricStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string.

43–24

CoupledThermalElectricStep object

response A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT. timePeriod A Float specifying the total time period for the step. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. initialInc A Float specifying the initial time increment. The default value is the total time period for the step. minInc A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. end A SymbolicConstant specifying the time period to be analyzed in a transient analysis. Possible values are PERIOD and SS. The default value is PERIOD. deltmx A Float specifying the maximum temperature change to be allowed in an increment in a transient analysis. The default value is 0.0. mxdem A Float specifying the maximum allowable emissivity change with temperature and field variables during an increment. The default value is 0.1. solutionTechnique A SymbolicConstant specifying the type of solution technique. Possible values are FULL_NEWTON and SEPARATED. The default value is FULL_NEWTON. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP for a transient analysis and RAMP for a steady-state analysis.

43–25

CoupledThermalElectricStep object

extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE.
Return value

A CoupledThermalElectricStep object.
Exceptions

RangeError.

43.7.2

setValues(...)

This method modifies the CoupledThermalElectricStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the CoupledThermalElectricStep method, except maintainAttributes arguments.
Return value

same as for the

the arguments to the name, previous, and

None
Exceptions

RangeError.

43.7.3

Members

The CoupledThermalElectricStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

43–26

CoupledThermalElectricStep object

description A String describing the new step. The default value is an empty string. response A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT. timePeriod A Float specifying the total time period for the step. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. initialInc A Float specifying the initial time increment. The default value is the total time period for the step. minInc A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. end A SymbolicConstant specifying the time period to be analyzed in a transient analysis. Possible values are PERIOD and SS. The default value is PERIOD. deltmx A Float specifying the maximum temperature change to be allowed in an increment in a transient analysis. The default value is 0.0. mxdem A Float specifying the maximum allowable emissivity change with temperature and field variables during an increment. The default value is 0.1. solutionTechnique A SymbolicConstant specifying the type of solution technique. Possible values are FULL_NEWTON and SEPARATED. The default value is FULL_NEWTON. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

43–27

CoupledThermalElectricStep object

amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP for a transient analysis and RAMP for a steady-state analysis. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS

43–28

CoupledThermalElectricStep object

• • • • • • •

STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.7.4 Corresponding analysis keywords

*COUPLED THERMAL-ELECTRICAL *SOLUTION TECHNIQUE *STEP

43–29

ExplicitDynamicsStep object

43.8

ExplicitDynamicsStep object

The ExplicitDynamicsStep object is used to perform a dynamic stress/displacement analysis using explicit integration in ABAQUS/Explicit.
Access

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

43.8.1

ExplicitDynamicsStep(...)

This method creates an ExplicitDynamicsStep object.
Path

mdb.models[name].ExplicitDynamicsStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. timePeriod A Float specifying the total time period for the step. The default value is 1.0. nlgeom A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is ON. adiabatic A Boolean specifying that an adiabatic stress analysis is to be performed. The default value is OFF. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are AUTOMATIC_GLOBAL, AUTOMATIC_EBE, FIXED_USER_DEFINED_INC, or FIXED_EBE. The default value is AUTOMATIC_GLOBAL.

43–30

ExplicitDynamicsStep object

maxIncrement A Float specifying the maximum time increment or None specifying no upper limit. This argument is required only when timeIncrementationMethod=AUTOMATIC_GLOBAL or AUTOMATIC_EBE. scaleFactor A Float specifying the factor that is used to scale the time increment. This argument is required only when timeIncrementationMethod=AUTOMATIC_GLOBAL, AUTOMATIC_EBE, or FIXED_EBE. The default value is 1.0. massScaling A sequence of MassScaling objects. linearBulkViscosity A Float specifying the linear bulk viscosity parameter, . The default value is 0.06. quadBulkViscosity A Float specifying the quadratic bulk viscosity parameter, . The default value is 1.2. userDefinedInc A Float specifying the user-defined time increment. This argument is required only when timeIncrementationMethod=FIXED_USER_DEFINED_INC. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE.
Return value

An ExplicitDynamicsStep object.
Exceptions

RangeError.

43.8.2

setValues(...)

This method modifies the ExplicitDynamicsStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the ExplicitDynamicsStep method, except for the name, previous, and maintainAttributes arguments.

43–31

ExplicitDynamicsStep object

Return value

None
Exceptions

RangeError.

43.8.3

Members

The ExplicitDynamicsStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. timePeriod A Float specifying the total time period for the step. The default value is 1.0. nlgeom A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is ON. adiabatic A Boolean specifying that an adiabatic stress analysis is to be performed. The default value is OFF. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are AUTOMATIC_GLOBAL, AUTOMATIC_EBE, FIXED_USER_DEFINED_INC, or FIXED_EBE. The default value is AUTOMATIC_GLOBAL. maxIncrement A Float specifying the maximum time increment or None specifying no upper limit. This argument is required only when timeIncrementationMethod=AUTOMATIC_GLOBAL or AUTOMATIC_EBE. scaleFactor A Float specifying the factor that is used to scale the time increment. This argument is required only when timeIncrementationMethod=AUTOMATIC_GLOBAL, AUTOMATIC_EBE, or FIXED_EBE. The default value is 1.0. linearBulkViscosity A Float specifying the linear bulk viscosity parameter, . The default value is 0.06. quadBulkViscosity A Float specifying the quadratic bulk viscosity parameter, . The default value is 1.2.

43–32

ExplicitDynamicsStep object

userDefinedInc A Float specifying the user-defined time increment. This argument is required only when timeIncrementationMethod=FIXED_USER_DEFINED_INC. massScaling A sequence of MassScaling objects. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS

43–33

ExplicitDynamicsStep object

• • • •

STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.8.4 Corresponding analysis keywords

*BULK VISCOSITY *DYNAMIC *FIXED MASS SCALING *STEP *VARIABLE MASS SCALING

43–34

FrequencyStep object

43.9

FrequencyStep object

The FrequencyStep object is used to perform eigenvalue extraction to calculate the natural frequencies and corresponding mode shapes of a system.
Access

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

43.9.1

FrequencyStep(...)

This method creates a FrequencyStep object.
Path

mdb.models[name].FrequencyStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. eigensolver A SymbolicConstant specifying the eigensolver. Possible values are LANCZOS and SUBSPACE. The following optional arguments are ignored unless eigensolver=LANCZOS: minEigen, blockSize, maxBlocks, normalization, propertyEvaluationFrequency, acousticCoupling, numberIntervals, intervalBias, and intervalBoundaries. numEigen An Int specifying the number of eigenvalues to be calculated or ALL. The default value is ALL.
Optional arguments

description A String describing the new step. The default value is an empty string. shift A Float specifying the shift point in cycles per time. The default value is 0.0. minEigen A Float specifying the minimum frequency of interest in cycles per time or None. The default value is None.

43–35

FrequencyStep object

maxEigen A Float specifying the maximum frequency of interest in cycles per time or None. The default value is None. vectors An Int specifying the number of vectors used in the iteration. The default is the minimum of (2n, n + 8), where n is the number of eigenvalues requested. maxIterations An Int specifying the maximum number of iterations. The default value is 30. blockSize A SymbolicConstant specifying the size of the Lanczos block steps. The default value is DEFAULT. maxBlocks A SymbolicConstant specifying the maximum number of Lanczos block steps within each Lanczos run. The default value is DEFAULT. normalization A SymbolicConstant specifying the method for normalizing eigenvectors. Possible values are DISPLACEMENT and MASS. A value of DISPLACEMENT indicates normalizing the eigenvectors so that the largest displacement entry in each vector is unity. A value of MASS indicates normalizing the eigenvectors with respect to the structure’s mass matrix, which results in scaling the eigenvectors so that the generalized mass for each vector is unity. The default value is DISPLACEMENT. propertyEvaluationFrequency A SymbolicConstant, None, or a Float specifying the frequency at which to evaluate frequencydependent properties for viscoelasticity, springs, and dashpots during the eigenvalue extraction. If the value is None, the analysis product will evaluate the stiffness associated with frequencydependent springs and dashpots at zero frequency and will not consider the stiffness contributions from frequency-domain viscoelasticity in the step. The default value is None. acousticCoupling A Boolean specifying whether to include or ignore acoustic-structural coupling in models with acoustic and structural elements coupled using the *TIE option or in models with ASI-type elements. The default value is ON. numberIntervals An Int specifying the number of frequency intervals for the parallel Lanczos solver. If this value is greater than the number of available CPUs, it will be reset to the number of CPUs. The default value is 1. intervalBias A Float specifying the bias to be used to distribute the frequency intervals for the parallel Lanczos solver. The default value is 1. Note: If the intervalBoundaries argument is used, intervalBias must have a value of 1.

43–36

FrequencyStep object

intervalBoundaries A SymbolicConstant, None, or a tuple of Floats specifying the user-defined frequency interval boundaries. The default value is None. Note: If the intervalBoundaries argument is used, intervalBias must have a value of 1. frictionDamping A Boolean specifying whether to add to the damping matrix contributions due to friction effects. The default value is OFF. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE. residualModes A Boolean specifying whether to include residual modes from an immediately preceding Static, Linear Perturbation step. The default value is OFF.
Return value

A FrequencyStep object.
Exceptions

RangeError.

43.9.2

setValues(...)

This method modifies the FrequencyStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the FrequencyStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None

43–37

FrequencyStep object

Exceptions

RangeError.

43.9.3

Members

The FrequencyStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. eigensolver A SymbolicConstant specifying the eigensolver. Possible values are LANCZOS and SUBSPACE. The following optional arguments are ignored unless eigensolver=LANCZOS: minEigen, blockSize, maxBlocks, normalization, propertyEvaluationFrequency, acousticCoupling, numberIntervals, intervalBias, and intervalBoundaries. numEigen An Int specifying the number of eigenvalues to be calculated or ALL. The default value is ALL. description A String describing the new step. The default value is an empty string. shift A Float specifying the shift point in cycles per time. The default value is 0.0. minEigen A Float specifying the minimum frequency of interest in cycles per time or None. The default value is None. maxEigen A Float specifying the maximum frequency of interest in cycles per time or None. The default value is None. vectors An Int specifying the number of vectors used in the iteration. The default is the minimum of (2n, n + 8), where n is the number of eigenvalues requested. maxIterations An Int specifying the maximum number of iterations. The default value is 30. blockSize A SymbolicConstant specifying the size of the Lanczos block steps. DEFAULT. The default value is

maxBlocks A SymbolicConstant specifying the maximum number of Lanczos block steps within each Lanczos run. The default value is DEFAULT.

43–38

FrequencyStep object

normalization A SymbolicConstant specifying the method for normalizing eigenvectors. Possible values are DISPLACEMENT and MASS. A value of DISPLACEMENT indicates normalizing the eigenvectors so that the largest displacement entry in each vector is unity. A value of MASS indicates normalizing the eigenvectors with respect to the structure’s mass matrix, which results in scaling the eigenvectors so that the generalized mass for each vector is unity. The default value is DISPLACEMENT. propertyEvaluationFrequency A SymbolicConstant, None, or a Float specifying the frequency at which to evaluate frequencydependent properties for viscoelasticity, springs, and dashpots during the eigenvalue extraction. If the value is None, the analysis product will evaluate the stiffness associated with frequencydependent springs and dashpots at zero frequency and will not consider the stiffness contributions from frequency-domain viscoelasticity in the step. The default value is None. acousticCoupling A Boolean specifying whether to include or ignore acoustic-structural coupling in models with acoustic and structural elements coupled using the *TIE option or in models with ASI-type elements. The default value is ON. numberIntervals An Int specifying the number of frequency intervals for the parallel Lanczos solver. If this value is greater than the number of available CPUs, it will be reset to the number of CPUs. The default value is 1. intervalBias A Float specifying the bias to be used to distribute the frequency intervals for the parallel Lanczos solver. The default value is 1. Note: If the intervalBoundaries argument is used, intervalBias must have a value of 1. intervalBoundaries A SymbolicConstant, None, or a tuple of Floats specifying the user-defined frequency interval boundaries. The default value is None. Note: If the intervalBoundaries argument is used, intervalBias must have a value of 1. frictionDamping A Boolean specifying whether to add to the damping matrix contributions due to friction effects. The default value is OFF. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

43–39

FrequencyStep object

residualModes A Boolean specifying whether to include residual modes from an immediately preceding Static, Linear Perturbation step. The default value is OFF. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL

43–40

GeostaticStep object

• •

STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.9.4 Corresponding analysis keywords

*FREQUENCY *STEP

43.10

GeostaticStep object

The GeostaticStep object is used to verify that the geostatic stress field is in equilibrium with the applied loads and boundary conditions on the model and to iterate, if needed, to obtain equilibrium.

43–41

GeostaticStep object

Access

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

43.10.1

GeostaticStep(...)

This method creates a GeostaticStep object.
Path

mdb.models[name].GeostaticStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. nlgeom A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE. applyContactIterations A Boolean specifying wether to apply the contact iteration solution technique to this step. The default value is FALSE. contactSolutions An Int specifying the maximum number of right-hand-side solutions during any contact iteration. The default value is 1.

43–42

GeostaticStep object

contactIterations An Int specifying the maximum number of contact iterations allowed before new global matrix assemblage and factorization. The default value is 30.
Return value

A GeostaticStep object.
Exceptions

RangeError.

43.10.2

setValues(...)

This method modifies the GeostaticStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the GeostaticStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.10.3

Members

The GeostaticStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. nlgeom A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF.

43–43

GeostaticStep object

matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. applyContactIterations A Boolean specifying wether to apply the contact iteration solution technique to this step. The default value is FALSE. contactSolutions An Int specifying the maximum number of right-hand-side solutions during any contact iteration. The default value is 1. contactIterations An Int specifying the maximum number of contact iterations allowed before new global matrix assemblage and factorization. The default value is 30. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION

43–44

GeostaticStep object

• • • • • • • • • • •

MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.

43–45

HeatTransferStep object

43.10.4

Corresponding analysis keywords

*GEOSTATIC *STEP

43.11

HeatTransferStep object

The HeatTransferStep object is used to control uncoupled heat transfer for either transient or steady-state response.
Access

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

43.11.1

HeatTransferStep(...)

This method creates a HeatTransferStep object.
Path

mdb.models[name].HeatTransferStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. response A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT. timePeriod A Float specifying the total time period. The default value is 1.0. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

43–46

HeatTransferStep object

maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. initialInc A Float specifying the initial time increment. The default value is the total time period for the step. minInc A Float specifying the minimum time increment allowed. The default value is the smaller of 0.8 times the initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. end A Float specifying the temperature change rate (temperature per time) used to define steady state or None. When all nodal temperatures are changing at less than this rate, the solution terminates. The default value is None. Note: This parameter is ignored unless response=STEADY_STATE. deltmx A Float specifying the maximum temperature change to be allowed in an increment during a transient heat transfer analysis. The default value is 0.0. mxdem A Float specifying the maximum allowable emissivity change with temperature and field variables during an increment. The default value is 0.1. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default is STEP for a transient analysis and RAMP for a steady-state analysis. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, or PARABOLIC. The default value is LINEAR. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE.

43–47

HeatTransferStep object

Return value

A HeatTransferStep object.
Exceptions

RangeError.

43.11.2

setValues(...)

This method modifies the HeatTransferStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the HeatTransferStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.11.3

Members

The HeatTransferStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. response A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT. timePeriod A Float specifying the total time period. The default value is 1.0.

43–48

HeatTransferStep object

timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. initialInc A Float specifying the initial time increment. The default value is the total time period for the step. minInc A Float specifying the minimum time increment allowed. The default value is the smaller of 0.8 times the initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. end A Float specifying the temperature change rate (temperature per time) used to define steady state or None. When all nodal temperatures are changing at less than this rate, the solution terminates. The default value is None. Note: This parameter is ignored unless response=STEADY_STATE. deltmx A Float specifying the maximum temperature change to be allowed in an increment during a transient heat transfer analysis. The default value is 0.0. mxdem A Float specifying the maximum allowable emissivity change with temperature and field variables during an increment. The default value is 0.1. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default is STEP for a transient analysis and RAMP for a steady-state analysis. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, or PARABOLIC. The default value is LINEAR. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. name A String specifying the repository key.

43–49

HeatTransferStep object

explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects.

43–50

ImplicitDynamicsStep object

historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.11.4 Corresponding analysis keywords

*HEAT TRANSFER *STEP

43.12

ImplicitDynamicsStep object

The ImplicitDynamicsStep object is used to provide direct integration of a dynamic stress/displacement response in ABAQUS/Standard analyses and is generally used for nonlinear cases.
Access

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

43–51

ImplicitDynamicsStep object

43.12.1

ImplicitDynamicsStep(...)

This method creates an ImplicitDynamicsStep object.
Path

mdb.models[name].ImplicitDynamicsStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. timePeriod A Float specifying the total time period of the step. The default value is 1.0. nlgeom A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is based on the previous step. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. adiabatic A Boolean specifying whether an adiabatic stress analysis is to be performed. The default value is OFF. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. initialInc A Float specifying the initial time increment. The default value is the total time period for the step. minInc A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period.

43–52

ImplicitDynamicsStep object

maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. haftol A Float specifying the half-step residual tolerance to be used with the automatic time incrementation scheme. The default value is None. nohaf A Boolean specifying whether to suppress calculation of the half-step residual. The default value is OFF. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP. alpha A Float specifying the nondefault value of the numerical (artificial) damping control parameter, , in the implicit operator. Possible values are −.333 0. The default value is −0.05. initialConditions A Boolean specifying whether accelerations should be calculated or recalculated at the beginning of the step. The default value is ON. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. noStop A Boolean specifying whether to accept the solution to an increment after the maximum number of iterations allowed have been completed, even if the equilibrium tolerances are not satisfied. The default value is OFF. WARNING: You should set noStop=OFF only in special cases when you have a thorough understanding of how to interpret the results. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE.
Return value

An ImplicitDynamicsStep object.
Exceptions

RangeError.

43–53

ImplicitDynamicsStep object

43.12.2

setValues(...)

This method modifies the ImplicitDynamicsStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the ImplicitDynamicsStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.12.3

Members

The ImplicitDynamicsStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. timePeriod A Float specifying the total time period of the step. The default value is 1.0. nlgeom A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is based on the previous step. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. adiabatic A Boolean specifying whether an adiabatic stress analysis is to be performed. The default value is OFF.

43–54

ImplicitDynamicsStep object

timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. initialInc A Float specifying the initial time increment. The default value is the total time period for the step. minInc A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. haftol A Float specifying the half-step residual tolerance to be used with the automatic time incrementation scheme. The default value is None. nohaf A Boolean specifying whether to suppress calculation of the half-step residual. The default value is OFF. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP. alpha A Float specifying the nondefault value of the numerical (artificial) damping control parameter, , in the implicit operator. Possible values are −.333 0. The default value is −0.05. initialConditions A Boolean specifying whether accelerations should be calculated or recalculated at the beginning of the step. The default value is ON. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. noStop A Boolean specifying whether to accept the solution to an increment after the maximum number of iterations allowed have been completed, even if the equilibrium tolerances are not satisfied. The default value is OFF. WARNING: You should set noStop=OFF only in special cases when you have a thorough understanding of how to interpret the results.

43–55

ImplicitDynamicsStep object

name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

43–56

InitialStep object

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.12.4 Corresponding analysis keywords

*DYNAMIC *STEP

43.13

InitialStep object

The InitialStep object is a placeholder that you cannot create, delete, or modify. The InitialStep object exists in every model by default and is used to allow the preexisting boundary conditions and interactions to be defined in the model.

43–57

InitialStep object

Access

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

43.13.1
name

Members

The InitialStep object can have the following members: A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS

43–58

InitialStep object

• • • • • • •

STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.

43–59

MassDiffusionStep object

43.14

MassDiffusionStep object

The MassDiffusionStep object is used to control uncoupled transient or steady-state mass diffusion analysis.
Access

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

43.14.1

MassDiffusionStep(...)

This method creates a MassDiffusionStep object.
Path

mdb.models[name].MassDiffusionStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. response A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT. timePeriod A Float specifying the total time period. The default value is 1.0. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. initialInc A Float specifying the initial time increment. The default value is the total time period for the step.

43–60

MassDiffusionStep object

minInc A Float specifying the minimum time increment allowed. The default value is the smaller of 0.8 times the initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. end A SymbolicConstant specifying the time period to be analyzed in a transient analysis. Possible values are PERIOD and SS. The default value is PERIOD. dcmax A Float specifying the maximum normalized concentration change to be allowed in an increment. The default value is 0.0. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default is STEP for a transient analysis and RAMP for a steady-state analysis. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE.
Return value

A MassDiffusionStep object.
Exceptions

RangeError.

43.14.2

setValues(...)

This method modifies the MassDiffusionStep object.
Arguments Required arguments

None.

43–61

MassDiffusionStep object

Optional arguments

The optional arguments to setValues are the same as the arguments to the MassDiffusionStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.14.3

Members

The MassDiffusionStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. response A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT. timePeriod A Float specifying the total time period. The default value is 1.0. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. initialInc A Float specifying the initial time increment. The default value is the total time period for the step. minInc A Float specifying the minimum time increment allowed. The default value is the smaller of 0.8 times the initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. end A SymbolicConstant specifying the time period to be analyzed in a transient analysis. Possible values are PERIOD and SS. The default value is PERIOD.

43–62

MassDiffusionStep object

dcmax A Float specifying the maximum normalized concentration change to be allowed in an increment. The default value is 0.0. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default is STEP for a transient analysis and RAMP for a steady-state analysis. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS

43–63

MassDiffusionStep object

• • • • • • • • • •

RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.

43–64

ModalDynamicsStep object

43.14.4

Corresponding analysis keywords

*MASS DIFFUSION *STEP

43.15

ModalDynamicsStep object

The ModalDynamicsStep object is used to provide dynamic time history response as a linear perturbation procedure using modal superposition.
Access

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

43.15.1

ModalDynamicsStep(...)

This method creates a ModalDynamicsStep object.
Path

mdb.models[name].ModalDynamicsStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. continueAnalysis A Boolean specifying that the step starts with zero initial conditions. The default value is OFF. timePeriod A Float specifying the total time period. The default value is 1.0. incSize A Float specifying the time increment to be used. The default value is 1.0. directDamping A DirectDamping object.

43–65

ModalDynamicsStep object

compositeDamping A CompositeDamping object. rayleighDamping A RayleighDamping object. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE. directDampingByFrequency A DirectDampingByFrequency object. rayleighDampingByFrequency A RayleighDampingByFrequency object.
Return value

A ModalDynamicsStep object.
Exceptions

RangeError.

43.15.2

setValues(...)

This method modifies the ModalDynamicsStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the ModalDynamicsStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43–66

ModalDynamicsStep object

43.15.3

Members

The ModalDynamicsStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. continueAnalysis A Boolean specifying that the step starts with zero initial conditions. The default value is OFF. timePeriod A Float specifying the total time period. The default value is 1.0. incSize A Float specifying the time increment to be used. The default value is 1.0. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP. directDamping A DirectDamping object. compositeDamping A CompositeDamping object. rayleighDamping A RayleighDamping object. directDampingByFrequency A DirectDampingByFrequency object. rayleighDampingByFrequency A RayleighDampingByFrequency object. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type.

43–67

ModalDynamicsStep object

procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object.

43–68

RandomResponseStep object

adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.15.4 Corresponding analysis keywords

*DAMPING *MODAL DAMPING *MODAL DYNAMIC *STEP

43.16

RandomResponseStep object

The RandomResponseStep object is used to give the linearized response of a model to random excitation.
Access

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

43.16.1

RandomResponseStep(...)

This method creates a RandomResponseStep object.
Path

mdb.models[name].RandomResponseStep

43–69

RandomResponseStep object

Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. scale A SymbolicConstant specifying the frequency scale. Possible values are LINEAR and LOG. The default value is LOG. freq An array of RandomResponseFrequency objects. directDamping A DirectDamping object. compositeDamping A CompositeDamping object. rayleighDamping A RayleighDamping object. structuralDamping A StructuralDamping object. directDampingByFrequency A DirectDampingByFrequency object. rayleighDampingByFrequency A RayleighDampingByFrequency object. structuralDampingByFrequency A StructuralDampingByFrequency object. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE.
Return value

A RandomResponseStep object.
Exceptions

RangeError.

43–70

RandomResponseStep object

43.16.2

setValues(...)

This method modifies the RandomResponseStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the RandomResponseStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.16.3

Members

The RandomResponseStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. scale A SymbolicConstant specifying the frequency scale. Possible values are LINEAR and LOG. The default value is LOG. freq An array of RandomResponseFrequency objects. directDamping A DirectDamping object. compositeDamping A CompositeDamping object. rayleighDamping A RayleighDamping object. structuralDamping A StructuralDamping object.

43–71

RandomResponseStep object

directDampingByFrequency A DirectDampingByFrequency object. rayleighDampingByFrequency A RayleighDampingByFrequency object. structuralDampingByFrequency A StructuralDampingByFrequency object. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION

43–72

RandomResponseStep object

• • • • •

STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.16.4 Corresponding analysis keywords

*DAMPING *MODAL DAMPING *RANDOM RESPONSE *STEP

43–73

ResponseSpectrumStep object

43.17

ResponseSpectrumStep object

The ResponseSpectrumStep object is used to calculate estimates of peak values of displacements and stresses based on user-supplied response spectra and on the natural modes of the system.
Access

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

43.17.1

ResponseSpectrumStep(...)

This method creates a ResponseSpectrumStep object.
Path

mdb.models[name].ResponseSpectrumStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. components An array of ResponseSpectrumComponent objects.
Optional arguments

description A String describing the new step. The default value is an empty string. comp A SymbolicConstant specifying the order and method used to sum the components. Possible values are SINGLE_DIRECTION, MULTIPLE_DIRECTION_ABSOLUTE_SUM, and MULTIPLE_DIRECTION_SRSS_SUM. The default value is SINGLE_DIRECTION. sum A SymbolicConstant specifying the method used to sum the components. Possible values are ABS, CQC, NRL, SRSS, and TENP. The default value is ABS. directDamping A DirectDamping object.

43–74

ResponseSpectrumStep object

compositeDamping A CompositeDamping object. rayleighDamping A RayleighDamping object. directDampingByFrequency A DirectDampingByFrequency object. rayleighDampingByFrequency A RayleighDampingByFrequency object. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE.
Return value

A ResponseSpectrumStep object.
Exceptions

RangeError.

43.17.2

setValues(...)

This method modifies the ResponseSpectrumStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the ResponseSpectrumStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.17.3

Members

The ResponseSpectrumStep object can have the following members:

43–75

ResponseSpectrumStep object

previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. comp A SymbolicConstant specifying the order and method used to sum the components. Possible values are SINGLE_DIRECTION, MULTIPLE_DIRECTION_ABSOLUTE_SUM, and MULTIPLE_DIRECTION_SRSS_SUM. The default value is SINGLE_DIRECTION. sum A SymbolicConstant specifying the method used to sum the components. Possible values are ABS, CQC, NRL, SRSS, and TENP. The default value is ABS. components An array of ResponseSpectrumComponent objects. directDamping A DirectDamping object. compositeDamping A CompositeDamping object. rayleighDamping A RayleighDamping object. directDampingByFrequency A DirectDampingByFrequency object. rayleighDampingByFrequency A RayleighDampingByFrequency object. structuralDamping A StructuralDamping object. structuralDampingByFrequency A StructuralDampingByFrequency object. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type.

43–76

ResponseSpectrumStep object

procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object.

43–77

SoilsStep object

adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.17.4 Corresponding analysis keywords

*RESPONSE SPECTRUM *STEP

43.18

SoilsStep object

The SoilsStep object is used to specify transient (consolidation) or steady-state response analysis of partially or fully saturated fluid-filled porous media.
Access

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

43.18.1

SoilsStep(...)

This method creates a SoilsStep object.
Path

mdb.models[name].SoilsStep

43–78

SoilsStep object

Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. response A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT. timePeriod A Float specifying the total time period. nlgeom A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF. stabilizationMethod A SymbolicConstant specifying the stabilization type. Possible values are NONE, DISSIPATED_ENERGY_FRACTION and DAMPING_FACTOR. The default value is NONE. stabilizationMagnitude A Float specifying the damping intensity of the automatic damping algorithm if the problem is expected to be unstable, and stabilizationMethod is not NONE. creep A Boolean specifying whether a creep response occurs during this step. The default value is ON. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. initialInc A Float specifying the initial time increment. The default value is the total time period for the step. minInc A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step.

43–79

SoilsStep object

maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. end A SymbolicConstant specifying the time period to be analyzed in a transient analysis. Possible values are PERIOD and SS. The default value is PERIOD. utol A Float specifying the maximum pore pressure change permitted in any increment (in pressure units) in a transient consolidation analysis. The default value is None. cetol A Float specifying the maximum allowable difference in the creep strain increment calculated from the creep strain rates at the beginning and end of the increment. The default value is 0.0. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP for a transient analysis and RAMP for a steady-state analysis. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE. applyContactIterations A Boolean specifying wether to apply the contact iteration solution technique to this step. The default value is FALSE. contactSolutions An Int specifying the maximum number of right-hand-side solutions during any contact iteration. The default value is 1. contactIterations An Int specifying the maximum number of contact iterations allowed before new global matrix assemblage and factorization. The default value is 30.
Return value

A SoilsStep object.

43–80

SoilsStep object

Exceptions

RangeError.

43.18.2

setValues(...)

This method modifies the SoilsStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the SoilsStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.18.3

Members

The SoilsStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. response A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT. timePeriod A Float specifying the total time period. nlgeom A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF.

43–81

SoilsStep object

stabilizationMethod A SymbolicConstant specifying the stabilization type. Possible values are NONE, DISSIPATED_ENERGY_FRACTION and DAMPING_FACTOR. The default value is NONE. stabilizationMagnitude A Float specifying the damping intensity of the automatic damping algorithm if the problem is expected to be unstable, and stabilizationMethod is not NONE. creep A Boolean specifying whether a creep response occurs during this step. The default value is ON. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. initialInc A Float specifying the initial time increment. The default value is the total time period for the step. minInc A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period. maxInc A Float specifying the maximum time increment allowed. The default value is the total time period for the step. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. end A SymbolicConstant specifying the time period to be analyzed in a transient analysis. Possible values are PERIOD and SS. The default value is PERIOD. utol A Float specifying the maximum pore pressure change permitted in any increment (in pressure units) in a transient consolidation analysis. The default value is None. cetol A Float specifying the maximum allowable difference in the creep strain increment calculated from the creep strain rates at the beginning and end of the increment. The default value is 0.0. amplitude A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP for a transient analysis and RAMP for a steady-state analysis. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

43–82

SoilsStep object

matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. applyContactIterations A Boolean specifying wether to apply the contact iteration solution technique to this step. The default value is FALSE. contactSolutions An Int specifying the maximum number of right-hand-side solutions during any contact iteration. The default value is 1. contactIterations An Int specifying the maximum number of contact iterations allowed before new global matrix assemblage and factorization. The default value is 30. name A String specifying the repository key. explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION

43–83

SoilsStep object

• • • • • • • • • • •

MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects. historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.

43–84

StaticLinearPerturbationStep object

43.18.4

Corresponding analysis keywords

*SOILS *STEP

43.19

StaticLinearPerturbationStep object

The StaticLinearPerturbationStep object is used to indicate that the static step should be analyzed as a linear perturbation load step.
Access

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

43.19.1

StaticLinearPerturbationStep(...)

This method creates a StaticLinearPerturbationStep object.
Path

mdb.models[name].StaticLinearPerturbationStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, DDM_ITERATIVE, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE.

43–85

StaticLinearPerturbationStep object

Return value

A StaticLinearPerturbationStep object.
Exceptions

RangeError.

43.19.2

setValues(...)

This method modifies the StaticLinearPerturbationStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same StaticLinearPerturbationStep method, except for maintainAttributes arguments.
Return value

as the arguments to the the name, previous, and

None
Exceptions

RangeError.

43.19.3

Members

The StaticLinearPerturbationStep object can have the following members: previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, DDM_ITERATIVE, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. name A String specifying the repository key.

43–86

StaticLinearPerturbationStep object

explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT). perturbation A Boolean specifying whether the step has a perturbation procedure type. nonmechanical A Boolean specifying whether the step has a mechanical procedure type. procedureType A SymbolicConstant specifying the ABAQUS procedure. Possible values are:

• • • • • • • • • • • • • • • • • • • • • • • •

ANNEAL BUCKLE COMPLEX_FREQUENCY COUPLED_TEMP_DISPLACEMENT COUPLED_THERMAL_ELECTRIC DYNAMIC_IMPLICIT DYNAMIC_EXPLICIT DYNAMIC_SUBSPACE DYNAMIC_TEMP_DISPLACEMENT FREQUENCY GEOSTATIC HEAT_TRANSFER MASS_DIFFUSION MODAL_DYNAMICS RANDOM_RESPONSE RESPONSE_SPECTRUM SOILS STATIC_GENERAL STATIC_LINEAR_PERTURBATION STATIC_RIKS STEADY_STATE_DIRECT STEADY_STATE_MODAL STEADY_STATE_SUBSPACE VISCO

fieldOutputRequestState A repository of FieldOutputRequestState objects.

43–87

StaticRiksStep object

historyOutputRequestState A repository of HistoryOutputRequestState objects. diagnosticPrint A DiagnosticPrint object. monitor A Monitor object. restart A Restart object. adaptiveMeshDomains A repository of AdaptiveMeshDomain objects. control A Control object. solverControl A SolverControl object. boundaryConditionStates A repository of BoundaryConditionState objects. interactionStates A repository of InteractionState objects. loadStates A repository of LoadState objects. loadCases A repository of LoadCase objects. fieldStates A repository of FieldState objects.
43.19.4 Corresponding analysis keywords

*STATIC *STEP

43.20

StaticRiksStep object

The StaticRiksStep object is used to indicate that the step should be analyzed as a static load step using the modified Riks method for proportional loading cases.
Access

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

43–88

StaticRiksStep object

43.20.1

StaticRiksStep(...)

This method creates a StaticRiksStep object.
Path

mdb.models[name].StaticRiksStep
Required arguments

name A String specifying the repository key. previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.
Optional arguments

description A String describing the new step. The default value is an empty string. nlgeom A Boolean specifying whether to allow for geometric nonlinearity. The default value is OFF. adiabatic A Boolean specifying whether to perform an adiabatic stress analysis. The default value is OFF. maxLPF A Float specifying the maximum value of the load proportionality factor. The default value is None. nodeOn A Boolean specifying whether to monitor the finishing displacement value at a node. The default value is OFF. maximumDisplacement A Float specifying the value of the total displacement (or rotation) at the node and degree of freedom that, if crossed during an increment, ends the step at the current increment. This argument is required when nodeOn=ON. dof An Int specifying the degree of freedom being monitored. This argument is required when nodeOn=ON. region A Region object specifying the vertex at which the finishing displacement value is being monitored. This argument is required when nodeOn=ON. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

43–89

StaticRiksStep object

maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. totalArcLength A Float specifying the total load proportionality factor associated with the load in this step. The default value is 1.0. initialArcInc A Float specifying the initial load proportionality factor. The default value is the total load proportionality factor for the step. minArcInc A Float specifying the minimum arc length increment allowed. The default value is the smaller of the suggested initial load proportionality factor or 10−5 times the total load proportionality factor for the step. maxArcInc A Float specifying the maximum arc length increment allowed. The default value is the total load proportionality factor for the step. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. fullyPlastic A string specifying the name of the region being monitored for fully plastic behavior. The default value is an empty string. noStop A Boolean specifying whether to accept the solution to an increment after the maximum number of iterations allowed have been completed, even if the equilibrium tolerances are not satisfied. The default value is OFF. WARNING: You should set noStop=ON only in special cases when you have a thorough understanding of how to interpret the results. maintainAttributes A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is FALSE. applyContactIterations A Boolean specifying wether to apply the contact iteration solution technique to this step. The default value is FALSE.

43–90

StaticRiksStep object

contactSolutions An Int specifying the maximum number of right-hand-side solutions during any contact iteration. The default value is 1. contactIterations An Int specifying the maximum number of contact iterations allowed before new global matrix assemblage and factorization. The default value is 30. useLongTermSolution A Boolean specifying wether to obtain the fully relaxed long-term elastic solution with timedomain viscoelasticity or the long-term elastic-plastic solution for two-layer viscoplasticity. The default value is FALSE.
Return value

A StaticRiksStep object.
Exceptions

RangeError.

43.20.2

setValues(...)

This method modifies the StaticRiksStep object.
Arguments Required arguments

None.
Optional arguments

The optional arguments to setValues are the same as the arguments to the StaticRiksStep method, except for the name, previous, and maintainAttributes arguments.
Return value

None
Exceptions

RangeError.

43.20.3

Members

The StaticRiksStep object can have the following members:

43–91

StaticRiksStep object

previous A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps. description A String describing the new step. The default value is an empty string. nlgeom A Boolean specifying whether to allow for geometric nonlinearity. The default value is OFF. adiabatic A Boolean specifying whether to perform an adiabatic stress analysis. The default value is OFF. maxLPF A Float specifying the maximum value of the load proportionality factor. The default value is None. nodeOn A Boolean specifying whether to monitor the finishing displacement value at a node. The default value is OFF. maximumDisplacement A Float specifying the value of the total displacement (or rotation) at the node and degree of freedom that, if crossed during an increment, ends the step at the current increment. This argument is required when nodeOn=ON. dof An Int specifying the degree of freedom being monitored. This argument is required when nodeOn=ON. timeIncrementationMethod A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC. maxNumInc An Int specifying the maximum number of increments in a step. The default value is 100. totalArcLength A Float specifying the total load proportionality factor associated with the load in this step. The default value is 1.0. initialArcInc A Float specifying the initial load proportionality factor. The default value is the total load proportionality factor for the step. minArcInc A Float specifying the minimum arc length increment allowed. The default value is the smaller of the suggested initial load proportionality factor or 10−5 times the total load proportionality factor for the step.

43–92

StaticRiksStep object

maxArcInc A Float specifying the maximum arc length increment allowed. The default value is the total load proportionality factor for the step. matrixSolver A SymbolicConstant specifying the type of matrix storage. Possible values are DIRECT_SYMMETRIC, DIRECT_UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT. extrapolation A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR. fullyPlastic A string specifying the name of the region being monitored for fully plastic behavior. The default value is an empty string. noStop A Boolean specifying whether to accept the solution to an increment after the maximum number of iterations allowed have been completed, even if the equilibrium tolerances are not satisfied. The default value is OFF. WARNING: You should set noStop=ON only in special cases when you have a thorough understanding of how to interpret the results. applyContactIterations A Boolean specifying wether to apply the contact iteration solution technique to this step. The default value is FALSE. contactSolutions An Int specifying the maximum number of right-hand-side solutions during any contact iteration. The default value is 1. contactIterations An Int specifying the maximum number of contact iterations allowed before new global matrix assemblage and factorization. The default value is 30. useLongTermSolution A Boolean specifying wether to obtain the fully relaxed long-term elastic solution with timedomain viscoelasticity or the long-term elastic-plastic solution for two-layer viscoplasticity. The default value is FALSE. region A Region object specifying the vertex at which the finishing displacement value is being monitored. This argument is required when nodeOn=ON. name A String specifying the repository key.

43–93

StaticRiksStep object

explicit A SymbolicConstant specifying whether the step has an explicit procedure type (procedureType=ANNEAL, DYNAMIC_EXPLICIT, or DYNAMIC_TEMP_DISPLACEMENT)

Sponsor Documents

Or use your account on DocShare.tips

Hide

Forgot your password?

Or register your new account on DocShare.tips

Hide

Lost your password? Please enter your email address. You will receive a link to create a new password.

Back to log-in

Close