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

Classes¶

Session¶

class Session[source]¶

Bases: AnimationSession, CanvasSession, DisplayGroupSession, FieldReportSession, JobSession, OdbSession, PathSession, XYSession

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

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.
`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::.
`upgradeOdb`(existingOdbPath, upgradedOdbPath)	This method upgrades an existing Odb object to the current release and writes the upgraded version of the Odb object to a file.

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`([type, label])	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.

Member Details:

Other Classes¶

class AutoColors[source]¶

Bases: object

The AutoColors object defines a color palette.

Note

This object can be accessed by:

session.autoColors

Note

Check AutoColors on help.3ds.com/2017.

Member Details:

setValues(colors)[source]¶

This method changes the color palette.

Note

Check AutoColors.setValues on help.3ds.com/2017.

Parameters:¶

colors¶: 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

class Color[source]¶

Bases: object

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

Member Details:

name : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the name of the color.

rgb : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: 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)[source]¶

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

Parameters:¶

rgb¶: A sequence of three Floats specifying the RGB value of the color. The Float values must be between 0.0 and 1.0.

class Drawing(name)[source]¶

Bases: object

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

Member Details:

addArrayDraw(type, startIndex, numVertices, polygonMode=FILL)[source]¶

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

Parameters:¶

type¶: 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¶: An Integer specifying the index of the first vertex to render.
numVertices¶: An Integer specifying the total number of vertices to render.
polygonMode=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 – Drawing request extends past array size of vertices, - 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=FILL)[source]¶

Note

Check Drawing.addIndexDraw on help.3ds.com/2017.

Parameters:¶

type¶: 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¶: A sequence of Integer values specifying index of each vertex to render.
polygonMode=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 – Drawing request extends past array size of vertices, - 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 : --is-rst--:py:class:`int` = 0[source]¶: An Int specifying the number of colors in the color array after a call to the setColors method. The default value is 0.

cullBackfaces : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: 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 : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: 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 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: 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 : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'CCW'[source]¶: 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 : --is-rst--:py:class:`float` = 0[source]¶: 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 : --is-rst--:py:class:`str`[source]¶: A String specifying the repository key.

normalCount : --is-rst--:py:class:`int` = 0[source]¶: 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 : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: 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 : --is-rst--:py:class:`float` = 0[source]¶: 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)[source]¶

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

Parameters:¶

colorDimension¶: An Integer in the range of 3 to 4 specifying how many Float values are needed to compose a single color.
colorData¶: 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)[source]¶

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

Parameters:¶

edgeColor¶: 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)[source]¶

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

Parameters:¶

normalData¶: 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)[source]¶

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

Parameters:¶

pointColor¶: 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=0, cullBackfaces=0, frontFaceOrder=CCW, smoothShade=1, edgesInShaded=1, translucency=1, lineSize=0, pointSize=0, )[source]¶

This method modifies the rendering of the Drawing object.

Note

Check Drawing.setValues on help.3ds.com/2017.

Parameters:¶

show=0¶: A Boolean specifying whether the drawing object will be rendered when referenced. The default value is OFF.
cullBackfaces=0¶: 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=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=1¶: 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=1¶: 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=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=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=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.

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)[source]¶

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

Parameters:¶

vertexDimension¶: An Integer in the range of 2 to 4 specifying how many Float values are needed to compose a single vertex.
vertexData¶: 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 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether the drawing object will be rendered when referenced. The default value is OFF.

smoothShade : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: 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 : --is-rst--:py:class:`float` = 1[source]¶: 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 : --is-rst--:py:class:`int` = 0[source]¶: An Int specifying the number of vertices in the vertex array after a call to the setVertices method. The default value is 0.

class Image(name, fileName)[source]¶

Bases: object

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

Member Details:

ImageFromMovie(name, movieName, frame, time)[source]¶

This method creates an Image object from a given frame of an existing Movie object.

Note

Check ImageFromMovie on help.3ds.com/2017.

