Abaqus Scripting User's Reference Guideabaqus.software.polimi.it/v6.14/pdf_books/SCRIPT.pdf · Abaqus Scripting Reference Guide Abaqus ID: ... performed using the Abaqus Software

Abaqus Scripting Reference Guide

Abaqus ID:Printed on:

SCRIPTING REFERENCE GUIDEABAQUS 6.14

Abaqus Scripting Reference Guide


Legal NoticesCAUTION: This documentation is intended for qualified users who will exercise sound engineering judgment and expertise in the use of the AbaqusSoftware. The Abaqus Software is inherently complex, and the examples and procedures in this documentation are not intended to be exhaustive or to applyto any particular situation. Users are cautioned to satisfy themselves as to the accuracy and results of their analyses.

Dassault Systmes and its subsidiaries, including Dassault Systmes Simulia Corp., shall not be responsible for the accuracy or usefulness of any analysisperformed using the Abaqus Software or the procedures, examples, or explanations in this documentation. Dassault Systmes and its subsidiaries shall notbe responsible for the consequences of any errors or omissions that may appear in this documentation.

The Abaqus Software is available only under license from Dassault Systmes or its subsidiary and may be used or reproduced only in accordance with theterms of such license. This documentation is subject to the terms and conditions of either the software license agreement signed by the parties, or, absentsuch an agreement, the then current software license agreement to which the documentation relates.

This documentation and the software described in this documentation are subject to change without prior notice.

No part of this documentation may be reproduced or distributed in any form without prior written permission of Dassault Systmes or its subsidiary.

The Abaqus Software is a product of Dassault Systmes Simulia Corp., Providence, RI, USA.

Dassault Systmes, 2014

Abaqus, the 3DS logo, SIMULIA, CATIA, and Unified FEA are trademarks or registered trademarks of Dassault Systmes or its subsidiaries in the UnitedStates and/or other countries.

Other company, product, and service names may be trademarks or service marks of their respective owners. For additional information concerningtrademarks, copyrights, and licenses, see the Legal Notices in the Abaqus 6.14 Installation and Licensing Guide.


Preface

This section lists various resources that are available for help with using Abaqus Unified FEA software.

Support

