Abaqus Session

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.

Objects of Session

• Animation Options
• Canvas
• Display Options
• Display Group
• FieldReport
• Odb Display
• Path and Probe
• Plot Options
• Print
• XY

Object features

Session

class Session

The Session object has no constructor. Abaqus creates the session member when a session is started.

Note

This object can be accessed by:

session

Note

Check Session on help.3ds.com/0.1..

Public Data Attributes:

Inherited from SessionBase

attachedToGui	A Boolean specifying whether an Abaqus interactive session is running.
replayInProgress	A Boolean specifying whether Abaqus is executing a replay file.
kernelMemoryFootprint	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
kernelMemoryMaxFootprint	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
kernelMemoryLimit	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
colors	A repository of Color objects.
journalOptions	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
memoryReductionOptions	A MemoryReductionOptions object specifying options for running in reduced memory mode.
nodeQuery	A NodeQuery object specifying nodes and their coordinates in a path.
sketcherOptions	A ConstrainedSketcherOptions object specifying common options for all sketches.
viewerOptions	A ViewerOptions object.
animationOptions	An AnimationOptions object.
aviOptions	An AVIOptions object.
imageAnimationOptions	An ImageAnimationOptions object.
imageAnimation	An ImageAnimation object.
quickTimeOptions	A QuickTimeOptions object.
viewports	A repository of Viewport objects.
customData	A RepositorySupport object.
defaultFieldReportOptions	A FieldReportOptions object.
defaultFreeBodyReportOptions	A FreeBodyReportOptions object.
fieldReportOptions	A FieldReportOptions object.
freeBodyReportOptions	A FreeBodyReportOptions object.
odbs	A repository of Odb objects.
scratchOdbs	A repository of ScratchOdb objects.
defaultOdbDisplay	A DefaultOdbDisplay object.
defaultPlot	A DefaultPlot object.
defaultChartOptions	A DefaultChartOptions object.
odbData	A repository of OdbData objects.
mdbData	A repository of MdbData objects.
paths	A repository of Path objects.
freeBodies	A repository of FreeBody objects.
streams	A repository of Stream objects.
spectrums	A repository of Spectrum 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.
psOptions	A PsOptions object.
svgOptions	A SvgOptions object.
tiffOptions	A TiffOptions object.
autoColors	An AutoColors object specifying the color palette to be used for color coding.
xyColors	An AutoColors object specifying the color palette to be used forXYCurve objects.
xyDataObjects	A repository of XYData objects.
curves	A repository of XYCurve objects.
xyPlots	A repository of XYPlot objects.
charts	A repository of Chart objects.
defaultXYReportOptions	An XYReportOptions object.
xyReportOptions	An 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.
currentViewportName	A String specifying the name of the current viewport.
sessionState	A Dictionary object specifying the viewports and their associated models.
images	A repository of Image objects.
movies	A repository of Movie objects.
defaultLightOptions	A LightOptions object.
drawingArea	A DrawingArea object.
defaultMesherOptions	A MesherOptions object specifying how to control default settings in the Mesh module.
drawings	A repository of Drawing objects.

Public Methods:

Inherited from AnimationSession

writeImageAnimation(fileName, format[, ...])	This method writes the animations present in the list of canvas objects to a file.
Movie(name, fileName[, startFrame, ...])	This method creates a Movie object from the contents of the specified file.

Inherited from CanvasSession

Viewport(name[, origin, width, height, ...])

This method creates a Viewport object with the specified origin and dimensions.

Inherited from DisplayGroupSession

DisplayGroup(name, leaf)

This method creates a DisplayGroup object.

Inherited from FieldReportSession

writeFieldReport(filename, append, sortItem, ...)	This method writes a FieldOutput object to a user-defined ASCII file.
writeFreeBodyReport(fileName, append[, ...])	This method writes a FreeBody object to a user-defined ASCII file.

Inherited from JobSession

Queue(name, queueName[, hostName, fileCopy, ...])

This method creates a Queue object.

Inherited from OdbSession

ScratchOdb(odb)

This method creates a new ScratchOdb object.

Inherited from PathSession

Path(name, type, expression, ...)	This method creates a Path object.
Spectrum(name, colors)	This method creates a Spectrum object and places it in the spectrums repository.
Stream(name, numPointsOnRake[, pointA, ...])	This method creates aStream object and places it in the streams repository.

Inherited from XYSession

AreaStyle([color, fill, style])	This method creates an AreaStyle.
LineStyle([color, show, style, thickness])	This method creates a LineStyle.
QuantityType([label, type])	This method creates a QuantityType object.
SymbolStyle([color, show, marker, size])	This method creates a SymbolStyle object.
TextStyle([color, show, font, rotationAngle])	This method creates a TextStyle.
XYData(*args, **kwargs)
XYDataFromFile(fileName[, name, ...])	This method creates an XYData object from data in an ASCII file.
XYDataFromHistory(odb, outputVariableName, steps)	This method creates an XYData object by reading history data from an Odb object.
xyDataListFromField(odb, outputPosition, ...)	This method creates a list of XYData objects by reading field data from an Odb object.
XYDataFromFreeBody(odb[, force, moment, ...])	This method creates a list of XYData objects by computing free body data from an Odb object.
XYDataFromShellThickness(odb, ...[, ...])	This method creates a list of XYData objects by reading through the thickness field data from an Odb object.
XYDataFromPath(path, name[, ...])	This method creates an XYData object from path information.

Inherited from XYSessionBase

linearizeStress(name, path, startPoint, ...)	This method is used to perform stress linearization along a defined stress line.
setPathTolerance([tolerance])	This method is used to set the tolerance to be used when creating XYData objects by extracting results along Path objects.
getPathTolerance()	This method is used to get the tolerance used when creating XYData objects by extracting results along Path objects.
setLimitForXYDataPlots([limit])	This method is used to set the limit for number of XY data objects while creating XYData from field output.
getLimitForXYDataPlots()	This method is used to get the limit for number of XY data objects while creating XYData from field output.

Inherited from SessionBase