Parameters:¶

name¶: A String specifying the repository name for the image.
movieName¶: 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¶: An Int specifying the movie frame number defining the image to be extracted.
time¶: 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 – keyword error on time, If time and frame are given in the same command.

fileName : --is-rst--:py:class:`str`[source]¶: 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 : --is-rst--:py:class:`str`[source]¶: A String specifying the repository name for the image.

class JournalOptions[source]¶

Bases: object

A JournalOptions object specifies how to record selection of geometry in the journal and replay files. journalOptions can also be used to set the numeric formatting options for field report output, geometry commands output, and a default format for other numeric output. The JournalOptions object has no constructor. Abaqus creates the journalOptions member when a session is started.

Note

This object can be accessed by:

session.journalOptions

Note

Check JournalOptions on help.3ds.com/2017.

Member Details:

NumberFormat(blankPad=1, format=ENGINEERING, numDigits=6, precision=0)[source]¶

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

Parameters:¶

blankPad=1¶: 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=ENGINEERING¶: A SymbolicConstant specifying the formatting type. Possible values are ENGINEERING, SCIENTIFIC, and AUTOMATIC. The default value is ENGINEERING.
numDigits=6¶: An Int specifying the number of digits to be displayed in the result. numDigits >0>0. The default value is 6.
precision=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 : --is-rst--:py:class:`~abaqus.Session.NumberFormat.NumberFormat` = <abaqus.Session.NumberFormat.NumberFormat object>[source]¶: Format of the number

setValues( replayGeometry=COMPRESSEDINDEX, recoverGeometry=COMPRESSEDINDEX, defaultFormat=None, fieldReportFormat=None, geometryFormat=None, )[source]¶

This method modifies the JournalOptions object.

Note

Check JournalOptions.setValues on help.3ds.com/2017.

Parameters:¶

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

class NumberFormat(blankPad=1, format=ENGINEERING, numDigits=6, precision=0)[source]¶

Bases: object

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

Member Details:

blankPad : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: 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 : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ENGINEERING'[source]¶: A SymbolicConstant specifying the formatting type. Possible values are ENGINEERING, SCIENTIFIC, and AUTOMATIC. The default value is ENGINEERING.

numDigits : --is-rst--:py:class:`int` = 6[source]¶: An Int specifying the number of digits to be displayed in the result. numDigits >0>0. The default value is 6.

precision : --is-rst--:py:class:`int` = 0[source]¶: 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.

class MemoryReductionOptions[source]¶

Bases: object

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

Member Details:

setValues(reducedMemoryMode=1, percentThreshold=75)[source]¶

This method modifies the MemoryReductionOptions object.

Note

Check MemoryReductionOptions.setValues on help.3ds.com/2017.

Parameters:¶

reducedMemoryMode=1¶: A Boolean specifying whether Abaqus/CAE should run in reduced memory mode. The default value is ON.
percentThreshold=75¶: A Float specifying the percent of kernelMemoryLimit at which the reduced memory mode starts. The default value is 75.0.

class NetworkDatabaseConnector( name, hostName, directory, remoteAbaqusDriverName='', remoteLoginMechanism=SSH, sshPath='', serverPort=0, connectionPort=0, serverTimeout=86400, allowAutomaticStartup=1, )[source]¶

Bases: object

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

Member Details:

allowAutomaticStartup : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to start the remote network database connector server. The default value is ON.

connected : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying if the connection between the client and the server is established.

connectionPort : --is-rst--:py:class:`int` = 0[source]¶: An Int specifying the connection port on the remote computer. The default value is 0.

directory : --is-rst--:py:class:`str`[source]¶: A String specifying the directory on the remote computer.

hostName : --is-rst--:py:class:`str`[source]¶: A String specifying the name of the remote computer.

name : --is-rst--:py:class:`str`[source]¶: A String specifying the repository key.

remoteAbaqusDriverName : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the name of command to execute Abaqus/CAE on the remote computer.