Both technical software support (for problems with creating a model or performing an analysis) and systemssupport (for installation, licensing, and hardware-related problems) for Abaqus are offered through a globalnetwork of support offices, as well as through our online support system. Regional contact information isaccessible from SIMULIALocations at www.3ds.com/simulia. The online support system is accessibleby selecting the SUBMIT A REQUEST link at www.3ds.com/support-training (http://www.3ds.com/support-training/).

Online support

Dassault Systmes provides a knowledge base of questions and answers, solutions to questions that we haveanswered, and guidelines on how to use Abaqus, Engineering Process Composer, Isight, Tosca, fe-safe,and other SIMULIA products. The knowledge base is available from www.3ds.com/support-training(http://www.3ds.com/support-training/).

By using the online support system, you can also submit new requests for support. All support/servicerequests are tracked. If you contact us by means outside the system to discuss an existing support problemand you know the support request number, please mention it so that we can query the knowledge base to seewhat the latest action has been.

Training

All support offices offer regularly scheduled public training classes. The courses are offered in a traditionalclassroom form and via theWeb. We also provide training seminars at customer sites. All training classes andseminars include workshops to provide as much practical experience with Abaqus as possible. For a scheduleand descriptions of available classes, see the Training Classes link at www.3ds.com/simulia or call yoursupport office.

Feedback

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


Part I: Python commands


Abaqus/CAE DISPLAY PREFERENCES COMMANDS

1. Abaqus/CAE Display Preferences commands

1.1 caePrefsAccess module

The Python module caePrefsAccess contains functions that enable you to edit the Abaqus/CAEpreferences file, abaqus_v6.14.gpr.

Access

import caePrefsAccess

1.1.1 getGuiPrefsFileName(...)

This function enables you to retrieve the location of your abaqus_v6.14.gpr file.

Path

caePrefsAccess.getGuiPrefsFileName

Arguments

None.

Return value

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

1.1.2 getDisplayNamesInGuiPreferences(...)

The abaqus_v6.14.gpr file stores a separate guiPreferences record for each display that youuse. This function returns a list of every displayName recorded in the preferences file.

Path

caePrefsAccess.getDisplayNamesInGuiPreferences

Required argument

fileNameA String that specifies the path to the preferences file.

Optional argumentsNone.

11



Return value

A list of Strings of displayNames.

Exceptions

None.

1.1.3 printValuesList(...)

This function enables you to print all of the options and their values for a set of guiPreferences orsessionOptions settings derived from the abaqus_v6.14.gpr file.

Path

caePrefsAccess.printValuesList

Required argument

objectTheguiPreferences object orsessionOptions object for which youwant to print optionsand their values.

Optional arguments

maxRecursionDepthAn Int, or SymbolicConstant UNLIMITED, that specifies the depth of recursion when accessingthe attributes of object.

asStringA Boolean specifying how the string representation of each option is printed. If asString is True,printValuesList prints the str of each option; otherwise printValuesList prints therepr of the options. The default value is False.

Return value

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

Exceptions

None.

12



1.1.4 openGuiPreferences(...)

This function enables you to examine and change many default behaviors in the Abaqus/CAE graphicaluser interface. Abaqus stores preferences for each display you use in a separate guiPreferencessection of the abaqus_v6.14.gpr file.

Path

caePrefsAccess.openGuiPreferences

Required argument

displayNameA String that specifies the display for which you want to investigate GUI preferences from theabaqus_v6.14.gpr file. You can retrieve the available display names in the file by using thegetDisplayNamesInGuiPreferences method.

Optional argument

fileNameA String specifying the path to the preferences file. The openGuiPreferences method usesthis argument if you are working with a preferences file that is not at the default location.

If this argument is omitted, the abaqus_v6.14.gpr file in your home directory is opened.

Return value

A CaeGuiPrefs object.

Exceptions

None.

1.1.5 openSessionOptions(...)

This function enables you to examine and change the default behavior for many session optionsAbaqus/CAE; that is, the settings that you can save in Abaqus/CAE from the FileSave DisplayOptions menu option. Abaqus stores default session options in the sessionOptions section of theabaqus_v6.14.gpr file.

Path

caePrefsAccess.openSessionOptions

Required argumentsNone.

13



Optional arguments

fileNameA String specifying the path to the preferences file. The openSessionOptions method usesthis argument if you are working with a preferences file that is not at the default location.

If this argument is omitted, the abaqus_v6.14.gpr file in your home directory is opened.directory

A SymbolicConstant specifying the location of the preferences file. Possible values are:

CURRENT to open the preferences file in the current directory(caePrefsAccess.CURRENT)

HOME to open the preferences file in your home directory (caePrefsAccess.HOME)The default value is HOME. Either fileName or directory must be supplied. The fileName ordirectory arguments are mutually exclusive.

Return value

A CaeKerPrefs object.

Exceptions

None.

1.2 CaeGuiPrefs object

TheCaeGuiPrefs object contains the details of the graphical preferences in aguiPreferences sectionof the abaqus_v6.14.gpr file.

Access

import caePrefsAccesscaePrefsAccess.openGuiPreferences(...)

1.2.1 save(...)

This method saves the guiPreferences section specified in the current fileName.

Arguments


14



Optional argument

backupFileA Boolean specifying whether Abaqus should save a numbered backup copy of the preferencesfile, fileName. Default is True.

Return value

None

Exceptions

None.

1.2.2 saveAs(...)

This method saves the guiPreferences settings to the specified location.

Arguments

Required argument

fileNameA String specifying the path to the preferences file.


Return value

None

Exceptions

None.

1.2.3 MembersThe CaeGuiPrefs object has the following member:fileName

A String specifying the path to the preferences file.

1.3 CaeKerPrefs object

The CaeKerPrefs object contains the details of the sessionOptions.

15



Access

import caePrefsAccesscaePrefsAccess.openSessionOptions(...)

1.3.1 save(...)

This method saves the sessionOptions in the current fileName.

Arguments


Optional argument

backupFileA Boolean specifying whether save a numbered backup copy of the preferences file, fileName.Default is True.

Return value

None

Exceptions

None.

1.3.2 saveAs(...)

This method saves the sessionOptions to the specified location.

Arguments

Required arguments

fileNameA String specifying the path to the preferences file.

directoryA SymbolicConstant specifying the location of the preferences file. Possible values are:

CURRENT to open the preferences file in the current directory(caePrefsAccess.CURRENT)

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

16



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


Return value

None

Exceptions

None.

1.3.3 Members

The CaeKerPrefs object has the following member:

fileNameA String specifying the path to the preferences file that the CaeKerPrefs object represents.

17


ADAPTIVITY COMMANDS

2. Adaptivity commands

The Adaptivity commands are used to define objects, perform analyses, and calculate new meshes forthe following:

Arbitrary Lagrangian Eularian (ALE) adaptive smoothing (adaptive meshing) Varying topology adaptivity (adaptive remeshing)

2.1 AdaptiveMeshConstraint object

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

Access

import stepmdb.models[name].adaptiveMeshConstraints[name]

2.1.1 deactivate(...)

This method deactivates the adaptive mesh constraint in the specified step and all subsequent steps.

Arguments

Required argument

stepNameA String specifying the name of the step in which the adaptive mesh constraint is deactivated.


Return value

None

Exceptions

TextError.

21


ADAPTIVITY COMMANDS

2.1.2 move(...)

This method moves the adaptive mesh constraint state from one step to a different step.

Arguments

Required arguments

fromStepNameA String specifying the name of the step from which the adaptive mesh constraint state is moved.

toStepNameA String specifying the name of the step to which the adaptive mesh constraint state is moved.


Return value

None

Exceptions

TextError.

2.1.3 reset(...)

This method resets the adaptive mesh constraint state of the specified step to the state of the previousanalysis step.

Arguments

Required argument

stepNameA String specifying the name of the step in which the adaptive mesh constraint state is reset.


Return value

None

Exceptions

TextError.

22


ADAPTIVITY COMMANDS

2.1.4 resume()

This method resumes the adaptive mesh constraint that was previously suppressed.

Arguments

None.

Return value

None

Exceptions

None.

2.1.5 suppress()

This method suppresses the adaptive mesh constraint.

Arguments

None.

Return value

None

Exceptions

None.

2.1.6 delete(...)

This method allows you to delete existing adaptive mesh constraints.

Arguments

Required argument

indicesA sequence of Ints specifying the index of each adaptive mesh constraint to delete.


23


ADAPTIVITY COMMANDS

Return value

None

Exceptions

None.

2.1.7 MembersThe AdaptiveMeshConstraint object can have the following members:name

A String specifying the adaptive mesh constraint repository key.category

A SymbolicConstant specifying the category of the adaptive mesh constraint. Possible values areMECHANICAL and THERMAL.

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

localCsysNone or a DatumCsys object specifying the local coordinate system of the adaptive meshconstraints degrees of freedom. If localCsys=None, the degrees of freedom are defined in theglobal coordinate system. The default value is None.

2.2 AdaptiveMeshConstraintState object

The AdaptiveMeshConstraintState object is the abstract base type for other Arbitrary LagrangianEularian (ALE) style AdaptiveMeshConstraintState objects. The AdaptiveMeshConstraintState objecthas no explicit constructor or methods. The members of the AdaptiveMeshConstraintState object arecommon to all objects derived from the AdaptiveMeshConstraintState object.

Access

import stepmdb.models[name].steps[name].adaptiveMeshConstraintStates[name]

2.2.1 MembersThe AdaptiveMeshConstraintState object has the following members:amplitudeState

A SymbolicConstant specifying the propagation state of the amplitude reference. Possible valuesare UNSET, SET, UNCHANGED, FREED, and MODIFIED.

24


ADAPTIVITY COMMANDS

statusA SymbolicConstant specifying the propagation state of the AdaptiveMeshConstraintState object.Possible values are:

NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES

amplitudeA String specifying the name of the amplitude reference. The String is empty if the adaptive meshconstraint has no amplitude reference.

2.3 AdaptiveMeshControl object

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

Access

import stepmdb.models[name].adaptiveMeshControls[name]

2.3.1 AdaptiveMeshControl(...)

This method creates an AdaptiveMeshControl object.

Path

mdb.models[name].AdaptiveMeshControl

25


ADAPTIVITY COMMANDS

Required argument

nameA String specifying the name of the object.

Optional arguments

remappingA SymbolicConstant specifying the remapping algorithm. Possible values areFIRST_ORDER_ADVECTION and SECOND_ORDER_ADVECTION. The default value isSECOND_ORDER_ADVECTION.

smoothingAlgorithmA SymbolicConstant specifying the type of smoothing algorithm to use. Possible values areSTANDARD and GEOMETRY_ENHANCED. The default value is GEOMETRY_ENHANCED.

smoothingPriorityA SymbolicConstant specifying the type of smoothing to perform. Possible values are UNIFORMand GRADED. The default value is UNIFORM.

initialFeatureAngleAFloat specifying the initial geometric feature angle, , in degrees. Possible values are 0180. The default value is 30.0.

transitionFeatureAngleA Float specifying the transitional feature angle, , in degrees. Possible values are 0180. The default value is 30.0.

momentumAdvectionA SymbolicConstant specifying the type of momentum advection algorithm. Possible valuesare ELEMENT_CENTER_PROJECTION and HALF_INDEX_SHIFT. The default value isELEMENT_CENTER_PROJECTION.

meshingPredictorA SymbolicConstant specifying the nodal starting location to use for remeshing. Possible valuesare CURRENT and PREVIOUS. The default value is CURRENT.

curvatureRefinementA Float specifying the solution dependence weight, . Possible values are 0.0 1.0. Thedefault value is 1.0.

volumetricSmoothingWeightA Float specifying the weight used by Abaqus/Explicit for the volumetric smoothing method. Thedefault value is 1.0.

laplacianSmoothingWeightA Float specifying the weight for the Laplacian smoothing method. The default value is 0.0.

equipotentialSmoothingWeightA Float specifying the weight for the equipotential smoothing method. The default value is 0.0.

26


ADAPTIVITY COMMANDS

meshConstraintAngleA Float specifying the initial geometric feature angle, . Possible values are 0 180.The default value is 60.0.

originalConfigurationProjectionWeightA Float specifying the weight for the original configuration projection method. The default valueis 1.0.

standardVolumetricSmoothingWeightA Float specifying the weight used by Abaqus/Standard for the volumetric smoothing method.The default value is 0.0.

Return value

An AdaptiveMeshControl object.

Exceptions

RangeError.

2.3.2 setValues(...)

This method modifies the AdaptiveMeshControl object.

Arguments


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

Return value

None

Exceptions

RangeError.

2.3.3 Members

The AdaptiveMeshControl object has members with the same names and descriptions as the argumentsto the AdaptiveMeshControl method.

27


ADAPTIVITY COMMANDS

2.4 AdaptiveMeshDomain object

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

Access

import stepmdb.models[name].steps[name].adaptiveMeshDomains[name]

2.4.1 AdaptiveMeshDomain(...)

This method creates an AdaptiveMeshDomain object.

Path

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

Required argument

regionA Region object specifying the region to which the adaptive mesh domain is applied.

Optional arguments

controlsA String specifying the name of an AdaptiveMeshControl object.

frequencyAn Int specifying the frequency in increments at which adaptive meshing will be performed. Thedefault value is 10.

initialMeshSweepsAn Int specifying the number of mesh sweeps to be performed at the beginning of the first step inwhich this adaptive mesh definition is active. The default value is 5.

meshSweepsAn Int specifying the number of mesh sweeps to be performed in each adaptive mesh increment.The default value is 1.

Return value

An AdaptiveMeshDomain object.

28


ADAPTIVITY COMMANDS

Exceptions

RangeError.


This method modifies the AdaptiveMeshDomain object.

Arguments

Required argumentsNone.Optional argumentsThe optional arguments to setValues are the same as the arguments to the AdaptiveMeshDomainmethod.

Return value

None

Exceptions

RangeError.

2.4.3 MembersThe AdaptiveMeshDomain object has members with the same names and descriptions as the argumentsto the AdaptiveMeshDomain method.

2.5 AdaptivityIteration object

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

Access

import jobmdb.adaptivityProcesses[name].iterations[i]

2.5.1 AdaptivityIteration(...)

This method creates an AdaptivityIteration object.

29


ADAPTIVITY COMMANDS

Path

mdb.adaptivityProcesses[name].AdaptivityIteration

Required arguments

iterationAn Int specifying the sequence number for this iteration in the adaptivity process.

jobNameA String specifying the name of the job that was run for this iteration.

modelNameA String specifying the name of the model that was analyzed and remeshed in this iteration.

odbPathA String specifying the path to the ODB file that was created for this iteration.

remeshingErrorsAn Int specifying the number of part instances which generated errors while remeshing the modelin this iteration of the adaptivity process.


Return value

An AdaptivityIteration object.

Exceptions

None.

2.5.2 MembersThe AdaptivityIteration object has members with the same names and descriptions as the arguments tothe AdaptivityIteration method.

In addition, the AdaptivityIteration object can have the following member:ruleResults

A repository of RuleResult objects specifying the calculated results from sizing functionscorresponding to the RemeshingRule objects for this iteration of an adaptivity process.

2.6 AdaptivityProcess object

TheAdaptivityProcess object defines a series of jobs that will be submitted for analysis. Abaqus performsadaptive remeshing between each job.

210


ADAPTIVITY COMMANDS

Access

import jobmdb.adaptivityProcesses[name]

2.6.1 AdaptivityProcess(...)

This method creates an AdaptivityProcess object.

Path

mdb.AdaptivityProcess

Required arguments

nameA String specifying the name of the Adaptivity Process.

jobA ModelJob object specifying a job to be used as the prototype for all analysis jobs run by theadaptivity process.

Optional arguments

maxIterationsAn Int specifying the maximum number of analysis jobs that will be run by the Adaptivity Process.Abaqus performs adaptive remeshing between each analysis. The default value is 3.

jobPrefixA String specifying the prefix to use for jobs created by the adaptivity process. An empty stringindicates that the name of the adaptivity process should be used. The default value is an emptystring.

Return value

An AdaptivityProcess object.

Exceptions

AbaqusException.

2.6.2 submit(...)

This method begins the process of analysis and adaptive remeshing.

211


ADAPTIVITY COMMANDS

Arguments


Optional arguments

waitForCompletionA Boolean specifying whether to interrupt the execution of a script until the end of the adaptiveremeshing process is reached.

datacheckJobA Boolean specifying whether to run the adaptivity as a datacheck analysis. The default value isFalse. The datacheckJob and continueJob arguments cannot both be True.

continueJobA Boolean specifying whether to run the adaptivity as a continuation analysis. The default valueis False. The datacheckJob and continueJob arguments cannot both be True.

Return value

None

Exceptions

None.


This method modifies the AdaptivityProcess object.

Arguments


Optional argumentsThe optional arguments to setValues are the same as the arguments to the AdaptivityProcessmethod, except for the name argument.

Return value

None

212


ADAPTIVITY COMMANDS

Exceptions

2.6.4 MembersThe AdaptivityProcess object has members with the same names and descriptions as the arguments tothe AdaptivityProcess method.

In addition, the AdaptivityProcess object can have the following members:status

A SymbolicConstant specifying the status of the adaptivity process. Possible values areSUBMITTED, RUNNING, ABORTED, TERMINATED, and COMPLETED.

iterationsA repository of AdaptivityIteration objects specifying the AdaptivityIteration objects receivedduring running the adaptivity process.

2.7 DisplacementAdaptiveMeshConstraint object

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

The DisplacementAdaptiveMeshConstraint object is derived from the AdaptiveMeshConstraintobject.

Access


2.7.1 DisplacementAdaptiveMeshConstraint(...)

This method creates a DisplacementAdaptiveMeshConstraint object.

Path

mdb.models[name].DisplacementAdaptiveMeshConstraint

Required arguments

nameA String specifying the adaptive mesh constraint repository key.

createStepNameA String specifying the name of the step in which the adaptive mesh constraint is created.

213


ADAPTIVITY COMMANDS


Optional arguments

u1AFloat or a SymbolicConstant specifying the displacement component in the 1-direction. Possiblevalues 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 mustbe specified.



ur1A Float or a SymbolicConstant specifying the rotational displacement component about the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value isUNSET.



amplitudeA String or the SymbolicConstant UNSET specifying the name of the amplitude reference.UNSET should be used if the adaptive mesh constraint has no amplitude reference. The defaultvalue is UNSET. You should provide the amplitude argument only if it is valid for the specifiedstep.

motionTypeA SymbolicConstant specifying the mesh motion in relation to the underlying material.Possible values are INDEPENDENT, FOLLOW and USER_DEFINED. The default value isINDEPENDENT.

214


ADAPTIVITY COMMANDS


Return value

A DisplacementAdaptiveMeshConstraint object.

Exceptions

None.


This method modifies the data for an existing DisplacementAdaptiveMeshConstraint object in the stepwhere it is created.

Arguments

Required argumentsNone.Optional argumentsThe optional arguments to setValues are the same as the arguments to theDisplacementAdaptiveMeshConstraint method, except for the name andcreateStepName arguments.

Return value

None

Exceptions

None.

2.7.3 setValuesInStep(...)

This method modifies the propagating data for an existing DisplacementAdaptiveMeshConstraint objectin the specified step.

Arguments

Required argument

stepNameA String specifying the name of the step in which the adaptive mesh constraint is modified.

215


ADAPTIVITY COMMANDS

Optional arguments

u1AFloat or a SymbolicConstant specifying the displacement component in the 1-direction. Possiblevalues for the SymbolicConstant are SET, UNCHANGED, and FREED.



ur1A Float or a SymbolicConstant specifying the rotational displacement component about the 1-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.



amplitudeA String or a SymbolicConstant specifying the name of the amplitude reference. Possible valuesfor the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if theamplitude is propagated from the previous analysis step. FREED should be used if the adaptivemesh constraint is changed to have no amplitude reference. You should provide the amplitudeargument only if it is valid for the specified step.

Return value

None

Exceptions

None.

2.7.4 Members

The DisplacementAdaptiveMeshConstraint object can have the following members:


216


ADAPTIVITY COMMANDS

categoryA SymbolicConstant specifying the category of the adaptive mesh constraint. Possible values areMECHANICAL and THERMAL.



2.8 DisplacementAdaptiveMeshConstraintState object

The DisplacementAdaptiveMeshConstraintState object stores the propagating data for an ArbitraryLagrangian Eularian (ALE) style displacement/rotation adaptive mesh constraint in a step. One instanceof this object is created internally by the DisplacementAdaptiveMeshConstraint object for each step.The instance is also deleted internally by the DisplacementAdaptiveMeshConstraint object.

The DisplacementAdaptiveMeshConstraintState object has no constructor or methods.The DisplacementAdaptiveMeshConstraintState object is derived from the

AdaptiveMeshConstraintState object.

Access


2.8.1 Members

The DisplacementAdaptiveMeshConstraintState object has the following members:

u1A Float or a Complex specifying the displacement component in the 1-direction.



ur1A Float or a Complex specifying the rotational displacement component about the 1-direction.


217


ADAPTIVITY COMMANDS


u1StateA SymbolicConstant specifying the propagation state of the displacement component in the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.



ur1StateA SymbolicConstant specifying the propagation state of the rotational displacement componentabout the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, andMODIFIED.



amplitudeStateA SymbolicConstant specifying the propagation state of the amplitude reference. Possible valuesare UNSET, SET, UNCHANGED, FREED, and MODIFIED.


NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE

218


ADAPTIVITY COMMANDS

MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES


2.8.2 Corresponding analysis keywords

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

2.9 ErrorIndicatorResult object

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

Access

import jobmdb.adaptivityProcesses[name].iterations[i].ruleResults[name]\.indicatorResults[name]

2.9.1 ErrorIndicatorResult(...)

This method creates an ErrorIndicatorResult with data for an error indicator variable in a RemeshingRulefor a given adaptivity iteration.

Path

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

Required arguments

nameA String specifying the name of the error indicator variable to which these results correspond.

219


ADAPTIVITY COMMANDS

resultsA String-to-Float Dictionary specifying the calculated results from the sizing functioncorresponding to the error indicator variable represented by this ErrorIndicatorResult.


Return value

An ErrorIndicatorResult object.

Exceptions

AbaqusException.

2.9.2 Members

The ErrorIndicatorResult object has members with the same names and descriptions as the arguments tothe ErrorIndicatorResult method.

2.10 Model object

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

Access

import mesh

2.10.1 adaptiveRemesh(...)

This method remeshes the model using the active remesh rules in the model and the error indicator resultsfrom a previous analysis.

Arguments

Required argument

odbAn Odb object containing error output field results.


220


ADAPTIVITY COMMANDS

Return value

An AdaptivityIteration Object.

Exceptions

None.

2.11 RemeshingRule object

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

Access

import meshmdb.models[name].remeshingRules[name]

2.11.1 RemeshingRule(...)

This method creates a RemeshingRule object.

Path

mdb.models[name].RemeshingRule

Required arguments

nameA String specifying the name of the object.

stepNameA String specifying the name of the step in which resizing should occur for this rule.

variablesA sequence of Strings specifying the output request variables that Abaqus will use as errorindicators.

Optional arguments

descriptionA String specifying a descriptive string for this rule. The default value is an empty string.

221


ADAPTIVITY COMMANDS

regionThe SymbolicConstant MODEL or a Region object specifying the region in which Abaqus willremesh and generate output. The SymbolicConstant MODEL represents the entire applicablemodel. The default value is MODEL.

sizingMethodA SymbolicConstant specifying the method for calculating the new mesh sizes. TheSymbolicConstant DEFAULT indicates that Abaqus will use the default calculation methodfor each individual variable. Possible values are DEFAULT, UNIFORM_ERROR, andMINIMUM_MAXIMUM. The default value is DEFAULT.

errorTargetA Float specifying the target error percentage for each variable in the region. A value of 0.0indicates that Abaqus will use automated error target reduction for the region. You use theerrorTarget argument when sizingMethod=UNIFORM_ERROR. The default value is 0.0.

maxSolutionErrorTargetA Float specifying the target error percentage at the location of the maximum solutionvalue in the region. A value of 0.0 indicates that Abaqus will use automated errortarget reduction for the region. You use the maxSolutionErrorTarget argument whensizingMethod=MINIMUM_MAXIMUM. The default value is 0.0.

minSolutionErrorTargetA Float specifying the target error percentage at the location of the minimum solutionvalue in the region. A value of 0.0 indicates that Abaqus will use automated errortarget reduction for the region. You use the minSolutionErrorTarget argument whensizingMethod=MINIMUM_MAXIMUM. The default value is 0.0.

meshBiasAn Int specifying an indication of how much Abaqus will bias the mesh toward the locationof the maximum solution value in the region. The higher the value, the more the mesh willbias towards the location of the maximum solution value. You use the meshBias argument whensizingMethod=MINIMUM_MAXIMUM. The default value is 0.0.

minElementSizeA Float specifying the minimum size of any single element. The default value is 0.0.

maxElementSizeA Float specifying the maximum size of any single element. The default value is 0.0.

outputFrequencyA SymbolicConstant specifying the frequency with which the error indicators are saved to theoutput database file (.odb). Possible values are LAST_INCREMENT andALL_INCREMENTS.The default value is LAST_INCREMENT.

specifyMinSizeA Boolean specifying an indication of whether to use a user-supplied minimum element size or tocalculate a characteristic minimum element size. The default value is OFF.

222


ADAPTIVITY COMMANDS

specifyMaxSizeA Boolean specifying an indication of whether to use a user-supplied maximum element size or tocalculate a characteristic maximum element size. The default value is ON.

coarseningFactorA SymbolicConstant or an Int specifying an indication of the upper limit on the elementgrowth from one remeshing iteration to the next. Possible values are DEFAULT_LIMIT andNOT_ALLOWED. The default value is DEFAULT_LIMIT.

refinementFactorASymbolicConstant or an Int specifying an indication of the upper limit on element shrinkage fromone remeshing iteration to the next. Possible values areDEFAULT_LIMIT andNOT_ALLOWED.The default value is DEFAULT_LIMIT.

elementCountLimitNone or an Int specifying an approximate limit on the number of elements that will be createdduring remeshing. Use None to indicate there is not upper limit. The default value is None.

Return value

A RemeshingRule object.

Exceptions

AbaqusException.

2.11.2 resume()

This method resumes the remeshing rule that was previously suppressed.

Arguments

None.

Return value

None

Exceptions

None.

2.11.3 suppress()

This method suppresses the remeshing rule. Abaqus will not remesh regions where the rules aresuppressed.

223


ADAPTIVITY COMMANDS

Arguments

None.

Return value

None

Exceptions

None.


This method modifies the RemeshingRule object.

Arguments


Optional argumentsThe optional arguments tosetValues are the same as the arguments to theRemeshingRulemethod,except for the name argument.

Return value

None

Exceptions

2.11.5 Members

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

In addition, the RemeshingRule object has the following member:

suppressedA Boolean specifying whether the remeshing rule is suppressed. Remeshing of the remeshingrules region will not occur if you suppress a rule. The default value is OFF.

224


ADAPTIVITY COMMANDS

2.12 RuleResult object

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

Access

import jobmdb.adaptivityProcesses[name].iterations[i].ruleResults[name]

2.12.1 RuleResult(...)

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

Path

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

Required argumentsname

A String specifying the name of the Remeshing Rule to which these results correspond.indicatorResults

A repository of ErrorIndicatorResult objects specifying the calculated results from the sizingfunction corresponding to the error indicator variables for the Remeshing Rule.

numElemsAn Int specifying the number of elements before remeshing in the region of the Remeshing Rule.

minSizeElemCountAn Int specifying the number of elements that were constrained to the minimum element size bythe Remeshing Rule.

Optional argumentsatisfiedVars

A sequence of Strings specifying the error indicator variables that have satisfied the RemeshingRule.

Return value

A RuleResult object.

Exceptions

AbaqusException.

225


ADAPTIVITY COMMANDS

2.12.2 Members

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

2.13 VelocityAdaptiveMeshConstraint object

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

The VelocityAdaptiveMeshConstraint object is derived from the AdaptiveMeshConstraint object.

Access


2.13.1 VelocityAdaptiveMeshConstraint(...)

This method creates a VelocityAdaptiveMeshConstraint object.

Path

mdb.models[name].VelocityAdaptiveMeshConstraint

Required arguments


createStepNameA String specifying the name of the step in which the adaptive mesh constraint is created.


Optional arguments

v1A Float or a SymbolicConstant specifying the velocity component in the 1-direction. Possiblevalues 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 bespecified.

226


ADAPTIVITY COMMANDS



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



amplitudeA String or the SymbolicConstant UNSET specifying the name of the amplitude reference.UNSET should be used if the adaptive mesh constraint has no amplitude reference. The defaultvalue is UNSET. You should provide the amplitude argument only if it is valid for the specifiedstep.


motionTypeA SymbolicConstant specifying the mesh motion in relation to the underlying material.Possible values are INDEPENDENT, FOLLOW and USER_DEFINED. The default value isINDEPENDENT.

Return value

A VelocityAdaptiveMeshConstraint object.

Exceptions

None.


This method modifies the data for an existing VelocityAdaptiveMeshConstraint object in the step whereit is created.

227


ADAPTIVITY COMMANDS

Arguments


Optional argumentsThe optional arguments to setValues are the same as the arguments to theVelocityAdaptiveMeshConstraint method, except for the name and createStepNamearguments.

Return value

None

Exceptions

None.

2.13.3 setValuesInStep(...)

This method modifies the propagating data for an existing VelocityAdaptiveMeshConstraint object inthe specified step.

Arguments

Required argument

stepNameA String specifying the name of the step in which the adaptive mesh constraint is modified.

Optional arguments

v1A Float or a SymbolicConstant specifying the velocity component in the 1-direction. Possiblevalues for the SymbolicConstant are SET and FREED.



vr1A Float or a SymbolicConstant specifying the rotational velocity component about the 1-direction.Possible values for the SymbolicConstant are SET and FREED.

228


ADAPTIVITY COMMANDS



amplitudeA String or a SymbolicConstant specifying the name of the amplitude reference. Possible valuesfor the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if theamplitude is propagated from the previous analysis step. FREED should be used if the adaptivemesh constraint is changed to have no amplitude reference. You should provide the amplitudeargument only if it is valid for the specified step.

Return value

None

Exceptions

None.

2.13.4 MembersThe VelocityAdaptiveMeshConstraint object can have the following members:name

A String specifying the adaptive mesh constraint repository key.category

A SymbolicConstant specifying the category of the adaptive mesh constraint. Possible values areMECHANICAL and THERMAL.



2.14 VelocityAdaptiveMeshConstraintState object

The VelocityAdaptiveMeshConstraintState object stores the propagating data for an ArbitraryLagrangian Eularian (ALE) style velocity adaptive mesh constraint in a step. One instance of this object

229


ADAPTIVITY COMMANDS

is created internally by the VelocityAdaptiveMeshConstraint object for each step. The instance is alsodeleted internally by the VelocityAdaptiveMeshConstraint object.

The VelocityAdaptiveMeshConstraintState object has no constructor or methods.The VelocityAdaptiveMeshConstraintState object is derived from the

AdaptiveMeshConstraintState object.

Access


2.14.1 Members

The VelocityAdaptiveMeshConstraintState object has the following members:

v1A Float specifying the velocity component in the 1-direction.



vr1A Float specifying the rotational velocity component about the 1-direction.



v1StateA SymbolicConstant specifying the propagation state of the velocity component in the 1-direction.Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.



vr1StateA SymbolicConstant specifying the propagation state of the rotational velocity component aboutthe 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.

230


ADAPTIVITY COMMANDS



amplitudeStateA SymbolicConstant specifying the propagation state of the amplitude reference. Possible valuesare UNSET, SET, UNCHANGED, FREED, and MODIFIED.


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



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

231


AMPLITUDE COMMANDS

3. Amplitude commands

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

3.1 Amplitude object

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

Access

import amplitudemdb.models[name].amplitudes[name]import odbAmplitudesession.odbs[name].amplitudes[name]

3.1.1 MembersThe Amplitude object has the following members:

nameA String specifying the repository key.

timeSpanA SymbolicConstant specifying the time span of the amplitude. Possible values are STEP andTOTAL. The default value is STEP.

3.2 ActuatorAmplitude object

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

Access


31


AMPLITUDE COMMANDS

3.2.1 ActuatorAmplitude(...)

This method creates a ActuatorAmplitude object.

Path

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

Required argumentname

A String specifying the repository key.Optional argument


Return value

An ActuatorAmplitude object.

Exceptions

InvalidNameError and RangeError.


This method modifies the ActuatorAmplitude object.

Arguments

Required argumentsNone.Optional argumentsThe optional arguments to setValues are the same as the arguments to the ActuatorAmplitudemethod, except for the name argument.

Return value

None

Exceptions

RangeError.

32


AMPLITUDE COMMANDS

3.2.3 Members

The ActuatorAmplitude object has members with the same names and descriptions as the arguments tothe ActuatorAmplitude method.


*AMPLITUDE

3.3 BaselineCorrection object

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

Access

import amplitudemdb.models[name].amplitudes[name].baselineCorrectionimport odbAmplitudesession.odbs[name].amplitudes[name].baselineCorrection

3.3.1 BaselineCorrection(...)

This method creates a BaselineCorrection object.

Path

mdb.models[name].amplitudes[name].BaselineCorrectionsession.odbs[name].amplitudes[name].BaselineCorrection


Optional argument

intervalsAsequence of Floats specifying the correction time interval end points. Possible values are positiveand monotonically increasing Floats. The default value is an empty sequence.

33


AMPLITUDE COMMANDS

Return value

A BaselineCorrection object.

Exceptions

RangeError.


This method modifies the BaselineCorrection object.

Arguments

Required argumentsNone.Optional argumentsThe optional arguments to setValues are the same as the arguments to the BaselineCorrectionmethod.

Return value

None

Exceptions

RangeError.

3.3.3 MembersThe BaselineCorrection object has members with the same names and descriptions as the arguments tothe BaselineCorrection method.


*BASELINE CORRECTION

3.4 Correlation object

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

34


AMPLITUDE COMMANDS

The Correlation object is derived from the Amplitude object.

Access

import loadmdb.models[name].boundaryConditions[name].correlation[i]

3.4.1 Members

The Correlation object has the following members:


approachA SymbolicConstant specifying the approach used in the correlation data representation. Possiblevalues are CORRELATED,MOVING_NOISE, UNCORRELATED, andUSER. The default valueis CORRELATED.

dataA tuple of tuples of Floats specifying the real and imaginary part of the scaling factor. Ifapproach=MOVING_NOISE, then data represents the noise velocity components 1, 2, and 3.


3.5 DecayAmplitude object

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

Access


3.5.1 DecayAmplitude(...)

This method creates a DecayAmplitude object.

35


AMPLITUDE COMMANDS

Path

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

Required arguments


initialA Float specifying the constant .

maximumA Float specifying the coefficient .

startA Float specifying the starting time . Possible values are non-negative numbers.

decayTimeA Float specifying the decay time . Possible values are non-negative numbers.

Optional argument


Return value

A DecayAmplitude object.

Exceptions



This method modifies the DecayAmplitude object.

Arguments


Optional argumentsThe optional arguments to setValues are the same as the arguments to the DecayAmplitudemethod, except for the name argument.

36


AMPLITUDE COMMANDS

Return value

None

Exceptions

RangeError.

3.5.3 Members

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


*AMPLITUDE

3.6 EquallySpacedAmplitude object

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

The EquallySpacedAmplitude object is derived from the Amplitude object.

Access


3.6.1 EquallySpacedAmplitude(...)

This method creates an EquallySpacedAmplitude object.

Path

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

37


AMPLITUDE COMMANDS

Required arguments


fixedIntervalA Float specifying the fixed time interval at which the amplitude data are given. Possible valuesare positive numbers.

dataA sequence of Floats specifying the amplitude values.

Optional arguments

beginA Float specifying the time at which the first amplitude data are given. Possible values are non-negative numbers. The default value is 0.0.

smoothThe SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing.Possible float values are 0 smoothing 0.5. If smooth=SOLVER_DEFAULT, the defaultdegree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.


Return value

An EquallySpacedAmplitude object.

Exceptions



This method modifies the EquallySpacedAmplitude object.

Arguments


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

38


AMPLITUDE COMMANDS

Return value

None

Exceptions

RangeError.

3.6.3 MembersThe EquallySpacedAmplitude object has members with the same names and descriptions as thearguments to the EquallySpacedAmplitude method.

In addition, the EquallySpacedAmplitude object can have the following member:baselineCorrection



*AMPLITUDE

3.7 ModulatedAmplitude object

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

Access


3.7.1 ModulatedAmplitude(...)

This method creates a ModulatedAmplitude object.

Path

mdb.models[name].ModulatedAmplitude

39


AMPLITUDE COMMANDS

session.odbs[name].ModulatedAmplitude

Required arguments


initialA Float specifying the constant .

magnitudeA Float specifying the coefficient .

startA Float specifying the starting time . Possible values are non-negative numbers.

frequency1A Float specifying the circular frequency 1 ( ). Possible values are positive numbers.

frequency2A Float specifying the circular frequency 2 ( ). Possible values are positive numbers.

Optional argument


Return value

A ModulatedAmplitude object.

Exceptions



This method modifies the ModulatedAmplitude object.

Arguments


Optional argumentsThe optional arguments to setValues are the same as the arguments to the ModulatedAmplitudemethod, except for the name argument.

310


AMPLITUDE COMMANDS

Return value

None

Exceptions

RangeError.

3.7.3 Members

The ModulatedAmplitude object has members with the same names and descriptions as the argumentsto the ModulatedAmplitude method.


*AMPLITUDE

3.8 PeriodicAmplitude object

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

Access


3.8.1 PeriodicAmplitude(...)

This method creates a PeriodicAmplitude object.

Path

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

311


AMPLITUDE COMMANDS

Required arguments


frequencyA Float specifying the circular frequency . Possible values are positive numbers.

startA Float specifying the starting time . Possible values are positive numbers.

a_0A Float specifying the constant .

dataA sequence of pairs of Floats specifying and pairs.

Optional argument


Return value

A PeriodicAmplitude object.

Exceptions



This method modifies the PeriodicAmplitude object.

Arguments


Optional argumentsThe optional arguments to setValues are the same as the arguments to the PeriodicAmplitudemethod, except for the name argument.

Return value

None

312


AMPLITUDE COMMANDS

Exceptions

RangeError.

3.8.3 MembersThe PeriodicAmplitude object has members with the same names and descriptions as the arguments tothe PeriodicAmplitude method.


*AMPLITUDE

3.9 PsdDefinition object

The PsdDefinition object defines the cross-spectral density frequency function for random responseloading.

The PsdDefinition object is derived from the Amplitude object.

Access


3.9.1 PsdDefinition(...)

This method creates a PsdDefinition object.

Path

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

Required arguments


313


AMPLITUDE COMMANDS

dataA sequence of sequences of Floats specifying the real part of the frequency function, the imaginarypart of the frequency function, and the frequency or frequency band number values, depending onthe value of unitType.

Optional arguments

unitTypeA SymbolicConstant specifying the type of units for specifying the frequency function. FORCEimplies power units. BASE implies gravity used to define base motion. DB implies decibel units.Possible values are FORCE, BASE, and DB. The default value is FORCE.

referenceGravityAccelerationA Float specifying the reference gravity acceleration. This argument applies when unitType =BASE. The default value is 1.0.

referenecePowerA Float specifying the reference power value, in load units squared. This argument applies whenunitType = DB. The default value is 0.0.

userA Boolean specifying whether the frequency function is defined in user subroutine UPSD. Ifspecified, then data is not applicable, and the unitType value must not be DB. The default value isOFF.


amplitudeA String specifying the name of the amplitude that describes the dynamic event used to define thecross-spectral density frequency function. The default value is an empty string.

Return value

A PsdDefinition object.

Exceptions



This method modifies the PsdDefinition object.

Arguments


314


AMPLITUDE COMMANDS

Optional argumentsThe optional arguments tosetValues are the same as the arguments to thePsdDefinitionmethod,except for the name argument.

Return value

None

Exceptions

RangeError.

3.9.3 Members

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


*PSD-DEFINITION

3.10 SmoothStepAmplitude object

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

The SmoothStepAmplitude object is derived from the Amplitude object.

Access


3.10.1 SmoothStepAmplitude(...)

This method creates a SmoothStepAmplitude object.

315


AMPLITUDE COMMANDS

Path

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

Required arguments


dataA sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values fortime/frequency are positive numbers.

Optional argument


Return value

A SmoothStepAmplitude object.

Exceptions



This method modifies the SmoothStepAmplitude object.

Arguments

Required argumentsNone.Optional argumentsThe optional arguments to setValues are the same as the arguments to theSmoothStepAmplitude method, except for the name argument.

Return value

None

Exceptions

RangeError.

316


AMPLITUDE COMMANDS

3.10.3 MembersThe SmoothStepAmplitude object has members with the same names and descriptions as the argumentsto the SmoothStepAmplitude method.


*AMPLITUDE

3.11 SolutionDependentAmplitude object

The SolutionDependentAmplitude object defines a solution-dependent amplitude for superplasticforming analysis.

The SolutionDependentAmplitude object is derived from the Amplitude object.

Access


3.11.1 SolutionDependentAmplitude(...)

This method creates a SolutionDependentAmplitude object.

Path

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

Required argument


Optional arguments

initialA Float specifying the initial amplitude value. Possible values are those between minimum andmaximum. The default value is 1.0.

317


AMPLITUDE COMMANDS

minimumAFloat specifying the minimum amplitude value. Possible values are those smaller thanmaximumand initial. The default value is 0.1.

maximumA Float specifying the maximum amplitude value. Possible values are those larger than minimumand initial. The default value is 1000.0.


Return value

A SolutionDependentAmplitude object.

Exceptions



This method modifies the SolutionDependentAmplitude object.

Arguments


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

Return value

None

Exceptions

RangeError.

3.11.3 Members

The SolutionDependentAmplitude object has members with the same names and descriptions as thearguments to the SolutionDependentAmplitude method.

318


AMPLITUDE COMMANDS


*AMPLITUDE

3.12 SpectrumAmplitude object

The SpectrumAmplitude object defines the spectrum of responses for displacement, velocity, oracceleration to be used in a response spectrum analysis.

The SpectrumAmplitude object is derived from the Amplitude object.

Access


3.12.1 SpectrumAmplitude(...)

This method creates a SpectrumAmplitude object.

Path

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

Required arguments


methodA SymbolicConstant specifying the method for specifying the spectrum. Possible values areDEFINE and CALCULATE.

dataA sequence of sequences of Floats specifying the magnitude, frequency, and damping values.

319


AMPLITUDE COMMANDS

Optional arguments

specificationUnitsA SymbolicConstant specifying the units used for specifying the spectrum. Possible valuesare DISPLACEMENT, VELOCITY, ACCELERATION, and GRAVITY. The default value isACCELERATION.

eventUnitsA SymbolicConstant specifying the units used to describe the dynamic event in theamplitude used for the calculation. Possible values are EVENT_DISPLACEMENT,EVENT_VELOCITY, EVENT_ACCELERATION, and EVENT_GRAVITY. The defaultvalue is EVENT_ACCELERATION.

solutionA SymbolicConstant specifying the solution method for the dynamic equations. Possible valuesare ABSOLUTE_VALUE and RELATIVE_VALUE. The default value is ABSOLUTE_VALUE.

timeIncrementA Float specifying the implicit time increment used to calculate the spectrum. This argument isrequired when the method = CALCULATE. The default value is 0.0.

gravityA Float specifying the acceleration due to gravity. This argument applies only whenspecificationUnits = GRAVITY oreventUnits = GRAVITY. The default value is 1.0.

criticalDampingA Boolean specifying whether to calculate the spectrum for only the specified range of criticaldamping values or a list of values. If criticalDamping =ON, the spectrum is calculated only for thespecified range of critical damping values. If criticalDamping = OFF, the spectrum is calculatedfor a list of damping values. The default value is OFF.


amplitudeA String specifying the name of the amplitude that describes the dynamic event used to calculatethe spectrum. The default value is an empty string.

Return value

A SpectrumAmplitude object.

Exceptions


320


AMPLITUDE COMMANDS


This method modifies the SpectrumAmplitude object.

Arguments

Required argumentsNone.Optional argumentsThe optional arguments to setValues are the same as the arguments to the SpectrumAmplitudemethod, except for the name argument.

Return value

None

Exceptions

RangeError.

3.12.3 MembersThe SpectrumAmplitude object has members with the same names and descriptions as the arguments tothe SpectrumAmplitude method.


*SPECTRUM

3.13 TabularAmplitude object

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

The TabularAmplitude object is derived from the Amplitude object.

Access

import amplitudemdb.models[name].amplitudes[name]import odbAmplitude

321


AMPLITUDE COMMANDS

session.odbs[name].amplitudes[name]

3.13.1 TabularAmplitude(...)

This method creates a TabularAmplitude object.

Path

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

Required arguments


dataA sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values fortime/frequency are positive numbers.

Optional arguments

smoothThe SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing.Possible float values are between 0 and 0.5. If smooth=SOLVER_DEFAULT, the default degreeof smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.


Return value

A TabularAmplitude object.

Exceptions



This method modifies the TabularAmplitude object.

Arguments


322


AMPLITUDE COMMANDS

Optional argumentsThe optional arguments to setValues are the same as the arguments to the TabularAmplitudemethod, except for the name argument.

Return value

None

Exceptions

RangeError.

3.13.3 MembersThe TabularAmplitude object has members with the same names and descriptions as the arguments tothe TabularAmplitude method.

In addition, the TabularAmplitude object can have the following member:baselineCorrection



*AMPLITUDE

3.14 UserAmplitude object

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

Access


3.14.1 UserAmplitude(...)

This method creates a UserAmplitude object.

323


AMPLITUDE COMMANDS

Path

mdb.models[name].UserAmplitudesession.odbs[name].UserAmplitude

Required arguments


numVariablesAn Int specifying the number of variables for the UAMP or VUAMP user subroutine.

Optional argument


Return value

A UserAmplitude object.

Exceptions



This method modifies the UserAmplitude object.

Arguments

Required argumentsNone.Optional argumentsThe optional arguments tosetValues are the same as the arguments to theUserAmplitudemethod,except for the name argument.

Return value

None

Exceptions

RangeError.

324


AMPLITUDE COMMANDS

3.14.3 Members

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


*AMPLITUDE

325


ANIMATION COMMANDS

4. Animation commands

4.1 AnimationController object

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

Access

import animationsession.animationController

4.1.1 play(...)

This method begins the animation.

Arguments


Optional argument

durationThe SymbolicConstant UNLIMITEDor an Int specifying howmany seconds to play the animation.The default value is UNLIMITED.

Return value

None

Exceptions

If animationType=NONE:AnimationError: animationType not set

4.1.2 stop()

This method stops the animation.

41


ANIMATION COMMANDS

Arguments

None.

Return value

None

Exceptions

None.

4.1.3 incrementFrame()

This method increments the animation frame.

Arguments

None.

Return value

None

Exceptions

None.

4.1.4 decrementFrame()

This method decrements the animation frame.

Arguments

None.

Return value

None

Exceptions

None.

42


ANIMATION COMMANDS

4.1.5 showFrame(...)

This method renders the specified frame of the animation.

Arguments

Required argumentsNone.Optional arguments

frameAn Int specifying the frame number.

valueA Float specifying the frame: for animationType=TIME_HISTORY the frame with the timenearest to this value, for animationType=HARMONIC the frame with the angle nearest to thisvalue, for animationType=SCALE_FACTOR the frame with the scale value nearest to this value.

Return value

None

Exceptions

None.

4.1.6 showFirstFrame()

This method renders the first frame of the animation.

Arguments

None.

Return value

None

Exceptions

None.

4.1.7 showLastFrame()

This method renders the last frame of the animation.

43


ANIMATION COMMANDS

Arguments

None.

Return value

None

Exceptions

None.


This method modifies the AnimationController object.

Arguments


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

viewportsA sequence of pairs of Strings specifying the name of a viewport where the animation is activefollowed by a layer name, or the SymbolicConstant ALL. If a layer name is not supplied, thecurrent layer is used. If the viewport is in single display mode, the layer name is ignored if it isspecified. The default value is an empty sequence.

Return value

None

Exceptions

RangeError.

4.1.9 MembersThe AnimationController object can have the following members:animationType

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

44


ANIMATION COMMANDS

stateA SymbolicConstant specifying the state of the animation controller. Possible values are STOPand PLAY. The default value is STOP.

animationOptionsAn AnimationOptions object.

viewportsA tuple of pairs of Strings specifying the name of a viewport where the animation is active followedby a layer name, or the SymbolicConstant ALL. If a layer name is not supplied, the current layeris used. If the viewport is in single display mode, the layer name is ignored if it is specified. Thedefault value is an empty sequence.

4.2 AnimationOptions object

The AnimationOptions object is used to store values and attributes associated with anAnimationController object.

The AnimationOptions object has no constructor command. Abaqus creates the animationOptionsmember when it creates the AnimationController object.

Access

import animationsession.animationController.animationOptions


This method modifies the AnimationOptions object.

Arguments


modeA SymbolicConstant specifying the animation mode. Possible values are PLAY_ONCE, LOOP,LOOP_BACKWARD, and SWING. The default value is LOOP.

frameRateAn Int specifying the animation rate in frames/second. Possible values are 1 frameRate 100.The default value is 50.

frameCounterA Boolean specifying whether to show the frame counter. The default value is ON.

45


ANIMATION COMMANDS

relativeScalingA SymbolicConstant specifying the relative scaling when the AnimationController objectsanimationType=SCALE_FACTOR or HARMONIC. Possible values are FULL_CYCLE andHALF_CYCLE. The default value is HALF_CYCLE.

numScaleFactorFramesAn Int specifying the number of frames to be used when the AnimationController objectsanimationType=SCALE_FACTOR or HARMONIC. The default value is 7.

timeHistoryModeA SymbolicConstant specifying whether the time history animation is time based or frame based.Possible values are FRAME_BASED and TIME_BASED. The default value is FRAME_BASED.

maxTimeA Float specifying the maximum time for time based time history animation whenmaxTimeAutoCompute = False.

maxTimeAutoComputeA Boolean specifying whether the animation maximum time value should be computed from theactive frames when timeHistoryMode is set to TIME_BASED. The default value is ON.

minTimeA Float specifying the minimum time for time based time history animation whenminTimeAutoCompute = False.

minTimeAutoComputeA Boolean specifying whether the animation minimum time value should be computed from theactive frames when timeHistoryMode is set to TIME_BASED. The default value is ON.

timeIncrementA Float specifying the time increment for frame selection when timeHistoryMode is set toTIME_BASED.

xyUseHighlightMethodA Boolean specifying whether to use the highlight method to draw the time tracker line andsymbols. The default value is ON.

xyShowLineA Boolean specifying whether to show the time tracker line. The default value is ON.

xyLineStyleA SymbolicConstant specifying the XY time tracker line style. Possible values are SOLID,DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

xyLineThicknessA SymbolicConstant specifying the XY time tracker line thickness. Possible values areVERY_THIN, THIN, MEDIUM, and THICK. The default value is MEDIUM.

xyLineColorA String specifying the color used to plot the XY time tracker line when xyUseHighlightMethod= False. The default value is "Yellow".

46


ANIMATION COMMANDS

xyShowSymbolA Boolean specifying whether to show the time tracker symbols. The default value is ON.

xySymbolMarkerA SymbolicConstant specifying the marker type to be used for all animation capable XY curveor the SymbolicConstant DEFAULT specifying that the system will take the marker associated toeach curve Possible values are:

FILLED_CIRCLE FILLED_SQUARE FILLED_DIAMOND FILLED_TRI HOLLOW_CIRCLE HOLLOW_SQUARE HOLLOW_DIAMOND HOLLOW_TRI CROSS XMARKER DEFAULT

The default value is DEFAULT.xySymbolSize

A SymbolicConstant specifying the size of the markers. Possible values are SMALL, MEDIUM,and LARGE. The default value is MEDIUM.

xySymbolColorA String specifying the color used to plot XY time tracker symbols when xyUseHighlightMethod= False. When setting the color to Default the system will take the color associated to each curve.The default value is "Default".

Return value

None

Exceptions

None.

4.2.2 MembersThe AnimationOptions object can have the following members:mode

A SymbolicConstant specifying the animation mode. Possible values are PLAY_ONCE, LOOP,LOOP_BACKWARD, and SWING. The default value is LOOP.

47


ANIMATION COMMANDS

frameRateAn Int specifying the animation rate in fr

Documents

Abaqus Scripting User's Reference Guideabaqus.software.polimi.it/v6.14/pdf_books/SCRIPT.pdf · Abaqus Scripting Reference Guide Abaqus ID: ... performed using the Abaqus Software