setValues([kernelMemoryLimit])	This method modifies the Session object.
enableCADConnection(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
isCADConnectionEnabled()	This method checks the status of CAD Connection.
disableCADConnection(CADName)	This method disables an associative import CAD connection that was enabled.
enableParameterUpdate(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
setCADPortNumber(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
updateCADParameters(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
disableParameterUpdate(CADName)	This method disables an associative CAD connection using parameters.
printToFile(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
printToPrinter([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
saveOptions(directory)	This method saves your customized display settings.
writeVrmlFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
write3DXMLFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
writeOBJFile(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
openOdb(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

---

static AreaStyle(color='', fill=ON, style=abaqusConstants.SOLID)

This method creates an AreaStyle.

Note

This function can be accessed by:

session.AreaStyle
xyPlot.AreaStyle

Note

Check AreaStyle on help.3ds.com/0.1..

Parameters:

• color (str, default: '') – A String specifying the color to be used when filling an area with this AreaStyle object. The default value is “White”.

• fill (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to fill the area when using this AreaStyle. The default value is ON.

• style (SymbolicConstant, default: SOLID) – A SymbolicConstant specifying the area pattern style to be used when filling an area using this AreaStyle. The default value is SOLID.

Returns:

An AreaStyle object.

Return type:

AreaStyle

Raises:

ColorError –

DisplayGroup(name, leaf)

This method creates a DisplayGroup object.

Note

This function can be accessed by:

session.DisplayGroup

Note

Check DisplayGroup on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository key.

• leaf (Leaf) – A Leaf object specifying the items in the display group.

Returns:

A DisplayGroup object.

Return type:

DisplayGroup

static LineStyle(color='', show=ON, style=abaqusConstants.SOLID, thickness=0)

This method creates a LineStyle.

Note

This function can be accessed by:

session.LineStyle
xyPlot.LineStyle

Note

Check LineStyle on help.3ds.com/0.1..

Parameters:

• color (str, default: '') – A String specifying the color to be used when drawing a line with this LineStyle object. The default value is “White”.

• show (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to draw the line when using this LineStyle. The default value is ON.

• style (Literal[SOLID, DASHED, DOTTED, DOT_DASH], default: SOLID) – A SymbolicConstant specifying the line style to be used when drawing lines using this LineStyle. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

• thickness (float, default: 0) – A Float specifying the line thickness in mm to be used when drawing lines using this LineStyle. The default value is 0.2.

Returns:

A LineStyle object.

Return type:

LineStyle

Raises:

ColorError –

Movie(name, fileName, startFrame=0, endFrame=None, timelineStartFrame=0, timelineEndFrame=None, timelineStartTime=0, timelineEndTime=abaqusConstants.END_FRAME_TIME)

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

Note

This function can be accessed by:

session.Movie

Note

Check Movie on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository name for the movie.

• fileName (str) – A String specifying the file from which the movie is to be read. The file extension must be specified and indicates the movie format (.avi, .mov, .mpeg, or .wmv).

• startFrame (int, default: 0) – An Int specifying the first frame to be displayed from this movie. The default value is 0.

• endFrame (Optional[int], default: None) – An Int specifying the last frame to be displayed from this movie. A negative number will indicate reverse numbering: -1 is the last frame of the movie. The default value is −1.

• timelineStartFrame (int, default: 0) – An Int specifying the global timeline frame number that corresponds to startFrame. A value of 0 will indicate the first frame to be displayed in the viewport. The default value is 0.

• timelineEndFrame (Optional[int], default: None) – An Int specifying the global timeline frame number that corresponds to endFrame. A negative number will indicate reverse numbering: -1 indicates the last frame to be displayed in the viewport. The default value is −1.

• timelineStartTime (float, default: 0) – A Float specifying the global timeline time that corresponds to the time of startFrame. The default value is 0.0.

• timelineEndTime (Union[SymbolicConstant, float], default: END_FRAME_TIME) – The SymbolicConstant END_FRAME_TIME or a Float specifying the global timeline time that corresponds to the time of endFrame. The SymbolicConstant END_FRAME_TIME indicates the time in this movie corresponding to endFrame. The default value is END_FRAME_TIME.

Returns:

A Movie object.

Return type:

Movie

Raises:

• ValueError – If fileName does not exist or can not be read.

• ValueError – If fileName references an unsupported movie file format

• ValueError – If the contents of fileName are corrupt or can not be decoded.

Path(name, type, expression, circleDefinition, numSegments, startAngle, endAngle, radius, radialAngle, startRadius, endRadius)

This method creates a Path object.

Note

This function can be accessed by:

session.Path

Note

Check Path on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository key.

• type (SymbolicConstant) – A SymbolicConstant specifying the type of path being created. Possible values are NODE_LIST, POINT_LIST, EDGE_LIST, CIRCUMFERENTIAL, and RADIAL.

• expression (tuple) –

  A sequence specifying the nodes or points that make up the path. The definition of the path expression 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 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 (SymbolicConstant) – 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 (int) – An Int specifying the number of equal segments in the path. This argument is valid only when type = CIRCUMFERENTIAL or RADIAL.

• startAngle (float) – A Float specifying the start angle of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

• endAngle (float) – A Float specifying the end angle of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

• radius (Union[SymbolicConstant, float]) – The SymbolicConstant CIRCLE_RADIUS or a Float specifying the radius of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

• radialAngle (float) – 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 (Union[SymbolicConstant, float]) – The SymbolicConstant CIRCLE_RADIUS or a Float specifying the start radius of the radial path. This argument is valid only when type = RADIAL.

• endRadius (Union[SymbolicConstant, float]) – The SymbolicConstant CIRCLE_RADIUS or a Float specifying the end radius of the radial path. This argument is valid only when type = RADIAL.

Returns:

A Path object.

Return type:

Path

Raises:

• ModelError –

• KeyError –

• ValueError – When type = CIRCUMFERENTIAL or RADIAL, the three points specified in expression are collinear.

static QuantityType(label='', type=abaqusConstants.NONE)

This method creates a QuantityType object.

Note

This function can be accessed by:

session.QuantityType
xyPlot.QuantityType

Note

Check QuantityType on help.3ds.com/0.1..

Parameters:

• label (str, default: '') – A String specifying the label for this quantity type.

• type (Literal[NONE, ACCELERATION, ACOUSTIC_INTENSITY, ANGLE, ANGULAR_MOMENTUM, ARC_LENGTH, AREA, AREA_VELOCITY_SQUARED, BIMOMENT, CURVATURE, CORIOLIS_LOAD, DAMAGE, DAMAGE_CRITERION, DENSITY, DENSITY_ROTATIONAL_ACCELERATION, DISPLACEMENT, ECURRENT_AREA_TIME, ELECTRIC_CHARGE, ELECTRIC_CURRENT, ELECTRIC_CURRENT_AREA, ELECTRIC_POTENTIAL, ENERGY, ENERGY_DENSITY, ENERGY_RELEASE_RATE, EPOTENTIAL_GRADIENT, FREQUENCY, FORCE, FORCE_VOLUME, HEAT_FLUX, HEAT_FLUX_AREA, HEAT_FLUX_RATE, HEAT_FLUX_VOLUME, LENGTH, LINEAR_PRESSURE, LUMIN, MASS, MASS_FLOW_AREA, MASS_FLOW_AREA_RATE, MASS_FLOW_RATE, MODE_NUMBER, MOMENT, NUMBER, PATH, PHASE, POSITION, PRESSURE, PRESSURE_GRADIENT, RATE, ROTARY_INERTIA, ROTATIONAL_ACCELERATION, ROTATIONAL_VELOCITY, STATUS, STRAIN, STRAIN_RATE, STRESS, STRESS_INTENS_FACTOR, SUBSTANCE, TEMPERATURE, THICKNESS, TIME, TIME_INCREMENT, TIME_HEAT_FLUX, TIME_HEAT_FLUX_AREA, TIME_VOLUME, TIME_VOLUME_FLUX, TWIST, VELOCITY, VELOCITY_SQUARED, VOLUME, VOLUME_FLUX, VOLUME_FLUX_AREA, VOLUME_FRACTION], default: NONE) –

  A SymbolicConstant specifying the physical dimension of the axis. Possible values are:

  • NONE.

  • ACCELERATION.

  • ACOUSTIC_INTENSITY.

  • ANGLE.

  • ANGULAR_MOMENTUM.

  • ARC_LENGTH.

  • AREA.

  • AREA_VELOCITY_SQUARED, specifying “Velocity squared per area”.

  • BIMOMENT.

  • CURVATURE.

  • CORIOLIS_LOAD.

  • DAMAGE.

  • DAMAGE_CRITERION.

  • DENSITY.

  • DENSITY_ROTATIONAL_ACCELERATION, specifying “Density * Angular acceleration”.

  • DISPLACEMENT.

  • ECURRENT_AREA_TIME, specifying “Time integrated electric current per area”.

  • ELECTRIC_CHARGE.

  • ELECTRIC_CURRENT.

  • ELECTRIC_CURRENT_AREA, specifying “Electric current per unit area”.

  • ELECTRIC_POTENTIAL.

  • ENERGY.

  • ENERGY_DENSITY.

  • ENERGY_RELEASE_RATE.

  • EPOTENTIAL_GRADIENT, specifying “Electric potential gradient”.

  • FREQUENCY.

  • FORCE.

  • FORCE_VOLUME, specifying “Force per volume”.

  • HEAT_FLUX.

  • HEAT_FLUX_AREA, specifying “Heat flux per area”.

  • HEAT_FLUX_RATE.

  • HEAT_FLUX_VOLUME, specifying “Heat flux per volume”.

  • LENGTH.

  • LINEAR_PRESSURE.

  • LUMIN, specifying “Luminous intensity”.

  • MASS.

  • MASS_FLOW_AREA, specifying “Mass flow per area”.

  • MASS_FLOW_AREA_RATE, specifying “Mass flow rate per area”.

  • MASS_FLOW_RATE.

  • MODE_NUMBER.

  • MOMENT.

  • NUMBER.

  • PATH.

  • PHASE.

  • POSITION.

  • PRESSURE.

  • PRESSURE_GRADIENT.

  • RATE.

  • ROTARY_INERTIA.

  • ROTATIONAL_ACCELERATION.

  • ROTATIONAL_VELOCITY.

  • STATUS.

  • STRAIN.

  • STRAIN_RATE.

  • STRESS.

  • STRESS_INTENS_FACTOR, specifying “Stress intensity factor”.

  • SUBSTANCE, specifying “Amount of substance”.

  • TEMPERATURE.

  • THICKNESS.

  • TIME.

  • TIME_INCREMENT.

  • TIME_HEAT_FLUX, specifying “Time integrated heat flux”.

  • TIME_HEAT_FLUX_AREA, specifying “Time integrated heat flux per area”.

  • TIME_VOLUME, specifying “Time integrated volume”.

  • TIME_VOLUME_FLUX, specifying “Time integrated volume flux per area”.

  • TWIST.

  • VELOCITY.

  • VELOCITY_SQUARED.

  • VOLUME.

  • VOLUME_FLUX.

  • VOLUME_FLUX_AREA, specifying “Volume flux per area”.

  • VOLUME_FRACTION.

  The default value is NONE

Returns:

A QuantityType object.

Return type:

QuantityType

Queue(name, queueName, hostName='', fileCopy=ON, directory='', driver='', remotePlatform='Linux', filesToCopy=abaqusConstants.ALL, deleteAfterCopy=OFF, description='')

This method creates a Queue object. Note:Remote queues are available only on Linux platforms.

Note

This function can be accessed by:

session.Queue

Note

Check Queue on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the name of the new Queue object.

• queueName (str) – A String specifying the name of the remote analysis queue.

• hostName (str, default: '') – A String specifying the name of the remote host. The default value is an empty string.

• fileCopy (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying if the results files are to be copied from the remote machine to the local machine. The default value is ON.

• directory (str, default: '') – A String specifying the remote location for the execution of the simulation. The default value is an empty string.

• driver (str, default: '') – A String specifying the designation of the remote driver. The default value is “abaqus”.

• remotePlatform (SymbolicConstant, default: 'Linux') – A SymbolicConstant specifying the type of operating system on the remote machine. The default value is Linux.

• filesToCopy (str, default: ALL) – A list of Strings specifying the files to be copied from the remote location to the local machine, or ALL. Strings specified in a list are the extensions of the job files that will be copied, such as (‘log’, ‘dat’, ‘msg’, ‘sta’, ‘odb’). The default value is ALL.

• deleteAfterCopy (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether remote files are to be deleted after they are copied to the local machine. The default value is OFF.

• description (str, default: '') – A String specifying a description of the queue. The default value is an empty string.

Returns:

A Queue object.

Return type:

Queue

Raises:

Remote queue host name is not set – If fileCopy = ON and hostName is empty.

:raises Directory in which` to :class:`run the job on the remote computer is not set: If fileCopy = ON and directory is empty.

ScratchOdb(odb)

This method creates a new ScratchOdb object.

Note

This function can be accessed by:

session.ScratchOdb

Note

Check ScratchOdb on help.3ds.com/0.1..

Parameters:

odb (Odb) – An Odb object specifying the output database with which to associate.

Returns:

A ScratchOdb object.

Return type:

ScratchOdb

Spectrum(name, colors)

This method creates a Spectrum object and places it in the spectrums repository.

Note

This function can be accessed by:

session.Spectrum

Note

Check Spectrum on help.3ds.com/0.1..

Parameters:

• name (str) – A string name for the spectrum.

• colors (tuple) – A sequence of strings indicating the colors of the spectrum.

Returns:

A Spectrum object.

Return type:

Spectrum

Stream(name, numPointsOnRake, pointA=(), pointB=(), path='')

This method creates aStream object and places it in the streams repository.

Note

This function can be accessed by:

session.Stream

Note

Check Stream on help.3ds.com/0.1..

Parameters:

• name (str) – A string name for the stream.

• numPointsOnRake (str) – An integer specifying the number of points along the rake.

• pointA (tuple, default: ()) – A tuple of 3 floats specifying the starting point of the rake. Alternatively, a string representation of the node selected in the viewport.

• pointB (tuple, default: ()) – A tuple of 3 floats specifying the end point of the rake. Alternatively, a string representation of the node selected in the viewport.

• path (str, default: '') – APath object that specifies the rake.

Returns:

A Stream object.

Return type:

Stream

static SymbolStyle(color='', show=ON, marker=abaqusConstants.FILLED_CIRCLE, size=2)

This method creates a SymbolStyle object.

Note

This function can be accessed by:

session.SymbolStyle
xyPlot.SymbolStyle

Note

Check SymbolStyle on help.3ds.com/0.1..

Parameters:

• color (str, default: '') – A String specifying the color to be used when drawing a marker with this SymbolStyle object. The default value is “White”.

• show (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to draw the marker when using this SymbolStyle object. The default value is ON.

• marker (Literal[FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, XMARKER, POINT], default: FILLED_CIRCLE) –

  A SymbolicConstant specifying the marker type be used when drawing symbols using this SymbolStyle object. Possible values are:

  • FILLED_CIRCLE

  • FILLED_SQUARE

  • FILLED_DIAMOND

  • FILLED_TRI

  • HOLLOW_CIRCLE

  • HOLLOW_SQUARE

  • HOLLOW_DIAMOND

  • HOLLOW_TRI

  • CROSS

  • XMARKER

  • POINT

  The default value is FILLED_CIRCLE.

• size (float, default: 2) – A Float specifying the marker size to be used when drawing markers using this SymbolStyle object. The default value is 2.0.

Returns:

A SymbolStyle object.

Return type:

SymbolStyle

Raises:

ColorError –

static TextStyle(color='', show=ON, font='', rotationAngle=0)

This method creates a TextStyle.

Note

This function can be accessed by:

session.TextStyle
xyPlot.TextStyle

Note

Check TextStyle on help.3ds.com/0.1..

Parameters:

• color (str, default: '') – A String specifying the color to be used when drawing text with this TextStyle object. The default value is “White”.

• show (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to draw the text when using this TextStyle object. The default value is ON.

• font (str, default: '') – A String specifying the name of the font to be used when drawing text with this TextStyle object. The default value is “--verdana-medium-r-normal---120---p---“.

• rotationAngle (float, default: 0) – A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

Returns:

A TextStyle object.

Return type:

TextStyle

Raises:

ColorError –

Viewport(name, origin=(0.0, 0.0), width=120.0, height=80.0, border=ON, titleBar=ON, titleStyle=abaqusConstants.SYSTEM, customTitleString='')

This method creates a Viewport object with the specified origin and dimensions.

Note

This function can be accessed by:

session.Viewport

Note

Check Viewport on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository key.

• origin (Tuple[float, float], default: (0.0, 0.0)) – 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 (float, default: 120.0) – A Float specifying the width in millimeters of the viewport. Possible values are 30 ≤ width ≤ (maxWidth). The default value is 120.0. Note: The maximum value of width (maxWidth) is the width of the screen in millimeters.

• height (float, default: 80.0) – A Float specifying the height in millimeters of the viewport. This height includes the title bar. Possible values are 30 ≤ height ≤ (maxHeight). The default value is 80.0. Note: The maximum value of height (maxHeight) is the height of the screen in millimeters.

• border (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether the viewport border is visible in a printed image. The default value is ON.

• titleBar (Union[AbaqusBoolean, bool], default: ON) – 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 (SymbolicConstant, default: SYSTEM) – A SymbolicConstant specifying which title to use for the viewport title. Possible values are CUSTOM and SYSTEM. The default value is SYSTEM.If titleStyle = CUSTOM, customTitleString will be used. If titleStyle = SYSTEM, a system-generated string will be used.

• customTitleString (str, default: '') – A String specifying the viewport title when titleStyle =CUSTOM. The default value is an empty string.

Returns:

A Viewport object.

Return type:

Viewport

Raises:

• SystemError – If the user attempts to delete the only viewport.

• RangeError – If width is out of range.

• RangeError – If height is out of range.

static XYData(*args, **kwargs)

XYDataFromFile(fileName, name='', sourceDescription='', contentDescription='', positionDescription='', legendLabel='', xValuesLabel='', yValuesLabel='', axis1QuantityType=Ellipsis, axis2QuantityType=Ellipsis, xField=1, yField=2, skipFrequency=0)

This method creates an XYData object from data in an ASCII file.

Note

This function can be accessed by:

session.XYDataFromFile
xyPlot.XYDataFromFile

Parameters:

• fileName (str) – A String specifying the name of the file from which the X - Y data will be read.

• name (str, default: '') – The repository key. If the name is not supplied, a default name in the form _temp#_ is generated and the XYData object is temporary.

• sourceDescription (str, default: '') – A String specifying the source of the X - Y data (e.g., “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.

• contentDescription (str, default: '') – A String specifying the content of the X - Y data (e.g., “field 1 vs. field 2”). The default value is an empty string.

• positionDescription (str, default: '') – A String specifying additional information about the X - Y data (e.g., “for whole model”). The default value is an empty string.

• legendLabel (str, default: '') – A String specifying the label to be used in the legend. The default value is the name of the XYData object.

• xValuesLabel (str, default: '') – A String specifying the label for the X-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.

• yValuesLabel (str, default: '') – A String specifying the label for the Y-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.

• axis1QuantityType (QuantityType, default: Ellipsis) – A QuantityType object specifying the QuantityType object associated to the X -axis1- values.

• axis2QuantityType (QuantityType, default: Ellipsis) – A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.

• xField (int, default: 1) – An Int specifying the field from which the X-data will be read. Fields are delimited by spaces, tabs, or commas. The default value is 1.

• yField (int, default: 2) – An Int specifying the field from which the Y-data will be read. Fields are delimited by spaces, tabs, or commas. The default value is 2.

• skipFrequency (int, default: 0) – An Int specifying how often data rows will be skipped. A skipFrequency of 1 means skip every other row. The first row is always read. Possible values are skipFrequency ≥ 0. The default value is 0 (data are read from every row).

Returns:

An XYData object.

Return type:

XYData

Raises:

• InvalidNameError –

• RangeError –

XYDataFromFreeBody(odb, force=ON, moment=OFF, heatFlowRate=OFF, resultant=ON, comp1=OFF, comp2=OFF, comp3=OFF)

This method creates a list of XYData objects by computing free body data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromFreeBody
xyPlot.XYDataFromFreeBody

Note

Check XYDataFromFreeBody on help.3ds.com/0.1..

Parameters:

• odb (Odb) – An Odb object specifying the output database from which data will be read.

• force (Union[AbaqusBoolean, bool], default: ON) – A boolean indicating whether to compute the force. The default is ON.

• moment (Union[AbaqusBoolean, bool], default: OFF) – A boolean indicating whether to compute the moment. The default is OFF.

• heatFlowRate (Union[AbaqusBoolean, bool], default: OFF) – A boolean indicating whether to compute the heat flow rate resultant magnitude. It is extracted only for viewcut based freebodies. The default is OFF.

• resultant (Union[AbaqusBoolean, bool], default: ON) – A boolean indicating whether to compute the resultant. It applies only to force and moment. The default is ON.

• comp1 (Union[AbaqusBoolean, bool], default: OFF) – A boolean indicating whether to compute the first component. It applies only to force and moment. The default is OFF.

• comp2 (Union[AbaqusBoolean, bool], default: OFF) – A boolean indicating whether to compute the second component. It applies only to force and moment. The default is OFF.

• comp3 (Union[AbaqusBoolean, bool], default: OFF) – A boolean indicating whether to compute the third component. It applies only to force and moment. The default is OFF.

Returns:

A list of XYData objects.

Return type:

List[XYData]

Raises:

• InvalidNameError –

• RangeError –

XYDataFromHistory(odb, outputVariableName, steps, name='', sourceDescription='', contentDescription='', positionDescription='', legendLabel='', skipFrequency=0, numericForm=abaqusConstants.REAL, complexAngle=0, stepTuple=Ellipsis)

This method creates an XYData object by reading history data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromHistory
xyPlot.XYDataFromHistory

Note

Check XYDataFromHistory on help.3ds.com/0.1..

Parameters:

• odb (Odb) – An Odb object specifying the output database from which data will be read.

• outputVariableName (str) – A String specifying the output variable from which the X - Y data will be read.

• steps (tuple) – A sequence of Strings specifying the names of the steps from which data will be extracted.

• name (str, default: '') – The repository key. If the name is not supplied, a default name in the form _temp#_ is generated and the XYData object is temporary (this argument is required if the method is accessed from the session object).

• sourceDescription (str, default: '') – A String specifying the source of the X - Y data (for example, “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.

• contentDescription (str, default: '') – A String specifying the content of the X - Y data (for example, “field 1 vs. field 2”). The default value is an empty string.

• positionDescription (str, default: '') – A String specifying additional information about the X - Y data (for example, “for whole model”). The default value is an empty string.

• legendLabel (str, default: '') – A String specifying the label to be used in the legend. The default value is the name of the XYData object.

• skipFrequency (int, default: 0) – An Int specifying how often data frames will be skipped. If skipFrequency = 1, Abaqus 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).

• numericForm (Literal[COMPLEX_MAGNITUDE, COMPLEX_PHASE, REAL, IMAGINARY, COMPLEX_VAL_AT_ANGLE], default: REAL) – 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_VAL_AT_ANGLE. The default value is REAL.

• complexAngle (float, default: 0) – A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.

• stepTuple (Tuple[int, ...], default: Ellipsis) – A tuple of Integers specifying the steps to include when extracting data.

Returns:

An XYData object.

Return type:

XYData

Raises:

• InvalidNameError –

• RangeError –

XYDataFromPath(path, name, includeIntersections=False, shape=Ellipsis, pathStyle=Ellipsis, numIntervals=10, labelType=Ellipsis, viewport=Ellipsis, removeDuplicateXYPairs=True, includeAllElements=False, step=Ellipsis, frame=Ellipsis, variable=Ellipsis, deformedMag=(1, 1, 1), numericForm=abaqusConstants.REAL, complexAngle=0, projectOntoMesh=False, projectionTolerance=0)

This method creates an XYData object from path information.

Note

This function can be accessed by:

session.XYDataFromPath
xyPlot.XYDataFromPath

Note

Check XYDataFromPath on help.3ds.com/0.1..

Parameters:

• path (Path) – A Path object to use in X - Y data generation.

• name (str) – A String specifying the repository key:for session ‘name’ is required argument and for xyPlot ‘name’ is optional argument.

• includeIntersections (Union[AbaqusBoolean, bool], default: False) – A Boolean specifying whether to include X - Y data for the intersections between the path and element faces or edges. The default value is False.

• shape (Literal[UNDEFORMED, DEFORMED], default: Ellipsis) – A SymbolicConstant specifying the model shape to use. Possible values are UNDEFORMED and DEFORMED.

• pathStyle (Literal[PATH_POINTS, UNIFORM_SPACING], default: Ellipsis) – A SymbolicConstant specifying the path style. Possible values are PATH_POINTS and UNIFORM_SPACING.

• numIntervals (int, default: 10) – An Int specifying the number of uniform-spacing intervals. The default value is 10.

• labelType (Literal[NORM_DISTANCE, SEQ_ID, TRUE_DISTANCE, TRUE_DISTANCE_X, TRUE_DISTANCE_Y, TRUE_DISTANCE_Z, X_COORDINATE, Y_COORDINATE, Z_COORDINATE], default: Ellipsis) – A SymbolicConstant specifying the X label type to use. Possible values are NORM_DISTANCE, SEQ_ID, TRUE_DISTANCE, TRUE_DISTANCE_X, TRUE_DISTANCE_Y, TRUE_DISTANCE_Z, X_COORDINATE, Y_COORDINATE and Z_COORDINATE.

• viewport (str, default: Ellipsis) – A String specifying the viewport name or an Int specifying the viewport id from which to obtain values. The default is the current viewport.

• removeDuplicateXYPairs (Union[AbaqusBoolean, bool], default: True) –

  A Boolean specifying whether to remove duplicate XY values from the final result. The default value is True.

  New in version 2018: The removeDuplicateXYPairs argument was added.

• includeAllElements (Union[AbaqusBoolean, bool], default: False) –

  A Boolean specifying whether to include elements which do not lie in the direction of the path. The default value is False.

  New in version 2018: The includeAllElements argument was added.

• step (int, default: Ellipsis) – An Int identifying the step from which to obtain values. The default value is the current step.

• frame (int, default: Ellipsis) – An Int identifying the frame from which to obtain values. The default value is the current frame.

• variable (Tuple[Tuple[str, Literal[ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, WHOLE_REGION], Tuple[Literal[INVARIANT, COMPONENT], str], Dict[str, str]], ...], default: Ellipsis) –

  A tuple of tuples containing the descriptions of variables for which to extract data along the path. The default value is the current variable. Each tuple specifies the following:

  • Variable label: A String specifying the variable; for example, ‘U’.

  • Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.

  • Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:

    • Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.

    • Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.

  • Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:

    • A String specifying the category selection label.

    • A String specifying the section point label.

  For example:

  variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
  variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
              ('U', NODAL,((COMPONENT, 'U1'), )), )
  variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
               {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )
  

• deformedMag (Tuple[float, float, float], default: (1, 1, 1)) – A tuple of three Floats specifying the deformation magnitude in the X-, Y-, and Z- planes. The default value is (1, 1, 1).

• numericForm (Literal[COMPLEX_MAGNITUDE, COMPLEX_PHASE, REAL, IMAGINARY, COMPLEX_VAL_AT_ANGLE], default: REAL) – 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_VAL_AT_ANGLE. The default value is REAL.

• complexAngle (float, default: 0) – A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.

• projectOntoMesh (Union[AbaqusBoolean, bool], default: False) – A Boolean to specify whether to consider the data points that do not lie on or inside the mesh. The default value is False.

• projectionTolerance (float, default: 0) – A Float specifying the tolerance value for the projected distance considered for the data extraction when projectOntoMesh = True. The default value is 0.

Returns:

• If **variable specified has one fieldoutput** (Returns an XYData object.)

• If **variable specified has more than one fieldoutputs** (Returns list of XYData objects.)

Raises:

• ErrorPathNotFound – If path is invalid.

• ErrorCurrentVPNotFound – If viewport is invalid.

• ErrorInvalidUserStepAndFrame – If step and/or frame are invalid.

• ErrorNoVarInPathExtract – If the variable argument is empty.

• ErrorUnavailableSelectedVariable – If the specified output variable is not available in the output database.

• ErrorUnusableVarInPathExtract – If the specified output variable cannot be used to obtain X - Y data from path.

• ErrorUnsupportedRefinementType – If the SymbolicConstant specifying the refinement type is invalid.

• ErrorInvalidRefinementSpecification – If the label specifying the refinement invariant or component is invalid.

• ErrorDeformedMagTupleInPathExtract – If deformedMag does not contain three Floats.

XYDataFromShellThickness(odb, outputPosition, variable, elementSets=Ellipsis, elementLabels=(), nodeSets=(), nodeLabels=(), numericForm=abaqusConstants.REAL, complexAngle=0)

This method creates a list of XYData objects by reading through the thickness field data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromShellThickness
xyPlot.XYDataFromShellThickness

Note

Check XYDataFromShellThickness on help.3ds.com/0.1..

Parameters:

• odb – An Odb object specifying the output database from which data will be read.

• outputPosition – A SymbolicConstant specifying the position from which output will be read. Possible values are ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, and NODAL.

• variable –

  A tuple of tuples containing the descriptions of variables for which to extract data from the field. Each tuple specifies the following:

  • Variable label: A String specifying the variable; for example, ‘U’.

  • Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.

  • Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:

    • Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.

    • Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.

  • Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:

    • A String specifying the category selection label.

    • A String specifying the section point label.

  For example:

  variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
  variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
              ('U', NODAL,((COMPONENT, 'U1'), )), )
  variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
               {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )
  

• elementSets – A sequence of Strings specifying element sets or a String specifying a single element set.

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

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

• nodeSets – A sequence of Strings specifying node sets or a String specifying a single node set.

• 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:

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

• 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_VAL_AT_ANGLE. The default value is REAL.

• complexAngle – A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.

Returns:

A list of XYData objects.

Return type:

List[XYData]

Raises:

• InvalidNameError –

• RangeError –

animationOptions: AnimationOptions = <abaqus.Animation.AnimationOptions.AnimationOptions object>

An AnimationOptions object.

attachedToGui: Boolean = OFF

A Boolean specifying whether an Abaqus interactive session is running.

autoColors: AutoColors = <abaqus.Session.AutoColors.AutoColors object>

An AutoColors object specifying the color palette to be used for color coding.

aviOptions: AVIOptions = <abaqus.Animation.AVIOptions.AVIOptions object>

An AVIOptions object.

charts: Dict[str, Chart] = {}

A repository of Chart objects.

colors: Dict[str, Color] = {}

A repository of Color objects.

currentProbeValues: CurrentProbeValues = <abaqus.PathAndProbe.CurrentProbeValues.CurrentProbeValues object>

A CurrentProbeValues object.

currentViewportName: str = ''

A String specifying the name of the current viewport.

curves: Dict[str, XYCurve] = {}

A repository of XYCurve objects.

customData: RepositorySupport = <abaqus.CustomKernel.RepositorySupport.RepositorySupport object>

A RepositorySupport object.

defaultChartOptions: DefaultChartOptions = <abaqus.XY.DefaultChartOptions.DefaultChartOptions object>

A DefaultChartOptions object.

defaultFieldReportOptions: FieldReportOptions = <abaqus.FieldReport.FieldReportOptions.FieldReportOptions object>

A FieldReportOptions object.

defaultFreeBodyReportOptions: FreeBodyReportOptions = <abaqus.FieldReport.FreeBodyReportOptions.FreeBodyReportOptions object>

A FreeBodyReportOptions object.

defaultGraphicsOptions: GraphicsOptions = <abaqus.DisplayOptions.GraphicsOptions.GraphicsOptions object>

A GraphicsOptions object.

defaultLightOptions: LightOptions = <abaqus.DisplayOptions.LightOptions.LightOptions object>

A LightOptions object.

defaultMesherOptions: MesherOptions = <abaqus.Mesh.MesherOptions.MesherOptions object>

A MesherOptions object specifying how to control default settings in the Mesh module.

defaultOdbDisplay: DefaultOdbDisplay = <abaqus.OdbDisplay.DefaultOdbDisplay.DefaultOdbDisplay object>

A DefaultOdbDisplay object.

defaultPlot: DefaultPlot = <abaqus.XY.DefaultPlot.DefaultPlot object>

A DefaultPlot object.

defaultProbeOptions: ProbeOptions = <abaqus.PathAndProbe.ProbeOptions.ProbeOptions object>

A ProbeOptions object.

defaultProbeReport: ProbeReport = <abaqus.PathAndProbe.ProbeReport.ProbeReport object>

A ProbeReport object.

defaultViewportAnnotationOptions: ViewportAnnotationOptions = <abaqus.DisplayOptions.ViewportAnnotationOptions.ViewportAnnotationOptions object>

A ViewportAnnotationOptions object.

defaultXYReportOptions: XYReportOptions = <abaqus.XY.XYReportOptions.XYReportOptions object>

An XYReportOptions object.

disableCADConnection(CADName)

This method disables an associative import CAD connection that was enabled.

Note

Check SessionBase.disableCADConnection on help.3ds.com/0.1..

Parameters:

CADName (str) – A String specifying the CAD system for which associative import will be disabled. Available options are Pro/ENGINEER, CATIA V5, and CATIA V6, NX and SolidWorks.

disableParameterUpdate(CADName)

This method disables an associative CAD connection using parameters.

Note

Check SessionBase.disableParameterUpdate on help.3ds.com/0.1..

Parameters:

CADName (str) – A String specifying the CAD system for which the parameter update will be disabled. Available option is Pro/ENGINEER.

displayGroups: Dict[str, DisplayGroup] = {}

A repository of DisplayGroup objects.

drawingArea: DrawingArea = <abaqus.Canvas.DrawingArea.DrawingArea object>

A DrawingArea object.

drawings: Dict[str, Drawing] = {}

A repository of Drawing objects.

enableCADConnection(CADName, portNum=None)

This method enables the Abaqus/CAE listening port for the specified CAD system.

Note

Check SessionBase.enableCADConnection on help.3ds.com/0.1..

Parameters:

• CADName (str) – A String specifying the CAD system. Available options are Pro/ENGINEER, CATIA V5, CATIA V6, NX and SolidWorks.

• portNum (Optional[int], default: None) – An Integer specifying the port number to be used by the CAD system to communicate with Abaqus/CAE. If unspecified, attempts will be made to identify an open port. The default ports used are as follow: Pro/E : 49178CATIA V5 : 49179SolidWorks : 49180NX : 49181CATIA V6 : 49182

Returns:

The connection port number used for the CAD connection.

Return type:

int

enableParameterUpdate(CADName, CADVersion, CADPort=None)

This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.

Note

Check SessionBase.enableParameterUpdate on help.3ds.com/0.1..

Parameters:

• CADName (str) – A String specifying the CAD system for which parameter update will be enabled. Available options are Pro/ENGINEER and NX.

• CADVersion (str) – A String specifying the CAD system version. Allowable options take the form of the specific CAD system plus a version string. Examples for Pro/ENGINEER are “Wildfire5” and “Creo4.” An NX example is “NX11.”

• CADPort (Optional[int], default: None) – An Integer specifying the port number to be used by Abaqus/CAE to communicate with the CAD system. If unspecified, attempts will be made to identify an open port. This port number is not the same as the portNum used by the associative import interface. The default CAD listening ports are as follow:ProE : 3344NX : 3344

epsOptions: EpsOptions = <abaqus.Print.EpsOptions.EpsOptions object>

An EpsOptions object.

fieldReportOptions: FieldReportOptions = <abaqus.FieldReport.FieldReportOptions.FieldReportOptions object>

A FieldReportOptions object.

freeBodies: Dict[str, FreeBody] = {}

A repository of FreeBody objects.

freeBodyReportOptions: FreeBodyReportOptions = <abaqus.FieldReport.FreeBodyReportOptions.FreeBodyReportOptions object>

A FreeBodyReportOptions object.

getLimitForXYDataPlots()

This method is used to get the limit for number of XY data objects while creating XYData from field output.

Returns:

Int specifying the limit for number of XY data objects.

Return type:

int

getPathTolerance()

This method is used to get the tolerance used when creating XYData objects by extracting results along Path objects.

Returns:

A Double specifying the tolerance.

Return type:

float

graphicsInfo: GraphicsInfo = <abaqus.DisplayOptions.GraphicsInfo.GraphicsInfo object>

A GraphicsInfo object.

graphicsOptions: GraphicsOptions = <abaqus.DisplayOptions.GraphicsOptions.GraphicsOptions object>

A GraphicsOptions object.

imageAnimation: ImageAnimation = <abaqus.Animation.ImageAnimation.ImageAnimation object>

An ImageAnimation object.

imageAnimationOptions: ImageAnimationOptions = <abaqus.Animation.ImageAnimationOptions.ImageAnimationOptions object>

An ImageAnimationOptions object.

images: Dict[str, Image] = {}

A repository of Image objects.

isCADConnectionEnabled()

This method checks the status of CAD Connection.

Returns:

A Boolean value of True if the CAD connection enabled and False if the CAD connection disabled.

Return type:

Boolean

journalOptions: JournalOptions = <abaqus.Session.JournalOptions.JournalOptions object>

A JournalOptions object specifying how to record selection of geometry in the journal and replay files.

kernelMemoryFootprint: Optional[float] = None

A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.

kernelMemoryLimit: Optional[float] = None

A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.

kernelMemoryMaxFootprint: Optional[float] = None

A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.

linearizeStress(name, path, startPoint, endPoint, modelShape, components, xyMembraneComps, xyBendingComps, invariantBendingComps=(), intervals=40, radiusOfCurvature=None, oopRadiusOfCurvature=None, curvatureCorrection=OFF, curvatureCsys='', useCurvatureCsysForOrient=OFF, saveXy=OFF, writeReport=OFF, reportFile='', appendToFile=OFF, saveToPath=OFF)

This method is used to perform stress linearization along a defined stress line.

Note

Check XYSessionBase.linearizeStress on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the name of the stress line.

• path (str) – APath object specifying the end points of the stress line.Note:You must provide either the path argument or the startPoint and endPoint arguments.

• startPoint (str) – A String specifying a part instance and a node belonging to that part instance, or a sequence of three Floats specifying the coordinates of a point.

• endPoint (str) – A String specifying a part instance and a node belonging to that part instance, or a sequence of three Floats specifying the coordinates of a point.

• modelShape (SymbolicConstant) – A SymbolicConstant specifying the model shape to be used for obtaining coordinates of the intermediate points along the stress line. Possible values are UNDEFORMED and DEFORMED. When DEFORMED is selected, the deformation scale factor is always set to a uniform value of 1.0.

• components (tuple) – A sequence of Strings specifying the linearized stress components to be displayed in the xyPlot object. Possible values are “S11”, “S22”, “S33”, “S12”, “S23”, and “S13”.Note:You must provide at least one of the components , xyMembraneComps , and xyBendingComps arguments.

• xyMembraneComps (tuple) – A sequence of Strings specifying the linearized stress membrane components to be displayed in the xyPlot object. Possible values are “S11”, “S22”, “S33”, “S12”, “S23”, and “S13”.

• xyBendingComps (tuple) – A sequence of Strings specifying the linearized stress bending components to be displayed in the xyPlot object. Possible values are “S11”, “S22”, “S33”, “S12”, “S23”, and “S13”.

• invariantBendingComps (tuple, default: ()) – A sequence of Strings specifying the linearized stress bending components to be included in the computation of the linearized stress invariants. Possible values are “S11”, “S22”, “S33”, “S12”, “S23”, and “S13”. The default value of the sequence includes all the possible values.

• intervals (int, default: 40) – An Int specifying the number of equally-spaced intervals into which the stress line is to be divided. The default value is 40.

• radiusOfCurvature (Optional[float], default: None) – A Float specifying the in-plane radius of curvature of the center section along the stress line for axi-symmetric models. The default value is ∞∞.

• oopRadiusOfCurvature (Optional[float], default: None) – A Float specifying the out-of-plane radius of curvature of the center section along the Stress Line for axi-symmetric models. The default value forces Abaqus to compute the radius of curvature.

• curvatureCorrection (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the out-of-plane curvature correction should be applied for non-axisymmetric models when performing linearized stress computations. Curvature correction is always applied for axisymmetric models. The default value is OFF.

• curvatureCsys (str, default: '') – A String specifying the name of the user-defined local coordinate system to be used for computing the out-of-plane radius of curvature for non-axisymmetric models when curvatureCorrection =ON . The default value uses the global coordinate system to compute the out-of-plane radius of curvature.

• useCurvatureCsysForOrient (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to use the user-defined local coordinate system to compute the local stress line orientation for non-axisymmetric models when curvatureCorrection =ON and curvatureCsys is specified. The default value is OFF.

• saveXy (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to save the xyData objects created during the stress linearization operation to the session. The default value is OFF .

• writeReport (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to write the output from the stress linearization operation to a text file. The default value is ON .

• reportFile (str, default: '') – A String specifying the report file name. The default value is “linearStress.rpt”.

• appendToFile (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to append output from the stress linearization to the text file specified by the reportFile argument. The default value is ON .

• saveToPath (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether to create a Path object containing all the points used when performing the linearized stress computation. The default value is OFF . When this argument is set to ON , a Path object is created with the same name as that of the stress line and placed in the Path repository.

Returns:

A list of xyData objects.

Return type:

List[XYData]

Raises:

• TextError – The stress line passes through incompatible part instances. Results cannot be extracted.

• TextError – Specified variables cannot be used for extracting results along the stress line.

• TextError – Results for all the points along the stress line were not found. Selected end points and all intermediate sample points must lie within the current display group, and within solid continuum elements. Due to tolerance limitations, intermediate points lying on display group boundaries may fail to meet this criterion. Choose new end points, adjust the number of intervals along the line, or modify the current display group to obtain the stress linearization plot.

mdbData: Dict[str, MdbData] = {}

A repository of MdbData objects.

memoryReductionOptions: MemoryReductionOptions = <abaqus.Session.MemoryReductionOptions.MemoryReductionOptions object>

A MemoryReductionOptions object specifying options for running in reduced memory mode.

movies: Dict[str, Movie] = {}

A repository of Movie objects.

networkDatabaseConnectors: Dict[str, NetworkDatabaseConnector] = {}

A repository of NetworkDatabaseConnector objects.

nodeQuery: NodeQuery = <abaqus.PathAndProbe.NodeQuery.NodeQuery object>

A NodeQuery object specifying nodes and their coordinates in a path.

odbData: Dict[str, OdbData] = {}

A repository of OdbData objects.

odbs: Dict[str, Odb] = {}

A repository of Odb objects.

openOdb(name, path='', readOnly=OFF)

This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example:

import visualization
session.openOdb(name='myOdb', path='stress.odb', readOnly=True)

Note

Check SessionBase.openOdb on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository key. If the name is not the same as the path to the output database (.odb) file, the path must be specified as well. Additionally, to support backwards compatibility of the interface, if the name parameter is omitted, the path and name will be presumed to be the same.

• path (str, default: '') – A String specifying the path to an existing output database (.odb) file.

• readOnly (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the file will permit only read access or both read and write access. The initial value is TRUE when the output database file is opened from Abaqus/CAE, indicating that only read access will be permitted.

Returns:

An Odb object.

Return type:

Odb

Raises:

• OdbError – If the output database was generated by a previous release of Abaqus and needs upgrading, Run abaqus upgrade -job <newFilename> -odb <oldFileName> to upgrade it.

• OdbError – If the output database was generated by a newer release of Abaqus, and the installation of Abaqus needs upgrading.

• AbaqusError – If the file is not a valid database.

pageSetupOptions: PageSetupOptions = <abaqus.Print.PageSetupOptions.PageSetupOptions object>

A PageSetupOptions object.

paths: Dict[str, Path] = {}

A repository of Path objects.

pngOptions: PngOptions = <abaqus.Print.PngOptions.PngOptions object>

A PngOptions object.

printOptions: PrintOptions = <abaqus.Print.PrintOptions.PrintOptions object>

A PrintOptions object.

printToFile(fileName, format=abaqusConstants.PNG, canvasObjects=(), compression=OFF)

This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.

Note

Check SessionBase.printToFile on help.3ds.com/0.1..

Parameters:

• fileName (str) – 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, .svg, or .svgz).

• format (SymbolicConstant, default: PNG) – A SymbolicConstant specifying the image format. Possible values are PNG, SVG, TIFF, PS, and EPS. The default value is PNG.

• canvasObjects (Tuple[Canvas, ...], default: ()) – A sequence of canvas objects (viewports, text strings, or arrows) to print. The default is to print all canvas objects.

• compression (Union[AbaqusBoolean, bool], default: OFF) –

  A Boolean specifying the format for an SVG file. It is valid to use this argument only when format is SVG. Possible values are False (Uncompressed) and True (Compressed).

  Changed in version 2022: It is “only” valid to use this argument …

printToPrinter(printCommand='', numCopies=1, canvasObjects=())

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.

Note

Check SessionBase.printToPrinter on help.3ds.com/0.1..

Parameters:

• printCommand (str, default: '') –

  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 (int, default: 1) – An Int specifying the number of copies to print. Possible values are 1 ≤ numCopies ≤ 100. The default value is 1.

• canvasObjects (Tuple[Canvas, ...], default: ()) – A sequence of canvas objects (viewports, text strings, or arrows) to print. The default is to print all canvas objects.

Raises:

• SystemError – If printCommand is invalid.

• SystemError – If the print command fails.

• RangeError – If numCopies is out of range.

• TypeError – If compression is specified when format is not SVG.

probeOptions: ProbeOptions = <abaqus.PathAndProbe.ProbeOptions.ProbeOptions object>

A ProbeOptions object.

probeReport: ProbeReport = <abaqus.PathAndProbe.ProbeReport.ProbeReport object>

A ProbeReport object.

psOptions: PsOptions = <abaqus.Print.PsOptions.PsOptions object>

A PsOptions object.

queues: Dict[str, Queue] = {}

A repository of Queue objects.

quickTimeOptions: QuickTimeOptions = <abaqus.Animation.QuickTimeOptions.QuickTimeOptions object>

A QuickTimeOptions object.

replayInProgress: Boolean = OFF

A Boolean specifying whether Abaqus is executing a replay file.

saveOptions(directory)

This method saves your customized display settings.

Note

Check SessionBase.saveOptions on help.3ds.com/0.1..

Parameters:

directory (SymbolicConstant) – A SymbolicConstant specifying the directory in which Abaqus saves the file that will be used to restore your customized settings (abaqus_2021.gpr). Possible values are HOME and CURRENT.

scratchOdbs: Dict[str, ScratchOdb] = {}

A repository of ScratchOdb objects.

selectedProbeValues: SelectedProbeValues = <abaqus.PathAndProbe.SelectedProbeValues.SelectedProbeValues object>

A SelectedProbeValues object.

sessionState: Optional[dict] = None

A Dictionary object specifying the viewports and their associated models. The Dictionary key specifies the viewport name. The Dictionary value is a Dictionary specifying the model name.

setCADPortNumber(CADName, Port)

This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application. This port number is used to send the parameter information to the CAD system.

Note

Check SessionBase.setCADPortNumber on help.3ds.com/0.1..

Parameters:

• CADName (str) – A String specifying the CAD system for which the port number will be saved. The available options are ‘CATIA V5’ and ‘ CATIA V6’.

• Port (str) – An integer specifying the port number to be used by Abaqus/CAE to send the modified parameters to the CAD system.

setLimitForXYDataPlots(limit=None)

This method is used to set the limit for number of XY data objects while creating XYData from field output.

Note

Check XYSessionBase.setLimitForXYDataPlots on help.3ds.com/0.1..

Parameters:

limit (Optional[int], default: None) – None or an Int specifying the limit for number of XY data objects. The default value is no limit

Return type:

None .

setPathTolerance(tolerance=1e-05)

This method is used to set the tolerance to be used when creating XYData objects by extracting results along Path objects. This command should be exercised with caution since setting a value too low or too high may result in getting no results or unpredictable results.

Note

Check XYSessionBase.setPathTolerance on help.3ds.com/0.1..

Parameters:

tolerance (float, default: 1e-05) – A Double specifying the tolerance. The default value is 0.00001.

Return type:

None .

setValues(kernelMemoryLimit=None)

This method modifies the Session object.

Note

Check SessionBase.setValues on help.3ds.com/0.1..

Parameters:

kernelMemoryLimit (Optional[float], default: None) –

A Float specifying the memory limit value for the Abaqus/CAE kernel process in megabytes. If the limit is exceeded, Abaqus/CAE displays an error message.The default memory limit value for Windows 32-bit systems if not set is 1800 MB. Increasing the memory limit is not recommended unless you are using a Windows 32-bit system with the boot option /3GB /userva = SizeInMBytes to extend the amount of memory available for Abaqus/CAE. In this case the limit can be changed to 2800 MB.If the kernel memory size reaches the abq_ker_memory value or the virtual memory limit of the machine, the following message will be displayed:

Operation did not complete due to a memory allocation failure.

For optimal performance, the memory limit should be set to a value less than the physical amount of memory on the machine.The minimum setting allowed is 256 MB.

sketcherOptions: ConstrainedSketcherOptions = <abaqus.Sketcher.ConstrainedSketchOptions.ConstrainedSketcherOptions.ConstrainedSketcherOptions object>

A ConstrainedSketcherOptions object specifying common options for all sketches.

spectrums: Dict[str, Spectrum] = {}

A repository of Spectrum objects.

streams: Dict[str, Stream] = {}

A repository of Stream objects.

svgOptions: SvgOptions = <abaqus.Print.SvgOptions.SvgOptions object>

A SvgOptions object.

tiffOptions: TiffOptions = <abaqus.PredefinedField.TiffOptions.TiffOptions object>

A TiffOptions object.

updateCADParameters(modelName, CADName, parameterFile, CADPartFile, CADPartName='')

This method updates the parameters for the specified model using the specified parameter file.

Note

Check SessionBase.updateCADParameters on help.3ds.com/0.1..

Parameters:

• modelName (str) – A String specifying the model name to update.

• CADName (str) – A String specifying the CAD system for which Abaqus updates the parameters. The available options are ‘Pro/ENGINEER’, ‘CATIA V5’ and ‘CATIA V6’.

• parameterFile (str) – A parameter file containing the parameters that were exposed in the CAD system using the ABQ_ prefix.

• CADPartFile (str) – A file name specifying the CAD part file for which parameter update is triggered.For CADName = ‘CATIA V5’ or ‘CATIA V6’, you can specify either products or parts using this argument. If you specify a product, Abaqus updates all of the parts associated with that product.For CADName = ‘Pro/ENGINEER’, this argument is optional, and you can specify update for parts only. However, a single file can be associated with multiple parts in the case of family tables. In this case, Abaqus updates all listed parts.

• CADPartName (str, default: '') – An String specifying the part name to update. This part name should match the part name in the originating CAD system.If you specify neither CADPartFile nor CADPartName during an update in which you specified CADName = ‘Pro/ENGINEER’, Abaqus updates all of the parts in the specified file.

viewerOptions: ViewerOptions = <abaqus.OdbDisplay.ViewerOptions.ViewerOptions object>

A ViewerOptions object.

viewports: Dict[str, Viewport] = {}

A repository of Viewport objects.

views: Dict[str, View] = {}

A repository of View objects.

write3DXMLFile(fileName, format=OFF, canvasObjects=())

This method exports the current viewport objects to a file.

Note

Check SessionBase.write3DXMLFile on help.3ds.com/0.1..

Parameters:

• fileName (str) – A String specifying the file to which the graphics data is to be written. If no file extension is supplied, (.3dxml) will be added.

• format (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying the format. Possible values are False (Uncompressed) and True (Compressed).

• canvasObjects (Tuple[Canvas, ...], default: ()) – A sequence of canvas objects to export.

writeFieldReport(filename, append, sortItem, odb, step, frame, outputPosition, displayGroup, variable, numericForm=None, complexAngle=None, stepFrame=abaqusConstants.SPECIFY)

This method writes a FieldOutput object to a user-defined ASCII file.

Note

This function can be accessed by:

session.writeFieldReport

Note

Check FieldReportSession.writeFieldReport on help.3ds.com/0.1..

Parameters:

• filename (str) – A String specifying the name of the file to which field output will be written.

• append (Union[AbaqusBoolean, bool]) – A Boolean specifying whether to append the field output to an existing file. The default value is ON.

• sortItem (str) – A String specifying the item by which to sort the tabular values.

• odb (Odb) – An Odb object from which to obtain field output values.

• step (int) – An Int (or stepIndex) specifying the step from which to obtain field output values. Possible values are 0 ≤ step ≤ (numSteps − 1).

• frame (int) – An Int (or frameIndex) specifying the frame from which to obtain field output values. Possible values are 0 ≤ frame ≤ (numFramesInStep − 1).

• outputPosition (SymbolicConstant) – 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 (DisplayGroup) – A DisplayGroup object specifying the subset of the model for which to obtain data.

• variable (SymbolicConstant) –

  A sequence of variable description sequences specifying one or more field output variables for which to obtain data. Each variable description sequence contains the following elements:

  • element0: A String specifying the name of the variable.

  • element1: A SymbolicConstant specifying the output position at which to report data. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.

  • element2: A Sequence of tuples each consisting of a SymbolicConstant specifying the refinement (COMPONENT or INVARIANT), followed by a String specifying the name of a component or invariant for which to obtain values. If this element is omitted, data are written for all components and invariants (if applicable). This element is required if element3 (the following element in the tuple) is included.

  • element3 (if applicable): A Dictionary with a String key and a String value specifying a single section point at which to report data. The key specifies a region in the model; the corresponding value specifies a section point within that region. For example:

    {'shell < MAT > < 7 section points >': 'SPOS (fraction = 1.0)'}
    

    If this element is omitted, data are written for all section points (if applicable). If this element is omitted, data are written for all section points (if applicable).

• numericForm (Optional[SymbolicConstant], default: None) – 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 (Optional[float], default: None) – 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.

• stepFrame (SymbolicConstant, default: SPECIFY) – A SymbolicConstant indicating whether to obtain the values from the specified frame or from all active frames. Possible values are SPECIFY and ALL. The default value is SPECIFY.

writeFreeBodyReport(fileName, append, step=None, frame=None, stepFrame=abaqusConstants.SPECIFY, odb=None)

This method writes a FreeBody object to a user-defined ASCII file.

Note

This function can be accessed by:

session.writeFreeBodyReport

Note

Check FieldReportSession.writeFreeBodyReport on help.3ds.com/0.1..

Parameters:

• fileName (str) – A String specifying the name of the file to which the free body output will be written.

• append (Union[AbaqusBoolean, bool]) – A Boolean specifying whether to append the free body output to an existing file. The default value is ON.

• step (Optional[int], default: None) – An Int identifying the step from which to obtain values. The default value is the current step.

• frame (Optional[int], default: None) – An Int identifying the frame from which to obtain values. The default value is the current frame.

• stepFrame (SymbolicConstant, default: SPECIFY) – A SymbolicConstant indicating whether to obtain the values from the specified frame or from all active frames. Possible values are SPECIFY and ALL. The default value is SPECIFY.

• odb (Optional[Odb], default: None) – An Odb object specifying the output database from which data will be read.

writeImageAnimation(fileName, format, canvasObjects=())

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.

Note

Check AnimationSession.writeImageAnimation on help.3ds.com/0.1..

Parameters:

• fileName (str) – A String specifying the name of the animation file to generate.

• format (SymbolicConstant) – A SymbolicConstant specifying the format of the generated file. Possible values are AVI, QUICKTIME, VRML, and COMPRESSED_VRML.

• canvasObjects (tuple, default: ()) – A sequence specifying the canvas objects to capture. The default behavior is to capture all canvas objects.

writeOBJFile(fileName, canvasObjects=())

This method exports the current viewport objects to a file.

Note

Check SessionBase.writeOBJFile on help.3ds.com/0.1..

Parameters:

• fileName (str) – A String specifying the file to which the graphics data is to be written. If no file extension is supplied, (.obj) will be added.

• canvasObjects (Tuple[Canvas, ...], default: ()) – A sequence of canvas objects to export.

writeVrmlFile(fileName, format=OFF, canvasObjects=())

This method exports the current viewport objects to a file.

Note

Check SessionBase.writeVrmlFile on help.3ds.com/0.1..

Parameters:

• fileName (str) – 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).

• format (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying the format. Possible values are False (Uncompressed) and True (Compressed).

• canvasObjects (Tuple[Canvas, ...], default: ()) – A sequence of canvas objects (viewports, text strings, or arrows) to export.

xyColors: AutoColors = <abaqus.Session.AutoColors.AutoColors object>

An AutoColors object specifying the color palette to be used forXYCurve objects.

xyDataListFromField(odb, outputPosition, variable, elementSets=Ellipsis, elementLabels=Ellipsis, nodeSets=Ellipsis, nodeLabels=Ellipsis, numericForm=abaqusConstants.REAL, complexAngle=0, operator=Ellipsis)

This method creates a list of XYData objects by reading field data from an Odb object.

Note

This function can be accessed by:

session.xyDataListFromField
xyPlot.xyDataListFromField

Note

Check XYSession.xyDataListFromField on help.3ds.com/0.1..

Parameters:

• odb (Odb) – An Odb object specifying the output database from which data will be read.

• outputPosition (Literal[ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, NODAL]) – A SymbolicConstant specifying the position from which output will be read. Possible values are ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, and NODAL.

• variable (Tuple[Tuple[str, Literal[ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, WHOLE_REGION], Tuple[Tuple[Literal[INVARIANT, COMPONENT], str], ...]]]) –

  A tuple of tuples containing the descriptions of variables for which to extract data from the field. Each tuple specifies the following:

  • Variable label: A String specifying the variable; for example, ‘U’.

  • Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.

  • Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:

    • Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.

    • Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.

  • Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:

    • A String specifying the category selection label.

    • A String specifying the section point label.

  For example:

  variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
  variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
              ('U', NODAL,((COMPONENT, 'U1'), )), )
  variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
               {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )
  

• elementSets (Union[Tuple[str, ...], str], default: Ellipsis) – A sequence of Strings specifying element sets or a String specifying a single element set.

• elementLabels (Tuple[Tuple[str, Union[int, str]], ...], default: Ellipsis) –

  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.

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

• nodeSets (Union[str, Tuple[str, ...]], default: Ellipsis) – A sequence of Strings specifying node sets or a String specifying a single node set.

• nodeLabels (Tuple[Tuple[str, Union[int, str]], ...], default: Ellipsis) –

  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:

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

• numericForm (Literal[COMPLEX_MAGNITUDE, COMPLEX_PHASE, REAL, IMAGINARY, COMPLEX_VAL_AT_ANGLE], default: REAL) – 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_VAL_AT_ANGLE. The default value is REAL.

• complexAngle (float, default: 0) – A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.

• operator (Literal[ADD, SUBTRACT, MULTIPLY, DIVIDE, POWER, MINIMUM, MAXIMUM, AVERAGE, RANGE, SRSS, ABSOLUTE, UNARY_NEGATIVE, COSINE, HYPERBOLIC_COSINE, INVERSE_COSINE, SINE, HYPERBOLIC_SINE, INVERSE_SINE, TANGENT, HYPERBOLIC_TANGENT, INVERSE_TANGENT, EXPONENTIAL, NATURAL_LOG, LOG, SQUARE_ROOT, NORMALIZE, DEG2RAD, RAD2DEG, SMOOTH, SWAP, AVERAGE_ALL, MAXIMUM_ENVELOPE, MINIMUM_ENVELOPE, RANGE_ALL], default: Ellipsis) – A SymbolicConstant specifying the mathematical, trigonometric, logarithmic, exponential, or other operations. Possible values are ADD, SUBTRACT, MULTIPLY, DIVIDE, POWER, MINIMUM, MAXIMUM, AVERAGE, RANGE, SRSS, ABSOLUTE, UNARY_NEGATIVE, COSINE, HYPERBOLIC_COSINE, INVERSE_COSINE, SINE, HYPERBOLIC_SINE, INVERSE_SINE, TANGENT, HYPERBOLIC_TANGENT, INVERSE_TANGENT, EXPONENTIAL, NATURAL_LOG, LOG, SQUARE_ROOT, NORMALIZE, DEG2RAD, RAD2DEG, SMOOTH, SWAP, AVERAGE_ALL, MAXIMUM_ENVELOPE, MINIMUM_ENVELOPE, and RANGE_ALL. If no value is defined, no operation will be performed on the data, and the data will be saved as is.

Returns:

A list of XYData objects.

Return type:

List[XYData]

Raises:

• InvalidNameError –

• RangeError –

xyDataObjects: Dict[str, XYData] = {}

A repository of XYData objects.

xyPlots: Dict[str, XYPlot] = {}

A repository of XYPlot objects.

xyReportOptions: XYReportOptions = <abaqus.XY.XYReportOptions.XYReportOptions object>

An XYReportOptions object.

SessionBase

class SessionBase

The Session object has no constructor. Abaqus creates the session member when a session is started.

Note

This object can be accessed by:

session

Note

Check SessionBase on help.3ds.com/0.1..

Public Data Attributes:

attachedToGui	A Boolean specifying whether an Abaqus interactive session is running.
replayInProgress	A Boolean specifying whether Abaqus is executing a replay file.
kernelMemoryFootprint	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
kernelMemoryMaxFootprint	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
kernelMemoryLimit	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
colors	A repository of Color objects.
journalOptions	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
memoryReductionOptions	A MemoryReductionOptions object specifying options for running in reduced memory mode.
nodeQuery	A NodeQuery object specifying nodes and their coordinates in a path.
sketcherOptions	A ConstrainedSketcherOptions object specifying common options for all sketches.
viewerOptions	A ViewerOptions object.
animationOptions	An AnimationOptions object.
aviOptions	An AVIOptions object.
imageAnimationOptions	An ImageAnimationOptions object.
imageAnimation	An ImageAnimation object.
quickTimeOptions	A QuickTimeOptions object.
viewports	A repository of Viewport objects.
customData	A RepositorySupport object.
defaultFieldReportOptions	A FieldReportOptions object.
defaultFreeBodyReportOptions	A FreeBodyReportOptions object.
fieldReportOptions	A FieldReportOptions object.
freeBodyReportOptions	A FreeBodyReportOptions object.
odbs	A repository of Odb objects.
scratchOdbs	A repository of ScratchOdb objects.
defaultOdbDisplay	A DefaultOdbDisplay object.
defaultPlot	A DefaultPlot object.
defaultChartOptions	A DefaultChartOptions object.
odbData	A repository of OdbData objects.
mdbData	A repository of MdbData objects.
paths	A repository of Path objects.
freeBodies	A repository of FreeBody objects.
streams	A repository of Stream objects.
spectrums	A repository of Spectrum 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.
psOptions	A PsOptions object.
svgOptions	A SvgOptions object.
tiffOptions	A TiffOptions object.
autoColors	An AutoColors object specifying the color palette to be used for color coding.
xyColors	An AutoColors object specifying the color palette to be used forXYCurve objects.
xyDataObjects	A repository of XYData objects.
curves	A repository of XYCurve objects.
xyPlots	A repository of XYPlot objects.
charts	A repository of Chart objects.
defaultXYReportOptions	An XYReportOptions object.
xyReportOptions	An 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.
currentViewportName	A String specifying the name of the current viewport.
sessionState	A Dictionary object specifying the viewports and their associated models.
images	A repository of Image objects.
movies	A repository of Movie objects.
defaultLightOptions	A LightOptions object.
drawingArea	A DrawingArea object.
defaultMesherOptions	A MesherOptions object specifying how to control default settings in the Mesh module.
drawings	A repository of Drawing objects.

Public Methods:

setValues([kernelMemoryLimit])	This method modifies the Session object.
enableCADConnection(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
isCADConnectionEnabled()	This method checks the status of CAD Connection.
disableCADConnection(CADName)	This method disables an associative import CAD connection that was enabled.
enableParameterUpdate(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
setCADPortNumber(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
updateCADParameters(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
disableParameterUpdate(CADName)	This method disables an associative CAD connection using parameters.
printToFile(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
printToPrinter([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
saveOptions(directory)	This method saves your customized display settings.
writeVrmlFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
write3DXMLFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
writeOBJFile(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
openOdb(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

---

animationOptions: AnimationOptions = <abaqus.Animation.AnimationOptions.AnimationOptions object>

An AnimationOptions object.

attachedToGui: Union[AbaqusBoolean, bool] = OFF

A Boolean specifying whether an Abaqus interactive session is running.

autoColors: AutoColors = <abaqus.Session.AutoColors.AutoColors object>

An AutoColors object specifying the color palette to be used for color coding.

aviOptions: AVIOptions = <abaqus.Animation.AVIOptions.AVIOptions object>

An AVIOptions object.

charts: Dict[str, Chart] = {}

A repository of Chart objects.

colors: Dict[str, Color] = {}

A repository of Color objects.

currentProbeValues: CurrentProbeValues = <abaqus.PathAndProbe.CurrentProbeValues.CurrentProbeValues object>

A CurrentProbeValues object.

currentViewportName: str = ''

A String specifying the name of the current viewport.

curves: Dict[str, XYCurve] = {}

A repository of XYCurve objects.

customData: RepositorySupport = <abaqus.CustomKernel.RepositorySupport.RepositorySupport object>

A RepositorySupport object.

defaultChartOptions: DefaultChartOptions = <abaqus.XY.DefaultChartOptions.DefaultChartOptions object>

A DefaultChartOptions object.

defaultFieldReportOptions: FieldReportOptions = <abaqus.FieldReport.FieldReportOptions.FieldReportOptions object>

A FieldReportOptions object.

defaultFreeBodyReportOptions: FreeBodyReportOptions = <abaqus.FieldReport.FreeBodyReportOptions.FreeBodyReportOptions object>

A FreeBodyReportOptions object.

defaultGraphicsOptions: GraphicsOptions = <abaqus.DisplayOptions.GraphicsOptions.GraphicsOptions object>

A GraphicsOptions object.

defaultLightOptions: LightOptions = <abaqus.DisplayOptions.LightOptions.LightOptions object>

A LightOptions object.

defaultMesherOptions: MesherOptions = <abaqus.Mesh.MesherOptions.MesherOptions object>

A MesherOptions object specifying how to control default settings in the Mesh module.

defaultOdbDisplay: DefaultOdbDisplay = <abaqus.OdbDisplay.DefaultOdbDisplay.DefaultOdbDisplay object>

A DefaultOdbDisplay object.

defaultPlot: DefaultPlot = <abaqus.XY.DefaultPlot.DefaultPlot object>

A DefaultPlot object.

defaultProbeOptions: ProbeOptions = <abaqus.PathAndProbe.ProbeOptions.ProbeOptions object>

A ProbeOptions object.

defaultProbeReport: ProbeReport = <abaqus.PathAndProbe.ProbeReport.ProbeReport object>

A ProbeReport object.

defaultViewportAnnotationOptions: ViewportAnnotationOptions = <abaqus.DisplayOptions.ViewportAnnotationOptions.ViewportAnnotationOptions object>

A ViewportAnnotationOptions object.

defaultXYReportOptions: XYReportOptions = <abaqus.XY.XYReportOptions.XYReportOptions object>

An XYReportOptions object.

disableCADConnection(CADName)

This method disables an associative import CAD connection that was enabled.

Note

Check SessionBase.disableCADConnection on help.3ds.com/0.1..

Parameters:

CADName (str) – A String specifying the CAD system for which associative import will be disabled. Available options are Pro/ENGINEER, CATIA V5, and CATIA V6, NX and SolidWorks.

disableParameterUpdate(CADName)

This method disables an associative CAD connection using parameters.

Note

Check SessionBase.disableParameterUpdate on help.3ds.com/0.1..

Parameters:

CADName (str) – A String specifying the CAD system for which the parameter update will be disabled. Available option is Pro/ENGINEER.

displayGroups: Dict[str, DisplayGroup] = {}

A repository of DisplayGroup objects.

drawingArea: DrawingArea = <abaqus.Canvas.DrawingArea.DrawingArea object>

A DrawingArea object.

drawings: Dict[str, Drawing] = {}

A repository of Drawing objects.

enableCADConnection(CADName, portNum=None)

This method enables the Abaqus/CAE listening port for the specified CAD system.

Note

Check SessionBase.enableCADConnection on help.3ds.com/0.1..

Parameters:

• CADName (str) – A String specifying the CAD system. Available options are Pro/ENGINEER, CATIA V5, CATIA V6, NX and SolidWorks.

• portNum (Optional[int], default: None) – An Integer specifying the port number to be used by the CAD system to communicate with Abaqus/CAE. If unspecified, attempts will be made to identify an open port. The default ports used are as follow: Pro/E : 49178CATIA V5 : 49179SolidWorks : 49180NX : 49181CATIA V6 : 49182

Returns:

The connection port number used for the CAD connection.

Return type:

int

enableParameterUpdate(CADName, CADVersion, CADPort=None)

This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.

Note

Check SessionBase.enableParameterUpdate on help.3ds.com/0.1..

Parameters:

• CADName (str) – A String specifying the CAD system for which parameter update will be enabled. Available options are Pro/ENGINEER and NX.

• CADVersion (str) – A String specifying the CAD system version. Allowable options take the form of the specific CAD system plus a version string. Examples for Pro/ENGINEER are “Wildfire5” and “Creo4.” An NX example is “NX11.”

• CADPort (Optional[int], default: None) – An Integer specifying the port number to be used by Abaqus/CAE to communicate with the CAD system. If unspecified, attempts will be made to identify an open port. This port number is not the same as the portNum used by the associative import interface. The default CAD listening ports are as follow:ProE : 3344NX : 3344

epsOptions: EpsOptions = <abaqus.Print.EpsOptions.EpsOptions object>

An EpsOptions object.

fieldReportOptions: FieldReportOptions = <abaqus.FieldReport.FieldReportOptions.FieldReportOptions object>

A FieldReportOptions object.

freeBodies: Dict[str, FreeBody] = {}

A repository of FreeBody objects.

freeBodyReportOptions: FreeBodyReportOptions = <abaqus.FieldReport.FreeBodyReportOptions.FreeBodyReportOptions object>

A FreeBodyReportOptions object.

graphicsInfo: GraphicsInfo = <abaqus.DisplayOptions.GraphicsInfo.GraphicsInfo object>

A GraphicsInfo object.

graphicsOptions: GraphicsOptions = <abaqus.DisplayOptions.GraphicsOptions.GraphicsOptions object>

A GraphicsOptions object.

imageAnimation: ImageAnimation = <abaqus.Animation.ImageAnimation.ImageAnimation object>

An ImageAnimation object.

imageAnimationOptions: ImageAnimationOptions = <abaqus.Animation.ImageAnimationOptions.ImageAnimationOptions object>

An ImageAnimationOptions object.

images: Dict[str, Image] = {}

A repository of Image objects.

isCADConnectionEnabled()

This method checks the status of CAD Connection.

Returns:

A Boolean value of True if the CAD connection enabled and False if the CAD connection disabled.

Return type:

Boolean

journalOptions: JournalOptions = <abaqus.Session.JournalOptions.JournalOptions object>

A JournalOptions object specifying how to record selection of geometry in the journal and replay files.

kernelMemoryFootprint: Optional[float] = None

A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.

kernelMemoryLimit: Optional[float] = None

A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.

kernelMemoryMaxFootprint: Optional[float] = None

A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.

mdbData: Dict[str, MdbData] = {}

A repository of MdbData objects.

memoryReductionOptions: MemoryReductionOptions = <abaqus.Session.MemoryReductionOptions.MemoryReductionOptions object>

A MemoryReductionOptions object specifying options for running in reduced memory mode.

movies: Dict[str, Movie] = {}

A repository of Movie objects.

networkDatabaseConnectors: Dict[str, NetworkDatabaseConnector] = {}

A repository of NetworkDatabaseConnector objects.

nodeQuery: NodeQuery = <abaqus.PathAndProbe.NodeQuery.NodeQuery object>

A NodeQuery object specifying nodes and their coordinates in a path.

odbData: Dict[str, OdbData] = {}

A repository of OdbData objects.

odbs: Dict[str, Odb] = {}

A repository of Odb objects.

openOdb(name, path='', readOnly=OFF)

This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example:

import visualization
session.openOdb(name='myOdb', path='stress.odb', readOnly=True)

Note

Check SessionBase.openOdb on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository key. If the name is not the same as the path to the output database (.odb) file, the path must be specified as well. Additionally, to support backwards compatibility of the interface, if the name parameter is omitted, the path and name will be presumed to be the same.

• path (str, default: '') – A String specifying the path to an existing output database (.odb) file.

• readOnly (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the file will permit only read access or both read and write access. The initial value is TRUE when the output database file is opened from Abaqus/CAE, indicating that only read access will be permitted.

Returns:

An Odb object.

Return type:

Odb

Raises:

• OdbError – If the output database was generated by a previous release of Abaqus and needs upgrading, Run abaqus upgrade -job <newFilename> -odb <oldFileName> to upgrade it.

• OdbError – If the output database was generated by a newer release of Abaqus, and the installation of Abaqus needs upgrading.

• AbaqusError – If the file is not a valid database.

pageSetupOptions: PageSetupOptions = <abaqus.Print.PageSetupOptions.PageSetupOptions object>

A PageSetupOptions object.

paths: Dict[str, Path] = {}

A repository of Path objects.

pngOptions: PngOptions = <abaqus.Print.PngOptions.PngOptions object>

A PngOptions object.

printOptions: PrintOptions = <abaqus.Print.PrintOptions.PrintOptions object>

A PrintOptions object.

printToFile(fileName, format=abaqusConstants.PNG, canvasObjects=(), compression=OFF)

This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.

Note

Check SessionBase.printToFile on help.3ds.com/0.1..

Parameters:

• fileName (str) – 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, .svg, or .svgz).

• format (SymbolicConstant, default: PNG) – A SymbolicConstant specifying the image format. Possible values are PNG, SVG, TIFF, PS, and EPS. The default value is PNG.

• canvasObjects (Tuple[Canvas, ...], default: ()) – A sequence of canvas objects (viewports, text strings, or arrows) to print. The default is to print all canvas objects.

• compression (Union[AbaqusBoolean, bool], default: OFF) –

  A Boolean specifying the format for an SVG file. It is valid to use this argument only when format is SVG. Possible values are False (Uncompressed) and True (Compressed).

  Changed in version 2022: It is “only” valid to use this argument …

printToPrinter(printCommand='', numCopies=1, canvasObjects=())

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.

Note

Check SessionBase.printToPrinter on help.3ds.com/0.1..

Parameters:

• printCommand (str, default: '') –

  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 (int, default: 1) – An Int specifying the number of copies to print. Possible values are 1 ≤ numCopies ≤ 100. The default value is 1.

• canvasObjects (Tuple[Canvas, ...], default: ()) – A sequence of canvas objects (viewports, text strings, or arrows) to print. The default is to print all canvas objects.

Raises:

• SystemError – If printCommand is invalid.

• SystemError – If the print command fails.

• RangeError – If numCopies is out of range.

• TypeError – If compression is specified when format is not SVG.

probeOptions: ProbeOptions = <abaqus.PathAndProbe.ProbeOptions.ProbeOptions object>

A ProbeOptions object.

probeReport: ProbeReport = <abaqus.PathAndProbe.ProbeReport.ProbeReport object>

A ProbeReport object.

psOptions: PsOptions = <abaqus.Print.PsOptions.PsOptions object>

A PsOptions object.

queues: Dict[str, Queue] = {}

A repository of Queue objects.

quickTimeOptions: QuickTimeOptions = <abaqus.Animation.QuickTimeOptions.QuickTimeOptions object>

A QuickTimeOptions object.

replayInProgress: Union[AbaqusBoolean, bool] = OFF

A Boolean specifying whether Abaqus is executing a replay file.

saveOptions(directory)

This method saves your customized display settings.

Note

Check SessionBase.saveOptions on help.3ds.com/0.1..

Parameters:

directory (SymbolicConstant) – A SymbolicConstant specifying the directory in which Abaqus saves the file that will be used to restore your customized settings (abaqus_2021.gpr). Possible values are HOME and CURRENT.

scratchOdbs: Dict[str, ScratchOdb] = {}

A repository of ScratchOdb objects.

selectedProbeValues: SelectedProbeValues = <abaqus.PathAndProbe.SelectedProbeValues.SelectedProbeValues object>

A SelectedProbeValues object.

sessionState: Optional[dict] = None

A Dictionary object specifying the viewports and their associated models. The Dictionary key specifies the viewport name. The Dictionary value is a Dictionary specifying the model name.

setCADPortNumber(CADName, Port)

This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application. This port number is used to send the parameter information to the CAD system.

Note

Check SessionBase.setCADPortNumber on help.3ds.com/0.1..

Parameters:

• CADName (str) – A String specifying the CAD system for which the port number will be saved. The available options are ‘CATIA V5’ and ‘ CATIA V6’.

• Port (str) – An integer specifying the port number to be used by Abaqus/CAE to send the modified parameters to the CAD system.

setValues(kernelMemoryLimit=None)

This method modifies the Session object.

Note

Check SessionBase.setValues on help.3ds.com/0.1..

Parameters:

kernelMemoryLimit (Optional[float], default: None) –

A Float specifying the memory limit value for the Abaqus/CAE kernel process in megabytes. If the limit is exceeded, Abaqus/CAE displays an error message.The default memory limit value for Windows 32-bit systems if not set is 1800 MB. Increasing the memory limit is not recommended unless you are using a Windows 32-bit system with the boot option /3GB /userva = SizeInMBytes to extend the amount of memory available for Abaqus/CAE. In this case the limit can be changed to 2800 MB.If the kernel memory size reaches the abq_ker_memory value or the virtual memory limit of the machine, the following message will be displayed:

Operation did not complete due to a memory allocation failure.

For optimal performance, the memory limit should be set to a value less than the physical amount of memory on the machine.The minimum setting allowed is 256 MB.

sketcherOptions: ConstrainedSketcherOptions = <abaqus.Sketcher.ConstrainedSketchOptions.ConstrainedSketcherOptions.ConstrainedSketcherOptions object>

A ConstrainedSketcherOptions object specifying common options for all sketches.

spectrums: Dict[str, Spectrum] = {}

A repository of Spectrum objects.

streams: Dict[str, Stream] = {}

A repository of Stream objects.

svgOptions: SvgOptions = <abaqus.Print.SvgOptions.SvgOptions object>

A SvgOptions object.

tiffOptions: TiffOptions = <abaqus.PredefinedField.TiffOptions.TiffOptions object>

A TiffOptions object.

updateCADParameters(modelName, CADName, parameterFile, CADPartFile, CADPartName='')

This method updates the parameters for the specified model using the specified parameter file.

Note

Check SessionBase.updateCADParameters on help.3ds.com/0.1..

Parameters:

• modelName (str) – A String specifying the model name to update.

• CADName (str) – A String specifying the CAD system for which Abaqus updates the parameters. The available options are ‘Pro/ENGINEER’, ‘CATIA V5’ and ‘CATIA V6’.

• parameterFile (str) – A parameter file containing the parameters that were exposed in the CAD system using the ABQ_ prefix.

• CADPartFile (str) – A file name specifying the CAD part file for which parameter update is triggered.For CADName = ‘CATIA V5’ or ‘CATIA V6’, you can specify either products or parts using this argument. If you specify a product, Abaqus updates all of the parts associated with that product.For CADName = ‘Pro/ENGINEER’, this argument is optional, and you can specify update for parts only. However, a single file can be associated with multiple parts in the case of family tables. In this case, Abaqus updates all listed parts.

• CADPartName (str, default: '') – An String specifying the part name to update. This part name should match the part name in the originating CAD system.If you specify neither CADPartFile nor CADPartName during an update in which you specified CADName = ‘Pro/ENGINEER’, Abaqus updates all of the parts in the specified file.

viewerOptions: ViewerOptions = <abaqus.OdbDisplay.ViewerOptions.ViewerOptions object>

A ViewerOptions object.

viewports: Dict[str, Viewport] = {}

A repository of Viewport objects.

views: Dict[str, View] = {}

A repository of View objects.

write3DXMLFile(fileName, format=OFF, canvasObjects=())

This method exports the current viewport objects to a file.

Note

Check SessionBase.write3DXMLFile on help.3ds.com/0.1..

Parameters:

• fileName (str) – A String specifying the file to which the graphics data is to be written. If no file extension is supplied, (.3dxml) will be added.

• format (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying the format. Possible values are False (Uncompressed) and True (Compressed).

• canvasObjects (Tuple[Canvas, ...], default: ()) – A sequence of canvas objects to export.

writeOBJFile(fileName, canvasObjects=())

This method exports the current viewport objects to a file.

Note

Check SessionBase.writeOBJFile on help.3ds.com/0.1..

Parameters:

• fileName (str) – A String specifying the file to which the graphics data is to be written. If no file extension is supplied, (.obj) will be added.

• canvasObjects (Tuple[Canvas, ...], default: ()) – A sequence of canvas objects to export.

writeVrmlFile(fileName, format=OFF, canvasObjects=())

This method exports the current viewport objects to a file.

Note

Check SessionBase.writeVrmlFile on help.3ds.com/0.1..

Parameters:

• fileName (str) – 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).

• format (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying the format. Possible values are False (Uncompressed) and True (Compressed).

• canvasObjects (Tuple[Canvas, ...], default: ()) – A sequence of canvas objects (viewports, text strings, or arrows) to export.

xyColors: AutoColors = <abaqus.Session.AutoColors.AutoColors object>

An AutoColors object specifying the color palette to be used forXYCurve objects.

xyDataObjects: Dict[str, XYData] = {}

A repository of XYData objects.

xyPlots: Dict[str, XYPlot] = {}

A repository of XYPlot objects.

xyReportOptions: XYReportOptions = <abaqus.XY.XYReportOptions.XYReportOptions object>

An XYReportOptions object.

AnimationSession

class AnimationSession

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

Note

This object can be accessed by:

import animation

Note

Check AnimationSession on help.3ds.com/0.1..

Public Data Attributes:

Inherited from SessionBase

attachedToGui	A Boolean specifying whether an Abaqus interactive session is running.
replayInProgress	A Boolean specifying whether Abaqus is executing a replay file.
kernelMemoryFootprint	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
kernelMemoryMaxFootprint	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
kernelMemoryLimit	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
colors	A repository of Color objects.
journalOptions	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
memoryReductionOptions	A MemoryReductionOptions object specifying options for running in reduced memory mode.
nodeQuery	A NodeQuery object specifying nodes and their coordinates in a path.
sketcherOptions	A ConstrainedSketcherOptions object specifying common options for all sketches.
viewerOptions	A ViewerOptions object.
animationOptions	An AnimationOptions object.
aviOptions	An AVIOptions object.
imageAnimationOptions	An ImageAnimationOptions object.
imageAnimation	An ImageAnimation object.
quickTimeOptions	A QuickTimeOptions object.
viewports	A repository of Viewport objects.
customData	A RepositorySupport object.
defaultFieldReportOptions	A FieldReportOptions object.
defaultFreeBodyReportOptions	A FreeBodyReportOptions object.
fieldReportOptions	A FieldReportOptions object.
freeBodyReportOptions	A FreeBodyReportOptions object.
odbs	A repository of Odb objects.
scratchOdbs	A repository of ScratchOdb objects.
defaultOdbDisplay	A DefaultOdbDisplay object.
defaultPlot	A DefaultPlot object.
defaultChartOptions	A DefaultChartOptions object.
odbData	A repository of OdbData objects.
mdbData	A repository of MdbData objects.
paths	A repository of Path objects.
freeBodies	A repository of FreeBody objects.
streams	A repository of Stream objects.
spectrums	A repository of Spectrum 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.
psOptions	A PsOptions object.
svgOptions	A SvgOptions object.
tiffOptions	A TiffOptions object.
autoColors	An AutoColors object specifying the color palette to be used for color coding.
xyColors	An AutoColors object specifying the color palette to be used forXYCurve objects.
xyDataObjects	A repository of XYData objects.
curves	A repository of XYCurve objects.
xyPlots	A repository of XYPlot objects.
charts	A repository of Chart objects.
defaultXYReportOptions	An XYReportOptions object.
xyReportOptions	An 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.
currentViewportName	A String specifying the name of the current viewport.
sessionState	A Dictionary object specifying the viewports and their associated models.
images	A repository of Image objects.
movies	A repository of Movie objects.
defaultLightOptions	A LightOptions object.
drawingArea	A DrawingArea object.
defaultMesherOptions	A MesherOptions object specifying how to control default settings in the Mesh module.
drawings	A repository of Drawing objects.

Public Methods:

writeImageAnimation(fileName, format[, ...])	This method writes the animations present in the list of canvas objects to a file.
Movie(name, fileName[, startFrame, ...])	This method creates a Movie object from the contents of the specified file.

Inherited from SessionBase

setValues([kernelMemoryLimit])	This method modifies the Session object.
enableCADConnection(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
isCADConnectionEnabled()	This method checks the status of CAD Connection.
disableCADConnection(CADName)	This method disables an associative import CAD connection that was enabled.
enableParameterUpdate(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
setCADPortNumber(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
updateCADParameters(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
disableParameterUpdate(CADName)	This method disables an associative CAD connection using parameters.
printToFile(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
printToPrinter([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
saveOptions(directory)	This method saves your customized display settings.
writeVrmlFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
write3DXMLFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
writeOBJFile(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
openOdb(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

---

Movie(name, fileName, startFrame=0, endFrame=None, timelineStartFrame=0, timelineEndFrame=None, timelineStartTime=0, timelineEndTime=abaqusConstants.END_FRAME_TIME)

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

Note

This function can be accessed by:

session.Movie

Note

Check Movie on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository name for the movie.

• fileName (str) – A String specifying the file from which the movie is to be read. The file extension must be specified and indicates the movie format (.avi, .mov, .mpeg, or .wmv).

• startFrame (int, default: 0) – An Int specifying the first frame to be displayed from this movie. The default value is 0.

• endFrame (Optional[int], default: None) – An Int specifying the last frame to be displayed from this movie. A negative number will indicate reverse numbering: -1 is the last frame of the movie. The default value is −1.

• timelineStartFrame (int, default: 0) – An Int specifying the global timeline frame number that corresponds to startFrame. A value of 0 will indicate the first frame to be displayed in the viewport. The default value is 0.

• timelineEndFrame (Optional[int], default: None) – An Int specifying the global timeline frame number that corresponds to endFrame. A negative number will indicate reverse numbering: -1 indicates the last frame to be displayed in the viewport. The default value is −1.

• timelineStartTime (float, default: 0) – A Float specifying the global timeline time that corresponds to the time of startFrame. The default value is 0.0.

• timelineEndTime (Union[SymbolicConstant, float], default: END_FRAME_TIME) – The SymbolicConstant END_FRAME_TIME or a Float specifying the global timeline time that corresponds to the time of endFrame. The SymbolicConstant END_FRAME_TIME indicates the time in this movie corresponding to endFrame. The default value is END_FRAME_TIME.

Returns:

A Movie object.

Return type:

Movie

Raises:

• ValueError – If fileName does not exist or can not be read.

• ValueError – If fileName references an unsupported movie file format

• ValueError – If the contents of fileName are corrupt or can not be decoded.

writeImageAnimation(fileName, format, canvasObjects=())

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.

Note

Check AnimationSession.writeImageAnimation on help.3ds.com/0.1..

Parameters:

• fileName (str) – A String specifying the name of the animation file to generate.

• format (SymbolicConstant) – A SymbolicConstant specifying the format of the generated file. Possible values are AVI, QUICKTIME, VRML, and COMPRESSED_VRML.

• canvasObjects (tuple, default: ()) – A sequence specifying the canvas objects to capture. The default behavior is to capture all canvas objects.

CanvasSession

class CanvasSession

Public Data Attributes:

Inherited from SessionBase

attachedToGui	A Boolean specifying whether an Abaqus interactive session is running.
replayInProgress	A Boolean specifying whether Abaqus is executing a replay file.
kernelMemoryFootprint	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
kernelMemoryMaxFootprint	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
kernelMemoryLimit	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
colors	A repository of Color objects.
journalOptions	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
memoryReductionOptions	A MemoryReductionOptions object specifying options for running in reduced memory mode.
nodeQuery	A NodeQuery object specifying nodes and their coordinates in a path.
sketcherOptions	A ConstrainedSketcherOptions object specifying common options for all sketches.
viewerOptions	A ViewerOptions object.
animationOptions	An AnimationOptions object.
aviOptions	An AVIOptions object.
imageAnimationOptions	An ImageAnimationOptions object.
imageAnimation	An ImageAnimation object.
quickTimeOptions	A QuickTimeOptions object.
viewports	A repository of Viewport objects.
customData	A RepositorySupport object.
defaultFieldReportOptions	A FieldReportOptions object.
defaultFreeBodyReportOptions	A FreeBodyReportOptions object.
fieldReportOptions	A FieldReportOptions object.
freeBodyReportOptions	A FreeBodyReportOptions object.
odbs	A repository of Odb objects.
scratchOdbs	A repository of ScratchOdb objects.
defaultOdbDisplay	A DefaultOdbDisplay object.
defaultPlot	A DefaultPlot object.
defaultChartOptions	A DefaultChartOptions object.
odbData	A repository of OdbData objects.
mdbData	A repository of MdbData objects.
paths	A repository of Path objects.
freeBodies	A repository of FreeBody objects.
streams	A repository of Stream objects.
spectrums	A repository of Spectrum 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.
psOptions	A PsOptions object.
svgOptions	A SvgOptions object.
tiffOptions	A TiffOptions object.
autoColors	An AutoColors object specifying the color palette to be used for color coding.
xyColors	An AutoColors object specifying the color palette to be used forXYCurve objects.
xyDataObjects	A repository of XYData objects.
curves	A repository of XYCurve objects.
xyPlots	A repository of XYPlot objects.
charts	A repository of Chart objects.
defaultXYReportOptions	An XYReportOptions object.
xyReportOptions	An 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.
currentViewportName	A String specifying the name of the current viewport.
sessionState	A Dictionary object specifying the viewports and their associated models.
images	A repository of Image objects.
movies	A repository of Movie objects.
defaultLightOptions	A LightOptions object.
drawingArea	A DrawingArea object.
defaultMesherOptions	A MesherOptions object specifying how to control default settings in the Mesh module.
drawings	A repository of Drawing objects.

Public Methods:

Viewport(name[, origin, width, height, ...])

This method creates a Viewport object with the specified origin and dimensions.

Inherited from SessionBase

setValues([kernelMemoryLimit])	This method modifies the Session object.
enableCADConnection(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
isCADConnectionEnabled()	This method checks the status of CAD Connection.
disableCADConnection(CADName)	This method disables an associative import CAD connection that was enabled.
enableParameterUpdate(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
setCADPortNumber(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
updateCADParameters(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
disableParameterUpdate(CADName)	This method disables an associative CAD connection using parameters.
printToFile(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
printToPrinter([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
saveOptions(directory)	This method saves your customized display settings.
writeVrmlFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
write3DXMLFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
writeOBJFile(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
openOdb(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

---

Viewport(name, origin=(0.0, 0.0), width=120.0, height=80.0, border=ON, titleBar=ON, titleStyle=abaqusConstants.SYSTEM, customTitleString='')

This method creates a Viewport object with the specified origin and dimensions.

Note

This function can be accessed by:

session.Viewport

Note

Check Viewport on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository key.

• origin (Tuple[float, float], default: (0.0, 0.0)) – 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 (float, default: 120.0) – A Float specifying the width in millimeters of the viewport. Possible values are 30 ≤ width ≤ (maxWidth). The default value is 120.0. Note: The maximum value of width (maxWidth) is the width of the screen in millimeters.

• height (float, default: 80.0) – A Float specifying the height in millimeters of the viewport. This height includes the title bar. Possible values are 30 ≤ height ≤ (maxHeight). The default value is 80.0. Note: The maximum value of height (maxHeight) is the height of the screen in millimeters.

• border (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether the viewport border is visible in a printed image. The default value is ON.

• titleBar (Union[AbaqusBoolean, bool], default: ON) – 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 (SymbolicConstant, default: SYSTEM) – A SymbolicConstant specifying which title to use for the viewport title. Possible values are CUSTOM and SYSTEM. The default value is SYSTEM.If titleStyle = CUSTOM, customTitleString will be used. If titleStyle = SYSTEM, a system-generated string will be used.

• customTitleString (str, default: '') – A String specifying the viewport title when titleStyle =CUSTOM. The default value is an empty string.

Returns:

A Viewport object.

Return type:

Viewport

Raises:

• SystemError – If the user attempts to delete the only viewport.

• RangeError – If width is out of range.

• RangeError – If height is out of range.

DisplayGroupSession

class DisplayGroupSession

Public Data Attributes:

Inherited from SessionBase

attachedToGui	A Boolean specifying whether an Abaqus interactive session is running.
replayInProgress	A Boolean specifying whether Abaqus is executing a replay file.
kernelMemoryFootprint	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
kernelMemoryMaxFootprint	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
kernelMemoryLimit	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
colors	A repository of Color objects.
journalOptions	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
memoryReductionOptions	A MemoryReductionOptions object specifying options for running in reduced memory mode.
nodeQuery	A NodeQuery object specifying nodes and their coordinates in a path.
sketcherOptions	A ConstrainedSketcherOptions object specifying common options for all sketches.
viewerOptions	A ViewerOptions object.
animationOptions	An AnimationOptions object.
aviOptions	An AVIOptions object.
imageAnimationOptions	An ImageAnimationOptions object.
imageAnimation	An ImageAnimation object.
quickTimeOptions	A QuickTimeOptions object.
viewports	A repository of Viewport objects.
customData	A RepositorySupport object.
defaultFieldReportOptions	A FieldReportOptions object.
defaultFreeBodyReportOptions	A FreeBodyReportOptions object.
fieldReportOptions	A FieldReportOptions object.
freeBodyReportOptions	A FreeBodyReportOptions object.
odbs	A repository of Odb objects.
scratchOdbs	A repository of ScratchOdb objects.
defaultOdbDisplay	A DefaultOdbDisplay object.
defaultPlot	A DefaultPlot object.
defaultChartOptions	A DefaultChartOptions object.
odbData	A repository of OdbData objects.
mdbData	A repository of MdbData objects.
paths	A repository of Path objects.
freeBodies	A repository of FreeBody objects.
streams	A repository of Stream objects.
spectrums	A repository of Spectrum 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.
psOptions	A PsOptions object.
svgOptions	A SvgOptions object.
tiffOptions	A TiffOptions object.
autoColors	An AutoColors object specifying the color palette to be used for color coding.
xyColors	An AutoColors object specifying the color palette to be used forXYCurve objects.
xyDataObjects	A repository of XYData objects.
curves	A repository of XYCurve objects.
xyPlots	A repository of XYPlot objects.
charts	A repository of Chart objects.
defaultXYReportOptions	An XYReportOptions object.
xyReportOptions	An 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.
currentViewportName	A String specifying the name of the current viewport.
sessionState	A Dictionary object specifying the viewports and their associated models.
images	A repository of Image objects.
movies	A repository of Movie objects.
defaultLightOptions	A LightOptions object.
drawingArea	A DrawingArea object.
defaultMesherOptions	A MesherOptions object specifying how to control default settings in the Mesh module.
drawings	A repository of Drawing objects.

Public Methods:

DisplayGroup(name, leaf)

This method creates a DisplayGroup object.

Inherited from SessionBase

setValues([kernelMemoryLimit])	This method modifies the Session object.
enableCADConnection(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
isCADConnectionEnabled()	This method checks the status of CAD Connection.
disableCADConnection(CADName)	This method disables an associative import CAD connection that was enabled.
enableParameterUpdate(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
setCADPortNumber(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
updateCADParameters(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
disableParameterUpdate(CADName)	This method disables an associative CAD connection using parameters.
printToFile(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
printToPrinter([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
saveOptions(directory)	This method saves your customized display settings.
writeVrmlFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
write3DXMLFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
writeOBJFile(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
openOdb(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

---

DisplayGroup(name, leaf)

This method creates a DisplayGroup object.

Note

This function can be accessed by:

session.DisplayGroup

Note

Check DisplayGroup on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository key.

• leaf (Leaf) – A Leaf object specifying the items in the display group.

Returns:

A DisplayGroup object.

Return type:

DisplayGroup

FieldReportSession

class FieldReportSession

Public Data Attributes:

Inherited from SessionBase

attachedToGui	A Boolean specifying whether an Abaqus interactive session is running.
replayInProgress	A Boolean specifying whether Abaqus is executing a replay file.
kernelMemoryFootprint	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
kernelMemoryMaxFootprint	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
kernelMemoryLimit	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
colors	A repository of Color objects.
journalOptions	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
memoryReductionOptions	A MemoryReductionOptions object specifying options for running in reduced memory mode.
nodeQuery	A NodeQuery object specifying nodes and their coordinates in a path.
sketcherOptions	A ConstrainedSketcherOptions object specifying common options for all sketches.
viewerOptions	A ViewerOptions object.
animationOptions	An AnimationOptions object.
aviOptions	An AVIOptions object.
imageAnimationOptions	An ImageAnimationOptions object.
imageAnimation	An ImageAnimation object.
quickTimeOptions	A QuickTimeOptions object.
viewports	A repository of Viewport objects.
customData	A RepositorySupport object.
defaultFieldReportOptions	A FieldReportOptions object.
defaultFreeBodyReportOptions	A FreeBodyReportOptions object.
fieldReportOptions	A FieldReportOptions object.
freeBodyReportOptions	A FreeBodyReportOptions object.
odbs	A repository of Odb objects.
scratchOdbs	A repository of ScratchOdb objects.
defaultOdbDisplay	A DefaultOdbDisplay object.
defaultPlot	A DefaultPlot object.
defaultChartOptions	A DefaultChartOptions object.
odbData	A repository of OdbData objects.
mdbData	A repository of MdbData objects.
paths	A repository of Path objects.
freeBodies	A repository of FreeBody objects.
streams	A repository of Stream objects.
spectrums	A repository of Spectrum 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.
psOptions	A PsOptions object.
svgOptions	A SvgOptions object.
tiffOptions	A TiffOptions object.
autoColors	An AutoColors object specifying the color palette to be used for color coding.
xyColors	An AutoColors object specifying the color palette to be used forXYCurve objects.
xyDataObjects	A repository of XYData objects.
curves	A repository of XYCurve objects.
xyPlots	A repository of XYPlot objects.
charts	A repository of Chart objects.
defaultXYReportOptions	An XYReportOptions object.
xyReportOptions	An 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.
currentViewportName	A String specifying the name of the current viewport.
sessionState	A Dictionary object specifying the viewports and their associated models.
images	A repository of Image objects.
movies	A repository of Movie objects.
defaultLightOptions	A LightOptions object.
drawingArea	A DrawingArea object.
defaultMesherOptions	A MesherOptions object specifying how to control default settings in the Mesh module.
drawings	A repository of Drawing objects.

Public Methods:

writeFieldReport(filename, append, sortItem, ...)	This method writes a FieldOutput object to a user-defined ASCII file.
writeFreeBodyReport(fileName, append[, ...])	This method writes a FreeBody object to a user-defined ASCII file.

Inherited from SessionBase

setValues([kernelMemoryLimit])	This method modifies the Session object.
enableCADConnection(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
isCADConnectionEnabled()	This method checks the status of CAD Connection.
disableCADConnection(CADName)	This method disables an associative import CAD connection that was enabled.
enableParameterUpdate(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
setCADPortNumber(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
updateCADParameters(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
disableParameterUpdate(CADName)	This method disables an associative CAD connection using parameters.
printToFile(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
printToPrinter([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
saveOptions(directory)	This method saves your customized display settings.
writeVrmlFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
write3DXMLFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
writeOBJFile(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
openOdb(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

---

writeFieldReport(filename, append, sortItem, odb, step, frame, outputPosition, displayGroup, variable, numericForm=None, complexAngle=None, stepFrame=abaqusConstants.SPECIFY)

This method writes a FieldOutput object to a user-defined ASCII file.

Note

This function can be accessed by:

session.writeFieldReport

Note

Check FieldReportSession.writeFieldReport on help.3ds.com/0.1..

Parameters:

• filename (str) – A String specifying the name of the file to which field output will be written.

• append (Union[AbaqusBoolean, bool]) – A Boolean specifying whether to append the field output to an existing file. The default value is ON.

• sortItem (str) – A String specifying the item by which to sort the tabular values.

• odb (Odb) – An Odb object from which to obtain field output values.

• step (int) – An Int (or stepIndex) specifying the step from which to obtain field output values. Possible values are 0 ≤ step ≤ (numSteps − 1).

• frame (int) – An Int (or frameIndex) specifying the frame from which to obtain field output values. Possible values are 0 ≤ frame ≤ (numFramesInStep − 1).

• outputPosition (SymbolicConstant) – 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 (DisplayGroup) – A DisplayGroup object specifying the subset of the model for which to obtain data.

• variable (SymbolicConstant) –

  A sequence of variable description sequences specifying one or more field output variables for which to obtain data. Each variable description sequence contains the following elements:

  • element0: A String specifying the name of the variable.

  • element1: A SymbolicConstant specifying the output position at which to report data. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.

  • element2: A Sequence of tuples each consisting of a SymbolicConstant specifying the refinement (COMPONENT or INVARIANT), followed by a String specifying the name of a component or invariant for which to obtain values. If this element is omitted, data are written for all components and invariants (if applicable). This element is required if element3 (the following element in the tuple) is included.

  • element3 (if applicable): A Dictionary with a String key and a String value specifying a single section point at which to report data. The key specifies a region in the model; the corresponding value specifies a section point within that region. For example:

    {'shell < MAT > < 7 section points >': 'SPOS (fraction = 1.0)'}
    

    If this element is omitted, data are written for all section points (if applicable). If this element is omitted, data are written for all section points (if applicable).

• numericForm (Optional[SymbolicConstant], default: None) – 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 (Optional[float], default: None) – 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.

• stepFrame (SymbolicConstant, default: SPECIFY) – A SymbolicConstant indicating whether to obtain the values from the specified frame or from all active frames. Possible values are SPECIFY and ALL. The default value is SPECIFY.

writeFreeBodyReport(fileName, append, step=None, frame=None, stepFrame=abaqusConstants.SPECIFY, odb=None)

This method writes a FreeBody object to a user-defined ASCII file.

Note

This function can be accessed by:

session.writeFreeBodyReport

Note

Check FieldReportSession.writeFreeBodyReport on help.3ds.com/0.1..

Parameters:

• fileName (str) – A String specifying the name of the file to which the free body output will be written.

• append (Union[AbaqusBoolean, bool]) – A Boolean specifying whether to append the free body output to an existing file. The default value is ON.

• step (Optional[int], default: None) – An Int identifying the step from which to obtain values. The default value is the current step.

• frame (Optional[int], default: None) – An Int identifying the frame from which to obtain values. The default value is the current frame.

• stepFrame (SymbolicConstant, default: SPECIFY) – A SymbolicConstant indicating whether to obtain the values from the specified frame or from all active frames. Possible values are SPECIFY and ALL. The default value is SPECIFY.

• odb (Optional[Odb], default: None) – An Odb object specifying the output database from which data will be read.

JobSession

class JobSession

Public Data Attributes:

Inherited from SessionBase

attachedToGui	A Boolean specifying whether an Abaqus interactive session is running.
replayInProgress	A Boolean specifying whether Abaqus is executing a replay file.
kernelMemoryFootprint	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
kernelMemoryMaxFootprint	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
kernelMemoryLimit	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
colors	A repository of Color objects.
journalOptions	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
memoryReductionOptions	A MemoryReductionOptions object specifying options for running in reduced memory mode.
nodeQuery	A NodeQuery object specifying nodes and their coordinates in a path.
sketcherOptions	A ConstrainedSketcherOptions object specifying common options for all sketches.
viewerOptions	A ViewerOptions object.
animationOptions	An AnimationOptions object.
aviOptions	An AVIOptions object.
imageAnimationOptions	An ImageAnimationOptions object.
imageAnimation	An ImageAnimation object.
quickTimeOptions	A QuickTimeOptions object.
viewports	A repository of Viewport objects.
customData	A RepositorySupport object.
defaultFieldReportOptions	A FieldReportOptions object.
defaultFreeBodyReportOptions	A FreeBodyReportOptions object.
fieldReportOptions	A FieldReportOptions object.
freeBodyReportOptions	A FreeBodyReportOptions object.
odbs	A repository of Odb objects.
scratchOdbs	A repository of ScratchOdb objects.
defaultOdbDisplay	A DefaultOdbDisplay object.
defaultPlot	A DefaultPlot object.
defaultChartOptions	A DefaultChartOptions object.
odbData	A repository of OdbData objects.
mdbData	A repository of MdbData objects.
paths	A repository of Path objects.
freeBodies	A repository of FreeBody objects.
streams	A repository of Stream objects.
spectrums	A repository of Spectrum 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.
psOptions	A PsOptions object.
svgOptions	A SvgOptions object.
tiffOptions	A TiffOptions object.
autoColors	An AutoColors object specifying the color palette to be used for color coding.
xyColors	An AutoColors object specifying the color palette to be used forXYCurve objects.
xyDataObjects	A repository of XYData objects.
curves	A repository of XYCurve objects.
xyPlots	A repository of XYPlot objects.
charts	A repository of Chart objects.
defaultXYReportOptions	An XYReportOptions object.
xyReportOptions	An 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.
currentViewportName	A String specifying the name of the current viewport.
sessionState	A Dictionary object specifying the viewports and their associated models.
images	A repository of Image objects.
movies	A repository of Movie objects.
defaultLightOptions	A LightOptions object.
drawingArea	A DrawingArea object.
defaultMesherOptions	A MesherOptions object specifying how to control default settings in the Mesh module.
drawings	A repository of Drawing objects.

Public Methods:

Queue(name, queueName[, hostName, fileCopy, ...])

This method creates a Queue object.

Inherited from SessionBase

setValues([kernelMemoryLimit])	This method modifies the Session object.
enableCADConnection(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
isCADConnectionEnabled()	This method checks the status of CAD Connection.
disableCADConnection(CADName)	This method disables an associative import CAD connection that was enabled.
enableParameterUpdate(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
setCADPortNumber(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
updateCADParameters(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
disableParameterUpdate(CADName)	This method disables an associative CAD connection using parameters.
printToFile(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
printToPrinter([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
saveOptions(directory)	This method saves your customized display settings.
writeVrmlFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
write3DXMLFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
writeOBJFile(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
openOdb(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

---

Queue(name, queueName, hostName='', fileCopy=ON, directory='', driver='', remotePlatform='Linux', filesToCopy=abaqusConstants.ALL, deleteAfterCopy=OFF, description='')

This method creates a Queue object. Note:Remote queues are available only on Linux platforms.

Note

This function can be accessed by:

session.Queue

Note

Check Queue on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the name of the new Queue object.

• queueName (str) – A String specifying the name of the remote analysis queue.

• hostName (str, default: '') – A String specifying the name of the remote host. The default value is an empty string.

• fileCopy (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying if the results files are to be copied from the remote machine to the local machine. The default value is ON.

• directory (str, default: '') – A String specifying the remote location for the execution of the simulation. The default value is an empty string.

• driver (str, default: '') – A String specifying the designation of the remote driver. The default value is “abaqus”.

• remotePlatform (SymbolicConstant, default: 'Linux') – A SymbolicConstant specifying the type of operating system on the remote machine. The default value is Linux.

• filesToCopy (str, default: ALL) – A list of Strings specifying the files to be copied from the remote location to the local machine, or ALL. Strings specified in a list are the extensions of the job files that will be copied, such as (‘log’, ‘dat’, ‘msg’, ‘sta’, ‘odb’). The default value is ALL.

• deleteAfterCopy (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether remote files are to be deleted after they are copied to the local machine. The default value is OFF.

• description (str, default: '') – A String specifying a description of the queue. The default value is an empty string.

Returns:

A Queue object.

Return type:

Queue

Raises:

Remote queue host name is not set – If fileCopy = ON and hostName is empty.

:raises Directory in which` to :class:`run the job on the remote computer is not set: If fileCopy = ON and directory is empty.

OdbSession

class OdbSession

Public Data Attributes:

Inherited from SessionBase

attachedToGui	A Boolean specifying whether an Abaqus interactive session is running.
replayInProgress	A Boolean specifying whether Abaqus is executing a replay file.
kernelMemoryFootprint	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
kernelMemoryMaxFootprint	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
kernelMemoryLimit	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
colors	A repository of Color objects.
journalOptions	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
memoryReductionOptions	A MemoryReductionOptions object specifying options for running in reduced memory mode.
nodeQuery	A NodeQuery object specifying nodes and their coordinates in a path.
sketcherOptions	A ConstrainedSketcherOptions object specifying common options for all sketches.
viewerOptions	A ViewerOptions object.
animationOptions	An AnimationOptions object.
aviOptions	An AVIOptions object.
imageAnimationOptions	An ImageAnimationOptions object.
imageAnimation	An ImageAnimation object.
quickTimeOptions	A QuickTimeOptions object.
viewports	A repository of Viewport objects.
customData	A RepositorySupport object.
defaultFieldReportOptions	A FieldReportOptions object.
defaultFreeBodyReportOptions	A FreeBodyReportOptions object.
fieldReportOptions	A FieldReportOptions object.
freeBodyReportOptions	A FreeBodyReportOptions object.
odbs	A repository of Odb objects.
scratchOdbs	A repository of ScratchOdb objects.
defaultOdbDisplay	A DefaultOdbDisplay object.
defaultPlot	A DefaultPlot object.
defaultChartOptions	A DefaultChartOptions object.
odbData	A repository of OdbData objects.
mdbData	A repository of MdbData objects.
paths	A repository of Path objects.
freeBodies	A repository of FreeBody objects.
streams	A repository of Stream objects.
spectrums	A repository of Spectrum 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.
psOptions	A PsOptions object.
svgOptions	A SvgOptions object.
tiffOptions	A TiffOptions object.
autoColors	An AutoColors object specifying the color palette to be used for color coding.
xyColors	An AutoColors object specifying the color palette to be used forXYCurve objects.
xyDataObjects	A repository of XYData objects.
curves	A repository of XYCurve objects.
xyPlots	A repository of XYPlot objects.
charts	A repository of Chart objects.
defaultXYReportOptions	An XYReportOptions object.
xyReportOptions	An 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.
currentViewportName	A String specifying the name of the current viewport.
sessionState	A Dictionary object specifying the viewports and their associated models.
images	A repository of Image objects.
movies	A repository of Movie objects.
defaultLightOptions	A LightOptions object.
drawingArea	A DrawingArea object.
defaultMesherOptions	A MesherOptions object specifying how to control default settings in the Mesh module.
drawings	A repository of Drawing objects.

Public Methods:

ScratchOdb(odb)

This method creates a new ScratchOdb object.

Inherited from SessionBase

setValues([kernelMemoryLimit])	This method modifies the Session object.
enableCADConnection(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
isCADConnectionEnabled()	This method checks the status of CAD Connection.
disableCADConnection(CADName)	This method disables an associative import CAD connection that was enabled.
enableParameterUpdate(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
setCADPortNumber(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
updateCADParameters(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
disableParameterUpdate(CADName)	This method disables an associative CAD connection using parameters.
printToFile(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
printToPrinter([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
saveOptions(directory)	This method saves your customized display settings.
writeVrmlFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
write3DXMLFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
writeOBJFile(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
openOdb(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

---

ScratchOdb(odb)

This method creates a new ScratchOdb object.

Note

This function can be accessed by:

session.ScratchOdb

Note

Check ScratchOdb on help.3ds.com/0.1..

Parameters:

odb (Odb) – An Odb object specifying the output database with which to associate.

Returns:

A ScratchOdb object.

Return type:

ScratchOdb

PathSession

class PathSession

Public Data Attributes:

Inherited from SessionBase

attachedToGui	A Boolean specifying whether an Abaqus interactive session is running.
replayInProgress	A Boolean specifying whether Abaqus is executing a replay file.
kernelMemoryFootprint	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
kernelMemoryMaxFootprint	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
kernelMemoryLimit	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
colors	A repository of Color objects.
journalOptions	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
memoryReductionOptions	A MemoryReductionOptions object specifying options for running in reduced memory mode.
nodeQuery	A NodeQuery object specifying nodes and their coordinates in a path.
sketcherOptions	A ConstrainedSketcherOptions object specifying common options for all sketches.
viewerOptions	A ViewerOptions object.
animationOptions	An AnimationOptions object.
aviOptions	An AVIOptions object.
imageAnimationOptions	An ImageAnimationOptions object.
imageAnimation	An ImageAnimation object.
quickTimeOptions	A QuickTimeOptions object.
viewports	A repository of Viewport objects.
customData	A RepositorySupport object.
defaultFieldReportOptions	A FieldReportOptions object.
defaultFreeBodyReportOptions	A FreeBodyReportOptions object.
fieldReportOptions	A FieldReportOptions object.
freeBodyReportOptions	A FreeBodyReportOptions object.
odbs	A repository of Odb objects.
scratchOdbs	A repository of ScratchOdb objects.
defaultOdbDisplay	A DefaultOdbDisplay object.
defaultPlot	A DefaultPlot object.
defaultChartOptions	A DefaultChartOptions object.
odbData	A repository of OdbData objects.
mdbData	A repository of MdbData objects.
paths	A repository of Path objects.
freeBodies	A repository of FreeBody objects.
streams	A repository of Stream objects.
spectrums	A repository of Spectrum 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.
psOptions	A PsOptions object.
svgOptions	A SvgOptions object.
tiffOptions	A TiffOptions object.
autoColors	An AutoColors object specifying the color palette to be used for color coding.
xyColors	An AutoColors object specifying the color palette to be used forXYCurve objects.
xyDataObjects	A repository of XYData objects.
curves	A repository of XYCurve objects.
xyPlots	A repository of XYPlot objects.
charts	A repository of Chart objects.
defaultXYReportOptions	An XYReportOptions object.
xyReportOptions	An 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.
currentViewportName	A String specifying the name of the current viewport.
sessionState	A Dictionary object specifying the viewports and their associated models.
images	A repository of Image objects.
movies	A repository of Movie objects.
defaultLightOptions	A LightOptions object.
drawingArea	A DrawingArea object.
defaultMesherOptions	A MesherOptions object specifying how to control default settings in the Mesh module.
drawings	A repository of Drawing objects.

Public Methods:

Path(name, type, expression, ...)	This method creates a Path object.
Spectrum(name, colors)	This method creates a Spectrum object and places it in the spectrums repository.
Stream(name, numPointsOnRake[, pointA, ...])	This method creates aStream object and places it in the streams repository.

Inherited from SessionBase

setValues([kernelMemoryLimit])	This method modifies the Session object.
enableCADConnection(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
isCADConnectionEnabled()	This method checks the status of CAD Connection.
disableCADConnection(CADName)	This method disables an associative import CAD connection that was enabled.
enableParameterUpdate(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
setCADPortNumber(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
updateCADParameters(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
disableParameterUpdate(CADName)	This method disables an associative CAD connection using parameters.
printToFile(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
printToPrinter([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
saveOptions(directory)	This method saves your customized display settings.
writeVrmlFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
write3DXMLFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
writeOBJFile(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
openOdb(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

---

Path(name, type, expression, circleDefinition, numSegments, startAngle, endAngle, radius, radialAngle, startRadius, endRadius)

This method creates a Path object.

Note

This function can be accessed by:

session.Path

Note

Check Path on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository key.

• type (SymbolicConstant) – A SymbolicConstant specifying the type of path being created. Possible values are NODE_LIST, POINT_LIST, EDGE_LIST, CIRCUMFERENTIAL, and RADIAL.

• expression (tuple) –

  A sequence specifying the nodes or points that make up the path. The definition of the path expression 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 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 (SymbolicConstant) – 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 (int) – An Int specifying the number of equal segments in the path. This argument is valid only when type = CIRCUMFERENTIAL or RADIAL.

• startAngle (float) – A Float specifying the start angle of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

• endAngle (float) – A Float specifying the end angle of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

• radius (Union[SymbolicConstant, float]) – The SymbolicConstant CIRCLE_RADIUS or a Float specifying the radius of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

• radialAngle (float) – 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 (Union[SymbolicConstant, float]) – The SymbolicConstant CIRCLE_RADIUS or a Float specifying the start radius of the radial path. This argument is valid only when type = RADIAL.

• endRadius (Union[SymbolicConstant, float]) – The SymbolicConstant CIRCLE_RADIUS or a Float specifying the end radius of the radial path. This argument is valid only when type = RADIAL.

Returns:

A Path object.

Return type:

Path

Raises:

• ModelError –

• KeyError –

• ValueError – When type = CIRCUMFERENTIAL or RADIAL, the three points specified in expression are collinear.

Spectrum(name, colors)

This method creates a Spectrum object and places it in the spectrums repository.

Note

This function can be accessed by:

session.Spectrum

Note

Check Spectrum on help.3ds.com/0.1..

Parameters:

• name (str) – A string name for the spectrum.

• colors (tuple) – A sequence of strings indicating the colors of the spectrum.

Returns:

A Spectrum object.

Return type:

Spectrum

Stream(name, numPointsOnRake, pointA=(), pointB=(), path='')

This method creates aStream object and places it in the streams repository.

Note

This function can be accessed by:

session.Stream

Note

Check Stream on help.3ds.com/0.1..

Parameters:

• name (str) – A string name for the stream.

• numPointsOnRake (str) – An integer specifying the number of points along the rake.

• pointA (tuple, default: ()) – A tuple of 3 floats specifying the starting point of the rake. Alternatively, a string representation of the node selected in the viewport.

• pointB (tuple, default: ()) – A tuple of 3 floats specifying the end point of the rake. Alternatively, a string representation of the node selected in the viewport.

• path (str, default: '') – APath object that specifies the rake.

Returns:

A Stream object.

Return type:

Stream

XYSession

class XYSession

Public Data Attributes:

Inherited from SessionBase

attachedToGui	A Boolean specifying whether an Abaqus interactive session is running.
replayInProgress	A Boolean specifying whether Abaqus is executing a replay file.
kernelMemoryFootprint	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
kernelMemoryMaxFootprint	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
kernelMemoryLimit	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
colors	A repository of Color objects.
journalOptions	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
memoryReductionOptions	A MemoryReductionOptions object specifying options for running in reduced memory mode.
nodeQuery	A NodeQuery object specifying nodes and their coordinates in a path.
sketcherOptions	A ConstrainedSketcherOptions object specifying common options for all sketches.
viewerOptions	A ViewerOptions object.
animationOptions	An AnimationOptions object.
aviOptions	An AVIOptions object.
imageAnimationOptions	An ImageAnimationOptions object.
imageAnimation	An ImageAnimation object.
quickTimeOptions	A QuickTimeOptions object.
viewports	A repository of Viewport objects.
customData	A RepositorySupport object.
defaultFieldReportOptions	A FieldReportOptions object.
defaultFreeBodyReportOptions	A FreeBodyReportOptions object.
fieldReportOptions	A FieldReportOptions object.
freeBodyReportOptions	A FreeBodyReportOptions object.
odbs	A repository of Odb objects.
scratchOdbs	A repository of ScratchOdb objects.
defaultOdbDisplay	A DefaultOdbDisplay object.
defaultPlot	A DefaultPlot object.
defaultChartOptions	A DefaultChartOptions object.
odbData	A repository of OdbData objects.
mdbData	A repository of MdbData objects.
paths	A repository of Path objects.
freeBodies	A repository of FreeBody objects.
streams	A repository of Stream objects.
spectrums	A repository of Spectrum 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.
psOptions	A PsOptions object.
svgOptions	A SvgOptions object.
tiffOptions	A TiffOptions object.
autoColors	An AutoColors object specifying the color palette to be used for color coding.
xyColors	An AutoColors object specifying the color palette to be used forXYCurve objects.
xyDataObjects	A repository of XYData objects.
curves	A repository of XYCurve objects.
xyPlots	A repository of XYPlot objects.
charts	A repository of Chart objects.
defaultXYReportOptions	An XYReportOptions object.
xyReportOptions	An 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.
currentViewportName	A String specifying the name of the current viewport.
sessionState	A Dictionary object specifying the viewports and their associated models.
images	A repository of Image objects.
movies	A repository of Movie objects.
defaultLightOptions	A LightOptions object.
drawingArea	A DrawingArea object.
defaultMesherOptions	A MesherOptions object specifying how to control default settings in the Mesh module.
drawings	A repository of Drawing objects.

Public Methods:

AreaStyle([color, fill, style])	This method creates an AreaStyle.
LineStyle([color, show, style, thickness])	This method creates a LineStyle.
QuantityType([label, type])	This method creates a QuantityType object.
SymbolStyle([color, show, marker, size])	This method creates a SymbolStyle object.
TextStyle([color, show, font, rotationAngle])	This method creates a TextStyle.
XYData()
XYDataFromFile(fileName[, name, ...])	This method creates an XYData object from data in an ASCII file.
XYDataFromHistory(odb, outputVariableName, steps)	This method creates an XYData object by reading history data from an Odb object.
xyDataListFromField(odb, outputPosition, ...)	This method creates a list of XYData objects by reading field data from an Odb object.
XYDataFromFreeBody(odb[, force, moment, ...])	This method creates a list of XYData objects by computing free body data from an Odb object.
XYDataFromShellThickness(odb, ...[, ...])	This method creates a list of XYData objects by reading through the thickness field data from an Odb object.
XYDataFromPath(path, name[, ...])	This method creates an XYData object from path information.

Inherited from XYSessionBase

linearizeStress(name, path, startPoint, ...)	This method is used to perform stress linearization along a defined stress line.
setPathTolerance([tolerance])	This method is used to set the tolerance to be used when creating XYData objects by extracting results along Path objects.
getPathTolerance()	This method is used to get the tolerance used when creating XYData objects by extracting results along Path objects.
setLimitForXYDataPlots([limit])	This method is used to set the limit for number of XY data objects while creating XYData from field output.
getLimitForXYDataPlots()	This method is used to get the limit for number of XY data objects while creating XYData from field output.

Inherited from SessionBase

setValues([kernelMemoryLimit])	This method modifies the Session object.
enableCADConnection(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
isCADConnectionEnabled()	This method checks the status of CAD Connection.
disableCADConnection(CADName)	This method disables an associative import CAD connection that was enabled.
enableParameterUpdate(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
setCADPortNumber(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
updateCADParameters(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
disableParameterUpdate(CADName)	This method disables an associative CAD connection using parameters.
printToFile(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
printToPrinter([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
saveOptions(directory)	This method saves your customized display settings.
writeVrmlFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
write3DXMLFile(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
writeOBJFile(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
openOdb(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

---

static AreaStyle(color='', fill=ON, style=abaqusConstants.SOLID)

This method creates an AreaStyle.

Note

This function can be accessed by:

session.AreaStyle
xyPlot.AreaStyle

Note

Check AreaStyle on help.3ds.com/0.1..

Parameters:

• color (str, default: '') – A String specifying the color to be used when filling an area with this AreaStyle object. The default value is “White”.

• fill (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to fill the area when using this AreaStyle. The default value is ON.

• style (SymbolicConstant, default: SOLID) – A SymbolicConstant specifying the area pattern style to be used when filling an area using this AreaStyle. The default value is SOLID.

Returns:

An AreaStyle object.

Return type:

AreaStyle

Raises:

ColorError –

static LineStyle(color='', show=ON, style=abaqusConstants.SOLID, thickness=0)

This method creates a LineStyle.

Note

This function can be accessed by:

session.LineStyle
xyPlot.LineStyle

Note

Check LineStyle on help.3ds.com/0.1..

Parameters:

• color (str, default: '') – A String specifying the color to be used when drawing a line with this LineStyle object. The default value is “White”.

• show (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to draw the line when using this LineStyle. The default value is ON.

• style (Literal[SOLID, DASHED, DOTTED, DOT_DASH], default: SOLID) – A SymbolicConstant specifying the line style to be used when drawing lines using this LineStyle. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

• thickness (float, default: 0) – A Float specifying the line thickness in mm to be used when drawing lines using this LineStyle. The default value is 0.2.

Returns:

A LineStyle object.

Return type:

LineStyle

Raises:

ColorError –

static QuantityType(label='', type=abaqusConstants.NONE)

This method creates a QuantityType object.

Note

This function can be accessed by:

session.QuantityType
xyPlot.QuantityType

Note

Check QuantityType on help.3ds.com/0.1..

Parameters:

• label (str, default: '') – A String specifying the label for this quantity type.

• type (Literal[NONE, ACCELERATION, ACOUSTIC_INTENSITY, ANGLE, ANGULAR_MOMENTUM, ARC_LENGTH, AREA, AREA_VELOCITY_SQUARED, BIMOMENT, CURVATURE, CORIOLIS_LOAD, DAMAGE, DAMAGE_CRITERION, DENSITY, DENSITY_ROTATIONAL_ACCELERATION, DISPLACEMENT, ECURRENT_AREA_TIME, ELECTRIC_CHARGE, ELECTRIC_CURRENT, ELECTRIC_CURRENT_AREA, ELECTRIC_POTENTIAL, ENERGY, ENERGY_DENSITY, ENERGY_RELEASE_RATE, EPOTENTIAL_GRADIENT, FREQUENCY, FORCE, FORCE_VOLUME, HEAT_FLUX, HEAT_FLUX_AREA, HEAT_FLUX_RATE, HEAT_FLUX_VOLUME, LENGTH, LINEAR_PRESSURE, LUMIN, MASS, MASS_FLOW_AREA, MASS_FLOW_AREA_RATE, MASS_FLOW_RATE, MODE_NUMBER, MOMENT, NUMBER, PATH, PHASE, POSITION, PRESSURE, PRESSURE_GRADIENT, RATE, ROTARY_INERTIA, ROTATIONAL_ACCELERATION, ROTATIONAL_VELOCITY, STATUS, STRAIN, STRAIN_RATE, STRESS, STRESS_INTENS_FACTOR, SUBSTANCE, TEMPERATURE, THICKNESS, TIME, TIME_INCREMENT, TIME_HEAT_FLUX, TIME_HEAT_FLUX_AREA, TIME_VOLUME, TIME_VOLUME_FLUX, TWIST, VELOCITY, VELOCITY_SQUARED, VOLUME, VOLUME_FLUX, VOLUME_FLUX_AREA, VOLUME_FRACTION], default: NONE) –

  A SymbolicConstant specifying the physical dimension of the axis. Possible values are:

  • NONE.

  • ACCELERATION.

  • ACOUSTIC_INTENSITY.

  • ANGLE.

  • ANGULAR_MOMENTUM.

  • ARC_LENGTH.

  • AREA.

  • AREA_VELOCITY_SQUARED, specifying “Velocity squared per area”.

  • BIMOMENT.

  • CURVATURE.

  • CORIOLIS_LOAD.

  • DAMAGE.

  • DAMAGE_CRITERION.

  • DENSITY.

  • DENSITY_ROTATIONAL_ACCELERATION, specifying “Density * Angular acceleration”.

  • DISPLACEMENT.

  • ECURRENT_AREA_TIME, specifying “Time integrated electric current per area”.

  • ELECTRIC_CHARGE.

  • ELECTRIC_CURRENT.

  • ELECTRIC_CURRENT_AREA, specifying “Electric current per unit area”.

  • ELECTRIC_POTENTIAL.

  • ENERGY.

  • ENERGY_DENSITY.

  • ENERGY_RELEASE_RATE.

  • EPOTENTIAL_GRADIENT, specifying “Electric potential gradient”.

  • FREQUENCY.

  • FORCE.

  • FORCE_VOLUME, specifying “Force per volume”.

  • HEAT_FLUX.

  • HEAT_FLUX_AREA, specifying “Heat flux per area”.

  • HEAT_FLUX_RATE.

  • HEAT_FLUX_VOLUME, specifying “Heat flux per volume”.

  • LENGTH.

  • LINEAR_PRESSURE.

  • LUMIN, specifying “Luminous intensity”.

  • MASS.

  • MASS_FLOW_AREA, specifying “Mass flow per area”.

  • MASS_FLOW_AREA_RATE, specifying “Mass flow rate per area”.

  • MASS_FLOW_RATE.

  • MODE_NUMBER.

  • MOMENT.

  • NUMBER.

  • PATH.

  • PHASE.

  • POSITION.

  • PRESSURE.

  • PRESSURE_GRADIENT.

  • RATE.

  • ROTARY_INERTIA.

  • ROTATIONAL_ACCELERATION.

  • ROTATIONAL_VELOCITY.

  • STATUS.

  • STRAIN.

  • STRAIN_RATE.

  • STRESS.

  • STRESS_INTENS_FACTOR, specifying “Stress intensity factor”.

  • SUBSTANCE, specifying “Amount of substance”.

  • TEMPERATURE.

  • THICKNESS.

  • TIME.

  • TIME_INCREMENT.

  • TIME_HEAT_FLUX, specifying “Time integrated heat flux”.

  • TIME_HEAT_FLUX_AREA, specifying “Time integrated heat flux per area”.

  • TIME_VOLUME, specifying “Time integrated volume”.

  • TIME_VOLUME_FLUX, specifying “Time integrated volume flux per area”.

  • TWIST.

  • VELOCITY.

  • VELOCITY_SQUARED.

  • VOLUME.

  • VOLUME_FLUX.

  • VOLUME_FLUX_AREA, specifying “Volume flux per area”.

  • VOLUME_FRACTION.

  The default value is NONE

Returns:

A QuantityType object.

Return type:

QuantityType

static SymbolStyle(color='', show=ON, marker=abaqusConstants.FILLED_CIRCLE, size=2)

This method creates a SymbolStyle object.

Note

This function can be accessed by:

session.SymbolStyle
xyPlot.SymbolStyle

Note

Check SymbolStyle on help.3ds.com/0.1..

Parameters:

• color (str, default: '') – A String specifying the color to be used when drawing a marker with this SymbolStyle object. The default value is “White”.

• show (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to draw the marker when using this SymbolStyle object. The default value is ON.

• marker (Literal[FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, XMARKER, POINT], default: FILLED_CIRCLE) –

  A SymbolicConstant specifying the marker type be used when drawing symbols using this SymbolStyle object. Possible values are:

  • FILLED_CIRCLE

  • FILLED_SQUARE

  • FILLED_DIAMOND

  • FILLED_TRI

  • HOLLOW_CIRCLE

  • HOLLOW_SQUARE

  • HOLLOW_DIAMOND

  • HOLLOW_TRI

  • CROSS

  • XMARKER

  • POINT

  The default value is FILLED_CIRCLE.

• size (float, default: 2) – A Float specifying the marker size to be used when drawing markers using this SymbolStyle object. The default value is 2.0.

Returns:

A SymbolStyle object.

Return type:

SymbolStyle

Raises:

ColorError –

static TextStyle(color='', show=ON, font='', rotationAngle=0)

This method creates a TextStyle.

Note

This function can be accessed by:

session.TextStyle
xyPlot.TextStyle

Note

Check TextStyle on help.3ds.com/0.1..

Parameters:

• color (str, default: '') – A String specifying the color to be used when drawing text with this TextStyle object. The default value is “White”.

• show (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to draw the text when using this TextStyle object. The default value is ON.

• font (str, default: '') – A String specifying the name of the font to be used when drawing text with this TextStyle object. The default value is “--verdana-medium-r-normal---120---p---“.

• rotationAngle (float, default: 0) – A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

Returns:

A TextStyle object.

Return type:

TextStyle

Raises:

ColorError –

static XYData(data: tuple, name: str = '', sourceDescription: str = '', contentDescription: str = '', positionDescription: str = '', legendLabel: str = '', xValuesLabel: str = '', yValuesLabel: str = '', axis1QuantityType: QuantityType = ..., axis2QuantityType: QuantityType = ...) → XYData

static XYData(objectToCopy: XYData) → XYData

XYDataFromFile(fileName, name='', sourceDescription='', contentDescription='', positionDescription='', legendLabel='', xValuesLabel='', yValuesLabel='', axis1QuantityType=Ellipsis, axis2QuantityType=Ellipsis, xField=1, yField=2, skipFrequency=0)

This method creates an XYData object from data in an ASCII file.

Note

This function can be accessed by:

session.XYDataFromFile
xyPlot.XYDataFromFile

Parameters:

• fileName (str) – A String specifying the name of the file from which the X - Y data will be read.

• name (str, default: '') – The repository key. If the name is not supplied, a default name in the form _temp#_ is generated and the XYData object is temporary.

• sourceDescription (str, default: '') – A String specifying the source of the X - Y data (e.g., “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.

• contentDescription (str, default: '') – A String specifying the content of the X - Y data (e.g., “field 1 vs. field 2”). The default value is an empty string.

• positionDescription (str, default: '') – A String specifying additional information about the X - Y data (e.g., “for whole model”). The default value is an empty string.

• legendLabel (str, default: '') – A String specifying the label to be used in the legend. The default value is the name of the XYData object.

• xValuesLabel (str, default: '') – A String specifying the label for the X-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.

• yValuesLabel (str, default: '') – A String specifying the label for the Y-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.

• axis1QuantityType (QuantityType, default: Ellipsis) – A QuantityType object specifying the QuantityType object associated to the X -axis1- values.

• axis2QuantityType (QuantityType, default: Ellipsis) – A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.

• xField (int, default: 1) – An Int specifying the field from which the X-data will be read. Fields are delimited by spaces, tabs, or commas. The default value is 1.

• yField (int, default: 2) – An Int specifying the field from which the Y-data will be read. Fields are delimited by spaces, tabs, or commas. The default value is 2.

• skipFrequency (int, default: 0) – An Int specifying how often data rows will be skipped. A skipFrequency of 1 means skip every other row. The first row is always read. Possible values are skipFrequency ≥ 0. The default value is 0 (data are read from every row).

Returns:

An XYData object.

Return type:

XYData

Raises:

• InvalidNameError –

• RangeError –

XYDataFromFreeBody(odb, force=ON, moment=OFF, heatFlowRate=OFF, resultant=ON, comp1=OFF, comp2=OFF, comp3=OFF)

This method creates a list of XYData objects by computing free body data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromFreeBody
xyPlot.XYDataFromFreeBody

Note

Check XYDataFromFreeBody on help.3ds.com/0.1..

Parameters:

• odb (Odb) – An Odb object specifying the output database from which data will be read.

• force (Union[AbaqusBoolean, bool], default: ON) – A boolean indicating whether to compute the force. The default is ON.

• moment (Union[AbaqusBoolean, bool], default: OFF) – A boolean indicating whether to compute the moment. The default is OFF.

• heatFlowRate (Union[AbaqusBoolean, bool], default: OFF) – A boolean indicating whether to compute the heat flow rate resultant magnitude. It is extracted only for viewcut based freebodies. The default is OFF.

• resultant (Union[AbaqusBoolean, bool], default: ON) – A boolean indicating whether to compute the resultant. It applies only to force and moment. The default is ON.

• comp1 (Union[AbaqusBoolean, bool], default: OFF) – A boolean indicating whether to compute the first component. It applies only to force and moment. The default is OFF.

• comp2 (Union[AbaqusBoolean, bool], default: OFF) – A boolean indicating whether to compute the second component. It applies only to force and moment. The default is OFF.

• comp3 (Union[AbaqusBoolean, bool], default: OFF) – A boolean indicating whether to compute the third component. It applies only to force and moment. The default is OFF.

Returns:

A list of XYData objects.

Return type:

List[XYData]

Raises:

• InvalidNameError –

• RangeError –

XYDataFromHistory(odb, outputVariableName, steps, name='', sourceDescription='', contentDescription='', positionDescription='', legendLabel='', skipFrequency=0, numericForm=abaqusConstants.REAL, complexAngle=0, stepTuple=Ellipsis)

This method creates an XYData object by reading history data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromHistory
xyPlot.XYDataFromHistory

Note

Check XYDataFromHistory on help.3ds.com/0.1..

Parameters:

• odb (Odb) – An Odb object specifying the output database from which data will be read.

• outputVariableName (str) – A String specifying the output variable from which the X - Y data will be read.

• steps (tuple) – A sequence of Strings specifying the names of the steps from which data will be extracted.

• name (str, default: '') – The repository key. If the name is not supplied, a default name in the form _temp#_ is generated and the XYData object is temporary (this argument is required if the method is accessed from the session object).

• sourceDescription (str, default: '') – A String specifying the source of the X - Y data (for example, “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.

• contentDescription (str, default: '') – A String specifying the content of the X - Y data (for example, “field 1 vs. field 2”). The default value is an empty string.

• positionDescription (str, default: '') – A String specifying additional information about the X - Y data (for example, “for whole model”). The default value is an empty string.

• legendLabel (str, default: '') – A String specifying the label to be used in the legend. The default value is the name of the XYData object.

• skipFrequency (int, default: 0) – An Int specifying how often data frames will be skipped. If skipFrequency = 1, Abaqus 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).

• numericForm (Literal[COMPLEX_MAGNITUDE, COMPLEX_PHASE, REAL, IMAGINARY, COMPLEX_VAL_AT_ANGLE], default: REAL) – 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_VAL_AT_ANGLE. The default value is REAL.

• complexAngle (float, default: 0) – A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.

• stepTuple (Tuple[int, ...], default: Ellipsis) – A tuple of Integers specifying the steps to include when extracting data.

Returns:

An XYData object.

Return type:

XYData

Raises:

• InvalidNameError –

• RangeError –

XYDataFromPath(path, name, includeIntersections=False, shape=Ellipsis, pathStyle=Ellipsis, numIntervals=10, labelType=Ellipsis, viewport=Ellipsis, removeDuplicateXYPairs=True, includeAllElements=False, step=Ellipsis, frame=Ellipsis, variable=Ellipsis, deformedMag=(1, 1, 1), numericForm=abaqusConstants.REAL, complexAngle=0, projectOntoMesh=False, projectionTolerance=0)

This method creates an XYData object from path information.

Note

This function can be accessed by:

session.XYDataFromPath
xyPlot.XYDataFromPath

Note

Check XYDataFromPath on help.3ds.com/0.1..

Parameters:

• path (Path) – A Path object to use in X - Y data generation.

• name (str) – A String specifying the repository key:for session ‘name’ is required argument and for xyPlot ‘name’ is optional argument.

• includeIntersections (Union[AbaqusBoolean, bool], default: False) – A Boolean specifying whether to include X - Y data for the intersections between the path and element faces or edges. The default value is False.

• shape (Literal[UNDEFORMED, DEFORMED], default: Ellipsis) – A SymbolicConstant specifying the model shape to use. Possible values are UNDEFORMED and DEFORMED.

• pathStyle (Literal[PATH_POINTS, UNIFORM_SPACING], default: Ellipsis) – A SymbolicConstant specifying the path style. Possible values are PATH_POINTS and UNIFORM_SPACING.

• numIntervals (int, default: 10) – An Int specifying the number of uniform-spacing intervals. The default value is 10.

• labelType (Literal[NORM_DISTANCE, SEQ_ID, TRUE_DISTANCE, TRUE_DISTANCE_X, TRUE_DISTANCE_Y, TRUE_DISTANCE_Z, X_COORDINATE, Y_COORDINATE, Z_COORDINATE], default: Ellipsis) – A SymbolicConstant specifying the X label type to use. Possible values are NORM_DISTANCE, SEQ_ID, TRUE_DISTANCE, TRUE_DISTANCE_X, TRUE_DISTANCE_Y, TRUE_DISTANCE_Z, X_COORDINATE, Y_COORDINATE and Z_COORDINATE.

• viewport (str, default: Ellipsis) – A String specifying the viewport name or an Int specifying the viewport id from which to obtain values. The default is the current viewport.

• removeDuplicateXYPairs (Union[AbaqusBoolean, bool], default: True) –

  A Boolean specifying whether to remove duplicate XY values from the final result. The default value is True.

  New in version 2018: The removeDuplicateXYPairs argument was added.

• includeAllElements (Union[AbaqusBoolean, bool], default: False) –

  A Boolean specifying whether to include elements which do not lie in the direction of the path. The default value is False.

  New in version 2018: The includeAllElements argument was added.

• step (int, default: Ellipsis) – An Int identifying the step from which to obtain values. The default value is the current step.

• frame (int, default: Ellipsis) – An Int identifying the frame from which to obtain values. The default value is the current frame.

• variable (Tuple[Tuple[str, Literal[ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, WHOLE_REGION], Tuple[Literal[INVARIANT, COMPONENT], str], Dict[str, str]], ...], default: Ellipsis) –

  A tuple of tuples containing the descriptions of variables for which to extract data along the path. The default value is the current variable. Each tuple specifies the following:

  • Variable label: A String specifying the variable; for example, ‘U’.

  • Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.

  • Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:

    • Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.

    • Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.

  • Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:

    • A String specifying the category selection label.

    • A String specifying the section point label.

  For example:

  variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
  variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
              ('U', NODAL,((COMPONENT, 'U1'), )), )
  variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
               {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )
  

• deformedMag (Tuple[float, float, float], default: (1, 1, 1)) – A tuple of three Floats specifying the deformation magnitude in the X-, Y-, and Z- planes. The default value is (1, 1, 1).

• numericForm (Literal[COMPLEX_MAGNITUDE, COMPLEX_PHASE, REAL, IMAGINARY, COMPLEX_VAL_AT_ANGLE], default: REAL) – 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_VAL_AT_ANGLE. The default value is REAL.

• complexAngle (float, default: 0) – A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.

• projectOntoMesh (Union[AbaqusBoolean, bool], default: False) – A Boolean to specify whether to consider the data points that do not lie on or inside the mesh. The default value is False.

• projectionTolerance (float, default: 0) – A Float specifying the tolerance value for the projected distance considered for the data extraction when projectOntoMesh = True. The default value is 0.

Returns:

• If **variable specified has one fieldoutput** (Returns an XYData object.)

• If **variable specified has more than one fieldoutputs** (Returns list of XYData objects.)

Raises:

• ErrorPathNotFound – If path is invalid.

• ErrorCurrentVPNotFound – If viewport is invalid.

• ErrorInvalidUserStepAndFrame – If step and/or frame are invalid.

• ErrorNoVarInPathExtract – If the variable argument is empty.

• ErrorUnavailableSelectedVariable – If the specified output variable is not available in the output database.

• ErrorUnusableVarInPathExtract – If the specified output variable cannot be used to obtain X - Y data from path.

• ErrorUnsupportedRefinementType – If the SymbolicConstant specifying the refinement type is invalid.

• ErrorInvalidRefinementSpecification – If the label specifying the refinement invariant or component is invalid.

• ErrorDeformedMagTupleInPathExtract – If deformedMag does not contain three Floats.

XYDataFromShellThickness(odb, outputPosition, variable, elementSets=Ellipsis, elementLabels=(), nodeSets=(), nodeLabels=(), numericForm=abaqusConstants.REAL, complexAngle=0)

This method creates a list of XYData objects by reading through the thickness field data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromShellThickness
xyPlot.XYDataFromShellThickness

Note

Check XYDataFromShellThickness on help.3ds.com/0.1..

Parameters:

• odb – An Odb object specifying the output database from which data will be read.

• outputPosition – A SymbolicConstant specifying the position from which output will be read. Possible values are ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, and NODAL.

• variable –

  A tuple of tuples containing the descriptions of variables for which to extract data from the field. Each tuple specifies the following:

  • Variable label: A String specifying the variable; for example, ‘U’.

  • Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.

  • Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:

    • Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.

    • Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.

  • Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:

    • A String specifying the category selection label.

    • A String specifying the section point label.

  For example:

  variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
  variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
              ('U', NODAL,((COMPONENT, 'U1'), )), )
  variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
               {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )
  

• elementSets – A sequence of Strings specifying element sets or a String specifying a single element set.

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

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

• nodeSets – A sequence of Strings specifying node sets or a String specifying a single node set.

• 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:

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

• 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_VAL_AT_ANGLE. The default value is REAL.

• complexAngle – A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.

Returns:

A list of XYData objects.

Return type:

List[XYData]

Raises:

• InvalidNameError –

• RangeError –

xyDataListFromField(odb, outputPosition, variable, elementSets=Ellipsis, elementLabels=Ellipsis, nodeSets=Ellipsis, nodeLabels=Ellipsis, numericForm=abaqusConstants.REAL, complexAngle=0, operator=Ellipsis)

This method creates a list of XYData objects by reading field data from an Odb object.

Note

This function can be accessed by:

session.xyDataListFromField
xyPlot.xyDataListFromField

Note

Check XYSession.xyDataListFromField on help.3ds.com/0.1..

Parameters:

• odb (Odb) – An Odb object specifying the output database from which data will be read.

• outputPosition (Literal[ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, NODAL]) – A SymbolicConstant specifying the position from which output will be read. Possible values are ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, and NODAL.

• variable (Tuple[Tuple[str, Literal[ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, WHOLE_REGION], Tuple[Tuple[Literal[INVARIANT, COMPONENT], str], ...]]]) –

  A tuple of tuples containing the descriptions of variables for which to extract data from the field. Each tuple specifies the following:

  • Variable label: A String specifying the variable; for example, ‘U’.

  • Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.

  • Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:

    • Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.

    • Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.

  • Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:

    • A String specifying the category selection label.

    • A String specifying the section point label.

  For example:

  variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
  variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
              ('U', NODAL,((COMPONENT, 'U1'), )), )
  variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
               {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )
  

• elementSets (Union[Tuple[str, ...], str], default: Ellipsis) – A sequence of Strings specifying element sets or a String specifying a single element set.

• elementLabels (Tuple[Tuple[str, Union[int, str]], ...], default: Ellipsis) –

  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.

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

• nodeSets (Union[str, Tuple[str, ...]], default: Ellipsis) – A sequence of Strings specifying node sets or a String specifying a single node set.

• nodeLabels (Tuple[Tuple[str, Union[int, str]], ...], default: Ellipsis) –

  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:

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

• numericForm (Literal[COMPLEX_MAGNITUDE, COMPLEX_PHASE, REAL, IMAGINARY, COMPLEX_VAL_AT_ANGLE], default: REAL) – 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_VAL_AT_ANGLE. The default value is REAL.

• complexAngle (float, default: 0) – A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.

• operator (Literal[ADD, SUBTRACT, MULTIPLY, DIVIDE, POWER, MINIMUM, MAXIMUM, AVERAGE, RANGE, SRSS, ABSOLUTE, UNARY_NEGATIVE, COSINE, HYPERBOLIC_COSINE, INVERSE_COSINE, SINE, HYPERBOLIC_SINE, INVERSE_SINE, TANGENT, HYPERBOLIC_TANGENT, INVERSE_TANGENT, EXPONENTIAL, NATURAL_LOG, LOG, SQUARE_ROOT, NORMALIZE, DEG2RAD, RAD2DEG, SMOOTH, SWAP, AVERAGE_ALL, MAXIMUM_ENVELOPE, MINIMUM_ENVELOPE, RANGE_ALL], default: Ellipsis) – A SymbolicConstant specifying the mathematical, trigonometric, logarithmic, exponential, or other operations. Possible values are ADD, SUBTRACT, MULTIPLY, DIVIDE, POWER, MINIMUM, MAXIMUM, AVERAGE, RANGE, SRSS, ABSOLUTE, UNARY_NEGATIVE, COSINE, HYPERBOLIC_COSINE, INVERSE_COSINE, SINE, HYPERBOLIC_SINE, INVERSE_SINE, TANGENT, HYPERBOLIC_TANGENT, INVERSE_TANGENT, EXPONENTIAL, NATURAL_LOG, LOG, SQUARE_ROOT, NORMALIZE, DEG2RAD, RAD2DEG, SMOOTH, SWAP, AVERAGE_ALL, MAXIMUM_ENVELOPE, MINIMUM_ENVELOPE, and RANGE_ALL. If no value is defined, no operation will be performed on the data, and the data will be saved as is.

Returns:

A list of XYData objects.

Return type:

List[XYData]

Raises:

• InvalidNameError –

• RangeError –

AutoColors

class AutoColors

The AutoColors object defines a color palette.

Note

This object can be accessed by:

session.autoColors

Note

Check AutoColors on help.3ds.com/0.1..

Public Methods:

setValues(colors)

This method changes the color palette.

---

setValues(colors)

This method changes the color palette.

Note

Check AutoColors.setValues on help.3ds.com/0.1..

Parameters:

colors (tuple) – A sequence of Strings specifying the colors of the palette. Strings must be named colors or represent red, green, blue components in hexadecimal form. For instance, ‘#FF0000’ for red, ‘#00FF00’ for green and ‘#0000FF’ for blue

Color

class Color

The Color object contains the RGB definition of a system color.

Note

This object can be accessed by:

session.colors[name]

Note

Check Color on help.3ds.com/0.1..

Public Data Attributes:

name	A String specifying the name of the color.
rgb	A tuple of three Floats specifying the RGB value of the color.

Public Methods:

setByRGB(rgb)

This method changes the RGB value of a user-defined color.

---

name: str = ''

A String specifying the name of the color.

rgb: Optional[float] = None

A tuple of three Floats specifying the RGB value of the color. The Float values must be between 0.0 and 1.0.

setByRGB(rgb)

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.

Note

Check Color.setByRGB on help.3ds.com/0.1..

Parameters:

rgb (tuple) – A sequence of three Floats specifying the RGB value of the color. The Float values must be between 0.0 and 1.0.

Drawing

class Drawing(name)

A drawing is the container for a geometric object. The Drawing object stores the vertex data and various settings that determine how the drawing will be displayed.

Note

This object can be accessed by:

session.drawings[name]

Note

Check Drawing on help.3ds.com/0.1..

Public Data Attributes:

vertexCount	An Int specifying the number of vertices in the vertex array after a call to the setVertices method.
normalCount	An Int specifying the number of normal vectors in the normal array after a call to the setNormals method.
colorCount	An Int specifying the number of colors in the color array after a call to the setColors method.
show	A Boolean specifying whether the drawing object will be rendered when referenced.
cullBackfaces	A Boolean specifying whether polygonal graphics primitives facing away from the viewer should be culled (not rendered).
frontFaceOrder	A SymbolicConstant specifying the winding order for polygonal graphics primitives that face the viewer.
translucency	A Float specifying the opacity for polygonal graphics primitives.
lineSize	A Float specifying the width of the line, in millimeters, used to render edges.
pointSize	A Float specifying the width of points, in millimeters, used to render points.
smoothShade	A Boolean specifying whether the lighting of polygonal graphics primitives is consistent for each facet or calculated for each displayed pixel.
edgesInShaded	A Boolean specifying whether edge and point drawing commands will be issued in a FILLED or SHADED display.
edgeColor	A tuple of three Floats specifying the Red, Green, and Blue component values for the edge color.
pointColor	A tuple of three Floats specifying the Red, Green, and Blue component values for the point color.

Public Methods:

__init__(name)	This method creates an empty Drawing object.
setVertices(vertexDimension, vertexData)	This method accepts the vertex data that defines the Drawing object.
setNormals(normalData)	This method accepts the normal data for each vertex.
setColors(colorDimension, colorData)	This method accepts the color data for each vertex.
setEdgeColor(edgeColor)	This method allows a separate, single color to be used when rendering the edges of the drawing.
setPointColor(pointColor)	This method allows a separate, single color to be used when rendering the points of the drawing.
addArrayDraw(type, startIndex, numVertices)	This method adds a rendering command to the drawing and can be called multiple times to add additional rendering commands.
addIndexDraw(type, indices[, polygonMode])	This method adds a rendering command to the drawing and can be called multiple times to add additional rendering commands.
setValues([show, cullBackfaces, ...])	This method modifies the rendering of the Drawing object.

---

addArrayDraw(type, startIndex, numVertices, polygonMode=abaqusConstants.FILL)

This method adds a rendering command to the drawing and can be called multiple times to add additional rendering commands. When the drawing is referenced by a Viewport, the drawing commands are used the render the Drawing. The rendering command constructs the specified type of geometric primitive using numVertices array elements starting at element index startIndex.

Note

Check Drawing.addArrayDraw on help.3ds.com/0.1..

Parameters:

• type (SymbolicConstant) – A SymbolicConstant specifying the type of graphics primitive rendered by this command. Possible values are POINTS, LINES, LINE_LOOP, LINE_STRIP, TRIANGLES, TRIANGLE_STRIP, TRIANGLE_FAN, QUADS, and QUAD_STRIP.

• startIndex (int) – An Integer specifying the index of the first vertex to render.

• numVertices (int) – An Integer specifying the total number of vertices to render.

• polygonMode (SymbolicConstant, default: FILL) – A SymbolicConstant specifying how polygonal graphics primitives will be rendered by this command. Possible values are FILL, EDGES, and POINTS. The default value is FILL.

Returns:

The total number of rendering commands that have been specified.

Return type:

int

Raises:

• ValueError – If (startIndex + numVertices - 1) is larger than the length of the vertex array:

• ValueError –

  • If (startIndex + numVertices - 1) is larger than the length of the normal array and normals are required for the graphics primitive: Drawing request extends past array size of normals. - If (startIndex + numVertices - 1) is larger than the length of the color array and vertex colors are required for the graphics primitive: Drawing request extends past array size of colors.

addIndexDraw(type, indices, polygonMode=abaqusConstants.FILL)

This method adds a rendering command to the drawing and can be called multiple times to add additional rendering commands. When the drawing is referenced by a Viewport, the drawing commands are used the render the Drawing. The rendering command constructs the specified type of geometric primitive using numVertices array elements starting at element index startIndex.

Note

Check Drawing.addIndexDraw on help.3ds.com/0.1..

Parameters:

• type (SymbolicConstant) – A SymbolicConstant specifying the type of graphics primitive rendered by this command. Possible values are POINTS, LINES, LINE_LOOP, LINE_STRIP, TRIANGLES, TRIANGLE_STRIP, TRIANGLE_FAN, QUADS, and QUAD_STRIP.

• indices (tuple) – A sequence of Integer values specifying index of each vertex to render.

• polygonMode (SymbolicConstant, default: FILL) – A SymbolicConstant specifying how polygonal graphics primitives will be rendered by this command. Possible values are FILL, EDGES, and POINTS. The default value is FILL.

Returns:

The total number of rendering commands that have been specified.

Return type:

int

Raises:

• ValueError –

  • If any value in the indices sequence negative: ValueError: Index values must be positive. - If any value in the indices sequence is larger than the length of the vertex array:

• ValueError –

  • If any value in the indices sequence is larger than the length of the normal array and normals are required for the graphics primitive: Drawing request extends past array size of normals. - If any value in the indices sequence is larger than the length of the color array and vertex colors are required for the graphics primitive: Drawing request extends past array size of colors.

colorCount: int = 0

An Int specifying the number of colors in the color array after a call to the setColors method. The default value is 0.

cullBackfaces: Union[AbaqusBoolean, bool] = OFF

A Boolean specifying whether polygonal graphics primitives facing away from the viewer should be culled (not rendered). The default value is OFF.The winding order, and not the normal, of the graphics primitive is used to determine its facing.

edgeColor: Optional[float] = None

A tuple of three Floats specifying the Red, Green, and Blue component values for the edge color. Possible values for each component are between 0.0 and 1.0.

edgesInShaded: Union[AbaqusBoolean, bool] = ON

A Boolean specifying whether edge and point drawing commands will be issued in a FILLED or SHADED display. The default value is ON.If no edge or point drawing commands have been defined, the polygonal drawing commands will be issued in WIREFRAME and HIDDEN_LINE displays with the polygonMode set to EDGES. If only edge and point drawing commands have been defined, the Drawing will not be rendered in FILLED or SHADED displays.

frontFaceOrder: SymbolicConstant = CCW

A SymbolicConstant specifying the winding order for polygonal graphics primitives that face the viewer. Possible values are:CCW, specifying front face winding order is counter-clockwise.CW, specifying front face winding order is clockwise.The default value is CCW.

lineSize: float = 0

A Float specifying the width of the line, in millimeters, used to render edges. Possible values are 0.0 ≤ lineSize ≤ 5.0 with 0.0 being interpreted as the thinnest possible line. The default value is 0.0.A value of 0.0 will be one pixel on the output device. One pixel on the screen is generally visible but one pixel on a 1200 DPI printer may not be clear.

name: str

A String specifying the repository key.

normalCount: int = 0

An Int specifying the number of normal vectors in the normal array after a call to the setNormals method. The default value is 0.

pointColor: Optional[float] = None

A tuple of three Floats specifying the Red, Green, and Blue component values for the point color. Possible values for each component are between 0.0 and 1.0.

pointSize: float = 0

A Float specifying the width of points, in millimeters, used to render points. Possible values are 0.0 ≤ lineSize ≤ 5.0 with 0.0 being interpreted as the smallest possible point. The default value is 0.0.A value of 0.0 will be one pixel on the output device. One pixel on the screen is generally visible but one pixel on a 1200 DPI printer may not be clear.

setColors(colorDimension, colorData)

This method accepts the color data for each vertex. It defines in an array of colors with a length equal to the length of the colorData sequence divided by colorDimension.

Note

Check Drawing.setColors on help.3ds.com/0.1..

Parameters:

• colorDimension (float) – An Integer in the range of 3 to 4 specifying how many Float values are needed to compose a single color.

• colorData (tuple) – A sequence of Float values in the range of 0.0 to 1.0 that will be used to compose the colors. There must be colorDimension values in the sequence for each color. The first color will be associated with the fist vertex and so on.The first Float will be the red value for the first color. The second Float will be the green value and the third will be the blue value. When colorDimension is 4 the 4th Float will be the alpha value for the first color but is ignored.If only one color is specified, all vertices will use the color value.

Returns:

The number of colors described.

Return type:

int

Raises:

• RangeError – If an invalid colorDimension is specified.

• ValueError – If colorData is an empty sequence.

• ValueError – If setColors has already been called and this call is sending fewer colors.

setEdgeColor(edgeColor)

This method allows a separate, single color to be used when rendering the edges of the drawing. Once called, edges will be rendered using the specified color but facets will continue to use the colors specified in the setColors method. An empty sequence can be specified to resume using the colors arrays for edges.

Note

Check Drawing.setEdgeColor on help.3ds.com/0.1..

Parameters:

edgeColor (tuple) – A sequence of 0 or 3 Float values in the range of 0.0 to 1.0 that will be used to compose the edge color.If the initial Float value is -1, the viewport background color will be used for the edge color.

Raises:

ValueError –

• If edgeColor is not a sequence of 0 or 3 Floats: ValueError: edgeColor must be a tuple with 3 values

setNormals(normalData)

This method accepts the normal data for each vertex. It defines in an array of normal vectors with a length equal to the length of the normalData sequence divided by 3.

Note

Check Drawing.setNormals on help.3ds.com/0.1..

Parameters:

normalData (tuple) – A sequence of Float values that will be used to compose the normals. There must be 3 values in the sequence for each normal.If only one normal is specified, all vertices will use the normal value.

Returns:

The number of normals described.

Return type:

int

Raises:

• RangeError –

• ValueError – If normalData is sequence with less than 3 values.

• ValueError – If setNormals has already been called and this call is sending fewer values.

setPointColor(pointColor)

This method allows a separate, single color to be used when rendering the points of the drawing. Once called, points will be rendered using the specified color but facets will continue to use the colors specified in the setColors method. An empty sequence can be specified to resume using the colors arrays for points.

Note

Check Drawing.setPointColor on help.3ds.com/0.1..

Parameters:

pointColor (tuple) – A sequence of 0 or 3 Float values in the range of 0.0 to 1.0 that will be used to compose the point color.If the initial Float value is -1, the viewport background color will be used for the edge color.

Raises:

ValueError –

• If pointColor is a not sequence of 0 or 3 Floats: ValueError: pointColor must be a tuple with 3 values

setValues(show=OFF, cullBackfaces=OFF, frontFaceOrder=abaqusConstants.CCW, smoothShade=ON, edgesInShaded=ON, translucency=1, lineSize=0, pointSize=0, depthTest=ON)

This method modifies the rendering of the Drawing object.

Note

Check Drawing.setValues on help.3ds.com/0.1..

Parameters:

• show (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the drawing object will be rendered when referenced. The default value is OFF.

• cullBackfaces (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether polygonal graphics primitives facing away from the viewer should be culled (not rendered). The default value is OFF.The winding order, and not the normal, of the graphics primitive is used to determine its facing.

• frontFaceOrder (SymbolicConstant, default: CCW) – A SymbolicConstant specifying the winding order for polygonal graphics primitives that face the viewer. Possible values are:CCW, specifying front face winding order is counter-clockwise.CW, specifying front face winding order is clockwise.The default value is CCW.

• smoothShade (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether the lighting of polygonal graphics primitives is consistent for each facet or calculated for each displayed pixel. The default value is ON.When False, only the last normal for each facet will be used in the lighting calculation.

• edgesInShaded (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether edge and point drawing commands will be issued in a FILLED or SHADED display. The default value is ON.If no edge or point drawing commands have been defined, the polygonal drawing commands will be issued in WIREFRAME and HIDDEN_LINE displays with the polygonMode set to EDGES. If only edge and point drawing commands have been defined, the Drawing will not be rendered in FILLED or SHADED displays.

• translucency (float, default: 1) – A Float specifying the opacity for polygonal graphics primitives. Possible values are 0.0 ≤ translucency ≤ 1.0 with 0.0 being completely transparent (invisible) and 1.0 being opaque. The default value is 1.0.A value greater than 0.3 will cause the translucent facets to be sorted by depth before being rendered and has the side effect of disabling two-sided lighting for those facets.

• lineSize (float, default: 0) – A Float specifying the width of the line, in millimeters, used to render edges. Possible values are 0.0 ≤ lineSize ≤ 5.0 with 0.0 being interpreted as the thinnest possible line. The default value is 0.0.A value of 0.0 will be one pixel on the output device. One pixel on the screen is generally visible but one pixel on a 1200 DPI printer may not be clear.

• pointSize (float, default: 0) – A Float specifying the width of points, in millimeters, used to render points. Possible values are 0.0 ≤ lineSize ≤ 5.0 with 0.0 being interpreted as the smallest possible point. The default value is 0.0.A value of 0.0 will be one pixel on the output device. One pixel on the screen is generally visible but one pixel on a 1200 DPI printer may not be clear.

• depthTest (Union[AbaqusBoolean, bool], default: ON) –

  A Boolean specifying whether an object’s depth will be considered during rendering. The default value is ON.When OFF, the object will not be hidden by other objects in front of it.

  New in version 2018: The depthTest argument was added.

Raises:

RangeError –

• If an invalid translucency value is specified: RangeError: translucency must be in the range 0.0 <= value <= 1.0 - If an invalid lineSize value is specified: RangeError: lineSize must be in the range 0.0 <= value <= 5.0 - If an invalid pointSize value is specified: RangeError: pointSize must be in the range 0.0 <= value <= 5.0

setVertices(vertexDimension, vertexData)

This method accepts the vertex data that defines the Drawing object. It defines in an array of vertices with a length equal to the length of the vertexData sequence divided by vertexDimension.

Note

Check Drawing.setVertices on help.3ds.com/0.1..

Parameters:

• vertexDimension (float) – An Integer in the range of 2 to 4 specifying how many Float values are needed to compose a single vertex.

• vertexData (tuple) – A sequence of Float values that will be used to compose the vertices. There must be vertexDimension values in the sequence for each vertex.

Returns:

The number of vertices described.

Return type:

int

Raises:

• RangeError – If an invalid vertexDimension is specified.

• ValueError – If vertexData is an empty sequence.

• ValueError – If setVertices has already been called and this call is sending fewer vertices.

show: Union[AbaqusBoolean, bool] = OFF

A Boolean specifying whether the drawing object will be rendered when referenced. The default value is OFF.

smoothShade: Union[AbaqusBoolean, bool] = ON

A Boolean specifying whether the lighting of polygonal graphics primitives is consistent for each facet or calculated for each displayed pixel. The default value is ON.When False, only the last normal for each facet will be used in the lighting calculation.

translucency: float = 1

A Float specifying the opacity for polygonal graphics primitives. Possible values are 0.0 ≤ translucency ≤ 1.0 with 0.0 being completely transparent (invisible) and 1.0 being opaque. The default value is 1.0.A value greater than 0.3 will cause the translucent facets to be sorted by depth before being rendered and has the side effect of disabling two-sided lighting for those facets.

vertexCount: int = 0

An Int specifying the number of vertices in the vertex array after a call to the setVertices method. The default value is 0.

Image

class Image(name, fileName)

The Image object is used to store color values and attributes associated with a raster file. Upon creation, the Image object is added to the session.images repository.

Note

This object can be accessed by:

session.images[name]

Note

Check Image on help.3ds.com/0.1..

Public Methods:

__init__(name, fileName)	This method creates an Image object from the contents of the specified file.
ImageFromMovie(name, movieName, frame, time)	This method creates an Image object from a given frame of an existing Movie object.

---

ImageFromMovie(name, movieName, frame, time)

This method creates an Image object from a given frame of an existing Movie object.

Note

Check ImageFromMovie on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository name for the image.

• movieName (str) – A String specifying the name of the movie from which the image is to be extracted. The movie must exist in the session.movies repository.

• frame (int) – An Int specifying the movie frame number defining the image to be extracted.

• time (float) – A Float specifying the time of the movie defining the image to be extracted.

Returns:

An Image object.

Return type:

Image

Raises:

• ValueError – If movieName does not exist.

• ValueError – If frame references an non existing frame.

• ValueError – If time references an non existing frame.

• TypeError – If time and frame are given in the same command.

fileName: str

A String specifying the file from which the image is to be read. The file extension must be specified and indicate the image format (.bmp, .gif, .jpg, .jpeg, .ico, .pcx, .png, .rgb, .tga, .tif, or .xpm).

name: str

A String specifying the repository name for the image.

JournalOptions

class JournalOptions

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.

Note

This object can be accessed by:

session.journalOptions

Note

Check JournalOptions on help.3ds.com/0.1..

Public Data Attributes:

numberFormat

Format of the number

Public Methods:

setValues([replayGeometry, recoverGeometry, ...])	This method modifies the JournalOptions object.
NumberFormat([blankPad, format, numDigits, ...])	This method creates a NumberFormat object.

---

NumberFormat(blankPad=ON, format=abaqusConstants.ENGINEERING, numDigits=6, precision=0)

This method creates a NumberFormat object.

Note

This function can be accessed by:

session.defaultFieldReportOptions.NumberFormat
session.fieldReportOptions.NumberFormat
session.journalOptions.NumberFormat

Note

Check NumberFormat on help.3ds.com/0.1..

Parameters:

• blankPad (Union[AbaqusBoolean, bool], default: ON) – 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 (SymbolicConstant, default: ENGINEERING) – A SymbolicConstant specifying the formatting type. Possible values are ENGINEERING, SCIENTIFIC, and AUTOMATIC. The default value is ENGINEERING.

• numDigits (int, default: 6) – An Int specifying the number of digits to be displayed in the result. numDigits >0>0. The default value is 6.

• precision (int, default: 0) – An Int specifying the number of decimal places to which the number is to be truncated for display. precision ≤0≤0. If precision =0, no truncation is applied. The default value is 0.

Returns:

A NumberFormat object.

Return type:

NumberFormat

numberFormat: NumberFormat = <abaqus.Session.NumberFormat.NumberFormat object>

Format of the number

setValues(replayGeometry=abaqusConstants.COMPRESSEDINDEX, recoverGeometry=abaqusConstants.COMPRESSEDINDEX, defaultFormat=None, fieldReportFormat=None, geometryFormat=None)

This method modifies the JournalOptions object.

Note

Check JournalOptions.setValues on help.3ds.com/0.1..

Parameters:

• replayGeometry (SymbolicConstant, default: COMPRESSEDINDEX) – A SymbolicConstant specifying the format of the geometry in the replay file. Possible values are COORDINATE, INDEX, and COMPRESSEDINDEX. The default value is COMPRESSEDINDEX.

• recoverGeometry (SymbolicConstant, default: COMPRESSEDINDEX) – A SymbolicConstant specifying the format of the geometry in the recovery file. Possible values are COORDINATE, INDEX, and COMPRESSEDINDEX. The default value is COMPRESSEDINDEX.

• defaultFormat (Optional[NumberFormat], default: None) – 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 (Optional[NumberFormat], default: None) – 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 (Optional[NumberFormat], default: None) – 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.

MemoryReductionOptions

class MemoryReductionOptions

The MemoryReductionOptions object controls the default settings that Abaqus/CAE uses for running in reduced memory mode. The MemoryReductionOptions object has no constructor. Abaqus creates the MemoryReductionOptions member when a session is started.

Note

This object can be accessed by:

session.memoryReductionOptions

Note

Check MemoryReductionOptions on help.3ds.com/0.1..

Public Methods:

setValues([reducedMemoryMode, percentThreshold])

This method modifies the MemoryReductionOptions object.

---

setValues(reducedMemoryMode=ON, percentThreshold=75)

This method modifies the MemoryReductionOptions object.

Note

Check MemoryReductionOptions.setValues on help.3ds.com/0.1..

Parameters:

• reducedMemoryMode (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether Abaqus/CAE should run in reduced memory mode. The default value is ON.

• percentThreshold (float, default: 75) – A Float specifying the percent of kernelMemoryLimit at which the reduced memory mode starts. The default value is 75.0.

NetworkDatabaseConnector

class NetworkDatabaseConnector(name, hostName, directory, remoteAbaqusDriverName='', remoteLoginMechanism=abaqusConstants.SSH, sshPath='', serverPort=0, connectionPort=0, serverTimeout=86400, allowAutomaticStartup=ON)

The NetworkDatabaseConnector object allows you to access an output database on a remote system.

Note

This object can be accessed by:

session.networkDatabaseConnectors[name]

Note

Check NetworkDatabaseConnector on help.3ds.com/0.1..

Public Data Attributes:

connected	A Boolean specifying if the connection between the client and the server is established.
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.
sshPath	A String specifying the path to the`ssh` command on the local system.
serverPort	An Int specifying the server port on the remote computer.
connectionPort	An Int specifying the connection port on the remote computer.
serverTimeout	86400 corresponds to one day.
allowAutomaticStartup	A Boolean specifying whether to start the remote network database connector server.

Public Methods:

__init__(name, hostName, directory[, ...])	This method creates a NetworkDatabaseConnector object that you can use to access a remote output database.
start([serverPort, serverTimeout])	This method starts the remote network database connector server on the remote host.
stop()	This method stops the remote network database connector server on the remote host.
setValues([remoteAbaqusDriverName, ...])	This method modifies the NetworkDatabaseConnector object.

---

allowAutomaticStartup: Union[AbaqusBoolean, bool] = ON

A Boolean specifying whether to start the remote network database connector server. The default value is ON.

connected: Union[AbaqusBoolean, bool] = OFF

A Boolean specifying if the connection between the client and the server is established.

connectionPort: int = 0

An Int specifying the connection port on the remote computer. The default value is 0.

directory: str

A String specifying the directory on the remote computer.

hostName: str

A String specifying the name of the remote computer.

name: str

A String specifying the repository key.

remoteAbaqusDriverName: str = ''

A String specifying the name of command to execute Abaqus/CAE on the remote computer.

remoteLoginMechanism: SymbolicConstant = SSH

A SymbolicConstant specifying the remote shell command on the local system. Possible values are RSH and SSH. The default value is SSH.

serverPort: int = 0

An Int specifying the server port on the remote computer. If serverPort =0, the host and remote systems are allowed to establish their own port numbers. The default value is 0.

serverTimeout: int = 86400

86400 corresponds to one day. The server exits if it does not receive any communication from the client during the time specified. The default value is 86400.

Type:

An Int specifying the timeout in seconds for the remote server. For example

setValues(remoteAbaqusDriverName='', remoteLoginMechanism=abaqusConstants.SSH, sshPath='', serverPort=0, connectionPort=0, serverTimeout=86400, allowAutomaticStartup=ON)

This method modifies the NetworkDatabaseConnector object.

Note

Check NetworkDatabaseConnector.setValues on help.3ds.com/0.1..

Parameters:

• remoteAbaqusDriverName (str, default: '') – A String specifying the name of command to execute Abaqus/CAE on the remote computer.

• remoteLoginMechanism (SymbolicConstant, default: SSH) – A SymbolicConstant specifying the remote shell command on the local system. Possible values are RSH and SSH. The default value is SSH.

• sshPath (str, default: '') – A String specifying the path to the`ssh` command on the local system. The default value is an empty string.

• serverPort (int, default: 0) – An Int specifying the server port on the remote computer. If serverPort =0, the host and remote systems are allowed to establish their own port numbers. The default value is 0.

• connectionPort (int, default: 0) – An Int specifying the connection port on the remote computer. The default value is 0.

• serverTimeout (int, default: 86400) – An Int specifying the timeout in seconds for the remote server. For example: 86400 corresponds to one day. The server exits if it does not receive any communication from the client during the time specified. The default value is 86400.

• allowAutomaticStartup (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether to start the remote network database connector server. The default value is ON.

sshPath: str = ''

A String specifying the path to the`ssh` command on the local system. The default value is an empty string.

start(serverPort=0, serverTimeout=86400)

This method starts the remote network database connector server on the remote host.

Note

Check NetworkDatabaseConnector.start on help.3ds.com/0.1..

Parameters:

• serverPort (int, default: 0) – An Int specifying the server port on the remote computer. If serverPort =0, the host and remote systems are allowed to establish their own port numbers. The default value is 0.

• serverTimeout (int, default: 86400) – An Int specifying the timeout in seconds for the remote server. For example: 86400 corresponds to one day. The server exits if it does not receive any communication from the client during the time specified. The default value is 86400.

stop()

This method stops the remote network database connector server on the remote host.

NumberFormat

class NumberFormat(blankPad=ON, format=abaqusConstants.ENGINEERING, numDigits=6, precision=0)

The NumberFormat object is a formatting template used to define formatting options for certain numeric output.This page discusses:Access[NumberFormat(…)](https://help.3ds.com/2022/english/DSSIMULIA_Established/SIMACAEKERRefMap/simaker-c-numberformatpyc.htm?ContextScope=all#simaker-numberformatnumberformatpyc)Members

Note

This object can be accessed by:

import visualization
session.defaultFieldReportOptions.numberFormat
session.fieldReportOptions.numberFormat
session.journalOptions.defaultFormat
session.journalOptions.fieldReportFormat
session.journalOptions.geometryFormat

Note

Check NumberFormat on help.3ds.com/0.1..

Public Data Attributes:

blankPad	A Boolean specifying whether the printed digits should be padded with blank characters to ensure equal sized fields.
format	A SymbolicConstant specifying the formatting type.
numDigits	An Int specifying the number of digits to be displayed in the result.
precision	An Int specifying the number of decimal places to which the number is to be truncated for display.

Public Methods:

__init__([blankPad, format, numDigits, ...])

This method creates a NumberFormat object.

---

blankPad: Union[AbaqusBoolean, bool] = ON

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: SymbolicConstant = ENGINEERING

A SymbolicConstant specifying the formatting type. Possible values are ENGINEERING, SCIENTIFIC, and AUTOMATIC. The default value is ENGINEERING.

numDigits: int = 6

An Int specifying the number of digits to be displayed in the result. numDigits >0>0. The default value is 6.

precision: int = 0

An Int specifying the number of decimal places to which the number is to be truncated for display. precision ≤0≤0. If precision =0, no truncation is applied. The default value is 0.