remoteLoginMechanism : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SSH'[source]¶: A SymbolicConstant specifying the remote shell command on the local system. Possible values are RSH and SSH. The default value is SSH.

serverPort : --is-rst--:py:class:`int` = 0[source]¶: 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 : --is-rst--:py:class:`int` = 86400[source]¶

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=SSH, sshPath='', serverPort=0, connectionPort=0, serverTimeout=86400, allowAutomaticStartup=1, )[source]¶

This method modifies the NetworkDatabaseConnector object.

Note

Check NetworkDatabaseConnector.setValues on help.3ds.com/2017.

Parameters:¶

remoteAbaqusDriverName=''¶: A String specifying the name of command to execute Abaqus/CAE on the remote computer.
remoteLoginMechanism=SSH¶: A SymbolicConstant specifying the remote shell command on the local system. Possible values are RSH and SSH. The default value is SSH.
sshPath=''¶: A String specifying the path to the`ssh` command on the local system. The default value is an empty string.
serverPort=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=0¶: An Int specifying the connection port on the remote computer. The default value is 0.
serverTimeout=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=1¶: A Boolean specifying whether to start the remote network database connector server. The default value is ON.

sshPath : --is-rst--:py:class:`str` = ''[source]¶: 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)[source]¶

This method starts the remote network database connector server on the remote host.

Note

Check NetworkDatabaseConnector.start on help.3ds.com/2017.

Parameters:¶

serverPort=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=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()[source]¶: This method stops the remote network database connector server on the remote host.

class SessionBase[source]¶

Bases: object

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

Member Details:

animationOptions : --is-rst--:py:class:`~abaqus.Animation.AnimationOptions.AnimationOptions` = <abaqus.Animation.AnimationOptions.AnimationOptions object>[source]¶: An AnimationOptions object.

attachedToGui : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether an Abaqus interactive session is running.

autoColors : --is-rst--:py:class:`~abaqus.Session.AutoColors.AutoColors` = <abaqus.Session.AutoColors.AutoColors object>[source]¶: An AutoColors object specifying the color palette to be used for color coding.

aviOptions : --is-rst--:py:class:`~abaqus.Animation.AVIOptions.AVIOptions` = <abaqus.Animation.AVIOptions.AVIOptions object>[source]¶: An AVIOptions object.

charts : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.XY.Chart.Chart`] = {}[source]¶: A repository of Chart objects.

colors : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.Session.Color.Color`] = {}[source]¶: A repository of Color objects.

currentProbeValues : --is-rst--:py:class:`~abaqus.PathAndProbe.CurrentProbeValues.CurrentProbeValues` = <abaqus.PathAndProbe.CurrentProbeValues.CurrentProbeValues object>[source]¶: A CurrentProbeValues object.

currentViewportName : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the name of the current viewport.

curves : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.XY.XYCurve.XYCurve`] = {}[source]¶: A repository of XYCurve objects.

customData : --is-rst--:py:class:`~abaqus.CustomKernel.RepositorySupport.RepositorySupport` = <abaqus.CustomKernel.RepositorySupport.RepositorySupport object>[source]¶: A RepositorySupport object.

defaultChartOptions : --is-rst--:py:class:`~abaqus.XY.DefaultChartOptions.DefaultChartOptions` = <abaqus.XY.DefaultChartOptions.DefaultChartOptions object>[source]¶: A DefaultChartOptions object.

defaultFieldReportOptions : --is-rst--:py:class:`~abaqus.FieldReport.FieldReportOptions.FieldReportOptions` = <abaqus.FieldReport.FieldReportOptions.FieldReportOptions object>[source]¶: A FieldReportOptions object.

defaultFreeBodyReportOptions : --is-rst--:py:class:`~abaqus.FieldReport.FreeBodyReportOptions.FreeBodyReportOptions` = <abaqus.FieldReport.FreeBodyReportOptions.FreeBodyReportOptions object>[source]¶: A FreeBodyReportOptions object.

defaultGraphicsOptions : --is-rst--:py:class:`~abaqus.DisplayOptions.GraphicsOptions.GraphicsOptions` = <abaqus.DisplayOptions.GraphicsOptions.GraphicsOptions object>[source]¶: A GraphicsOptions object.

defaultLightOptions : --is-rst--:py:class:`~abaqus.DisplayOptions.LightOptions.LightOptions` = <abaqus.DisplayOptions.LightOptions.LightOptions object>[source]¶: A LightOptions object.

defaultMesherOptions : --is-rst--:py:class:`~abaqus.Mesh.MesherOptions.MesherOptions` = <abaqus.Mesh.MesherOptions.MesherOptions object>[source]¶: A MesherOptions object specifying how to control default settings in the Mesh module.

defaultOdbDisplay : --is-rst--:py:class:`~abaqus.OdbDisplay.DefaultOdbDisplay.DefaultOdbDisplay` = <abaqus.OdbDisplay.DefaultOdbDisplay.DefaultOdbDisplay object>[source]¶: A DefaultOdbDisplay object.

defaultPlot : --is-rst--:py:class:`~abaqus.XY.DefaultPlot.DefaultPlot` = <abaqus.XY.DefaultPlot.DefaultPlot object>[source]¶: A DefaultPlot object.

defaultProbeOptions : --is-rst--:py:class:`~abaqus.PathAndProbe.ProbeOptions.ProbeOptions` = <abaqus.PathAndProbe.ProbeOptions.ProbeOptions object>[source]¶: A ProbeOptions object.

defaultProbeReport : --is-rst--:py:class:`~abaqus.PathAndProbe.ProbeReport.ProbeReport` = <abaqus.PathAndProbe.ProbeReport.ProbeReport object>[source]¶: A ProbeReport object.

defaultViewportAnnotationOptions : --is-rst--:py:class:`~abaqus.DisplayOptions.ViewportAnnotationOptions.ViewportAnnotationOptions` = <abaqus.DisplayOptions.ViewportAnnotationOptions.ViewportAnnotationOptions object>[source]¶: A ViewportAnnotationOptions object.

defaultXYReportOptions : --is-rst--:py:class:`~abaqus.XY.XYReportOptions.XYReportOptions` = <abaqus.XY.XYReportOptions.XYReportOptions object>[source]¶: An XYReportOptions object.

disableCADConnection(CADName)[source]¶

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

Note

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

Parameters:¶

CADName¶: 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)[source]¶

This method disables an associative CAD connection using parameters.

Note

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

Parameters:¶

CADName¶: A String specifying the CAD system for which the parameter update will be disabled. Available option is Pro/ENGINEER.

displayGroups : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.DisplayGroup.DisplayGroup.DisplayGroup`] = {}[source]¶: A repository of DisplayGroup objects.

drawingArea : --is-rst--:py:class:`~abaqus.Canvas.DrawingArea.DrawingArea` = <abaqus.Canvas.DrawingArea.DrawingArea object>[source]¶: A DrawingArea object.

drawings : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.Session.Drawing.Drawing`] = {}[source]¶: A repository of Drawing objects.

enableCADConnection(CADName, portNum=None)[source]¶

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

Note

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

Parameters:¶

CADName¶: A String specifying the CAD system. Available options are Pro/ENGINEER, CATIA V5, CATIA V6, NX and SolidWorks.
portNum=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)[source]¶

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

Parameters:¶

CADName¶: A String specifying the CAD system for which parameter update will be enabled. Available options are Pro/ENGINEER and NX.
CADVersion¶: 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=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 : --is-rst--:py:class:`~abaqus.Print.EpsOptions.EpsOptions` = <abaqus.Print.EpsOptions.EpsOptions object>[source]¶: An EpsOptions object.

fieldReportOptions : --is-rst--:py:class:`~abaqus.FieldReport.FieldReportOptions.FieldReportOptions` = <abaqus.FieldReport.FieldReportOptions.FieldReportOptions object>[source]¶: A FieldReportOptions object.

freeBodies : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PathAndProbe.FreeBody.FreeBody`] = {}[source]¶: A repository of FreeBody objects.

freeBodyReportOptions : --is-rst--:py:class:`~abaqus.FieldReport.FreeBodyReportOptions.FreeBodyReportOptions` = <abaqus.FieldReport.FreeBodyReportOptions.FreeBodyReportOptions object>[source]¶: A FreeBodyReportOptions object.

graphicsInfo : --is-rst--:py:class:`~abaqus.DisplayOptions.GraphicsInfo.GraphicsInfo` = <abaqus.DisplayOptions.GraphicsInfo.GraphicsInfo object>[source]¶: A GraphicsInfo object.

graphicsOptions : --is-rst--:py:class:`~abaqus.DisplayOptions.GraphicsOptions.GraphicsOptions` = <abaqus.DisplayOptions.GraphicsOptions.GraphicsOptions object>[source]¶: A GraphicsOptions object.

imageAnimation : --is-rst--:py:class:`~abaqus.Animation.ImageAnimation.ImageAnimation` = <abaqus.Animation.ImageAnimation.ImageAnimation object>[source]¶: An ImageAnimation object.

imageAnimationOptions : --is-rst--:py:class:`~abaqus.Animation.ImageAnimationOptions.ImageAnimationOptions` = <abaqus.Animation.ImageAnimationOptions.ImageAnimationOptions object>[source]¶: An ImageAnimationOptions object.

images : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.Session.Image.Image`] = {}[source]¶: A repository of Image objects.

isCADConnectionEnabled()[source]¶

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 : --is-rst--:py:class:`~abaqus.Session.JournalOptions.JournalOptions` = <abaqus.Session.JournalOptions.JournalOptions object>[source]¶: A JournalOptions object specifying how to record selection of geometry in the journal and replay files.

kernelMemoryFootprint : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.

kernelMemoryLimit : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.

kernelMemoryMaxFootprint : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.

mdbData : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.MdbData.MdbData`] = {}[source]¶: A repository of MdbData objects.

memoryReductionOptions : --is-rst--:py:class:`~abaqus.Session.MemoryReductionOptions.MemoryReductionOptions` = <abaqus.Session.MemoryReductionOptions.MemoryReductionOptions object>[source]¶: A MemoryReductionOptions object specifying options for running in reduced memory mode.

movies : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.Animation.Movie.Movie`] = {}[source]¶: A repository of Movie objects.

networkDatabaseConnectors : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.Session.NetworkDatabaseConnector.NetworkDatabaseConnector`] = {}[source]¶: A repository of NetworkDatabaseConnector objects.

nodeQuery : --is-rst--:py:class:`~abaqus.PathAndProbe.NodeQuery.NodeQuery` = <abaqus.PathAndProbe.NodeQuery.NodeQuery object>[source]¶: A NodeQuery object specifying nodes and their coordinates in a path.

odbData : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbData.OdbData`] = {}[source]¶: A repository of OdbData objects.

odbs : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.Odb.Odb.Odb`] = {}[source]¶: A repository of Odb objects.

pageSetupOptions : --is-rst--:py:class:`~abaqus.Print.PageSetupOptions.PageSetupOptions` = <abaqus.Print.PageSetupOptions.PageSetupOptions object>[source]¶: A PageSetupOptions object.

paths : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PathAndProbe.Path.Path`] = {}[source]¶: A repository of Path objects.

pngOptions : --is-rst--:py:class:`~abaqus.Print.PngOptions.PngOptions` = <abaqus.Print.PngOptions.PngOptions object>[source]¶: A PngOptions object.

printOptions : --is-rst--:py:class:`~abaqus.Print.PrintOptions.PrintOptions` = <abaqus.Print.PrintOptions.PrintOptions object>[source]¶: A PrintOptions object.

printToFile(fileName, format=PNG, canvasObjects=(), compression=0)[source]¶

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

Parameters:¶

fileName¶: A String specifying the file to which the image is to be written. If no file extension is supplied, an extension is added based on the selected image format (.ps, .eps, .png, .tif, .svg, or .svgz).
format=PNG¶: A SymbolicConstant specifying the image format. Possible values are PNG, SVG, TIFF, PS, and EPS. The default value is PNG.
canvasObjects=()¶: A sequence of canvas objects (viewports, text strings, or arrows) to print. The default is to print all canvas objects.
compression=0¶: A Boolean specifying the format for an SVG file. It is only valid to use this argument when format is SVG. Possible values are False (Uncompressed) and True (Compressed).

printToPrinter(printCommand='', numCopies=1, canvasObjects=())[source]¶

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

Parameters:¶

printCommand=''¶

A String specifying the operating system command or printer name to issue for printing to the printer. The default value is “lpr” or the value specified by the printOptions method. If you create a script to print directly to a Windows printer, the printCommand must take the following form:

session.printToPrinter.setValues(
    printCommand='PRINTER[number of characters in name]:printername PROPERTIES[number of characters in properties]:document properties'
)

The PROPERTIES is a list of characters that represents the printing preferences for the selected Windows printer. The properties are not required in a script; the printed output will use the current settings for the selected printer. You can use ‘PRINTER[7]: DEFAULT’ to specify the default Windows printer.

numCopies=1¶

An Int specifying the number of copies to print. Possible values are 1 ≤ numCopies ≤ 100. The default value is 1.

canvasObjects=()¶

A sequence of canvas objects (viewports, text strings, or arrows) to print. The default is to print all canvas objects.

Raises:¶

SystemError – invalid print command, If printCommand is invalid.
SystemError – print command failed, If the print command fails.
RangeError – If numCopies is out of range.
TypeError – keyword error on compression, If compression is specified when format is not SVG.

probeOptions : --is-rst--:py:class:`~abaqus.PathAndProbe.ProbeOptions.ProbeOptions` = <abaqus.PathAndProbe.ProbeOptions.ProbeOptions object>[source]¶: A ProbeOptions object.

probeReport : --is-rst--:py:class:`~abaqus.PathAndProbe.ProbeReport.ProbeReport` = <abaqus.PathAndProbe.ProbeReport.ProbeReport object>[source]¶: A ProbeReport object.

psOptions : --is-rst--:py:class:`~abaqus.Print.PsOptions.PsOptions` = <abaqus.Print.PsOptions.PsOptions object>[source]¶: A PsOptions object.

queues : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.Job.Queue.Queue`] = {}[source]¶: A repository of Queue objects.

quickTimeOptions : --is-rst--:py:class:`~abaqus.Animation.QuickTimeOptions.QuickTimeOptions` = <abaqus.Animation.QuickTimeOptions.QuickTimeOptions object>[source]¶: A QuickTimeOptions object.

replayInProgress : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether Abaqus is executing a replay file.

saveOptions(directory)[source]¶

This method saves your customized display settings.

Note

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

Parameters:¶

directory¶: 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 : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.Odb.ScratchOdb.ScratchOdb`] = {}[source]¶: A repository of ScratchOdb objects.

selectedProbeValues : --is-rst--:py:class:`~abaqus.PathAndProbe.SelectedProbeValues.SelectedProbeValues` = <abaqus.PathAndProbe.SelectedProbeValues.SelectedProbeValues object>[source]¶: A SelectedProbeValues object.

sessionState : --is-rst--:py:class:`dict` | :py:obj:`None` = None[source]¶: 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)[source]¶

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

Parameters:¶

CADName¶: A String specifying the CAD system for which the port number will be saved. The available options are ‘CATIA V5’ and ‘ CATIA V6’.
Port¶: An integer specifying the port number to be used by Abaqus/CAE to send the modified parameters to the CAD system.

setValues(kernelMemoryLimit=None)[source]¶

This method modifies the Session object.

Note

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

Parameters:¶

kernelMemoryLimit=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 : --is-rst--:py:class:`~abaqus.Sketcher.ConstrainedSketchOptions.ConstrainedSketcherOptions.ConstrainedSketcherOptions` = <abaqus.Sketcher.ConstrainedSketchOptions.ConstrainedSketcherOptions.ConstrainedSketcherOptions object>[source]¶: A ConstrainedSketcherOptions object specifying common options for all sketches.

spectrums : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PathAndProbe.Spectrum.Spectrum`] = {}[source]¶: A repository of Spectrum objects.

streams : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PathAndProbe.Stream.Stream`] = {}[source]¶: A repository of Stream objects.

svgOptions : --is-rst--:py:class:`~abaqus.Print.SvgOptions.SvgOptions` = <abaqus.Print.SvgOptions.SvgOptions object>[source]¶: A SvgOptions object.

tiffOptions : --is-rst--:py:class:`~abaqus.PredefinedField.TiffOptions.TiffOptions` = <abaqus.PredefinedField.TiffOptions.TiffOptions object>[source]¶: A TiffOptions object.

updateCADParameters( modelName, CADName, parameterFile, CADPartFile, CADPartName='', )[source]¶

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

Note

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

Parameters:¶

modelName¶: A String specifying the model name to update.
CADName¶: A String specifying the CAD system for which Abaqus updates the parameters. The available options are ‘Pro/ENGINEER’, ‘CATIA V5’ and ‘CATIA V6’.
parameterFile¶: A parameter file containing the parameters that were exposed in the CAD system using the ABQ_ prefix.
CADPartFile¶: 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=''¶: 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 : --is-rst--:py:class:`~abaqus.OdbDisplay.ViewerOptions.ViewerOptions` = <abaqus.OdbDisplay.ViewerOptions.ViewerOptions object>[source]¶: A ViewerOptions object.

viewports : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.Canvas.Viewport.Viewport`] = {}[source]¶: A repository of Viewport objects.

views : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.UtilityAndView.View.View`] = {}[source]¶: A repository of View objects.

write3DXMLFile(fileName, format=0, canvasObjects=())[source]¶

This method exports the current viewport objects to a file.

Note

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

Parameters:¶

fileName¶: 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=0¶: A Boolean specifying the format. Possible values are False (Uncompressed) and True (Compressed).
canvasObjects=()¶: A sequence of canvas objects to export.

writeOBJFile(fileName, canvasObjects=())[source]¶

This method exports the current viewport objects to a file.

Note

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

Parameters:¶

fileName¶: 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=()¶: A sequence of canvas objects to export.

writeVrmlFile(fileName, format=0, canvasObjects=())[source]¶

This method exports the current viewport objects to a file.

Note

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

Parameters:¶

fileName¶: A String specifying the file to which the graphics data is to be written. If no file extension is supplied, an extension is added based on the selected format (.wrl, .wrz).
format=0¶: A Boolean specifying the format. Possible values are False (Uncompressed) and True (Compressed).
canvasObjects=()¶: A sequence of canvas objects (viewports, text strings, or arrows) to export.

xyColors : --is-rst--:py:class:`~abaqus.Session.AutoColors.AutoColors` = <abaqus.Session.AutoColors.AutoColors object>[source]¶: An AutoColors object specifying the color palette to be used forXYCurve objects.

xyDataObjects : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.XY.XYData.XYData`] = {}[source]¶: A repository of XYData objects.

xyPlots : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.XY.XYPlot.XYPlot`] = {}[source]¶: A repository of XYPlot objects.

xyReportOptions : --is-rst--:py:class:`~abaqus.XY.XYReportOptions.XYReportOptions` = <abaqus.XY.XYReportOptions.XYReportOptions object>[source]¶: An XYReportOptions object.