Path and Probe¶

Path commands are used to define a line through your model by specifying a series of points. You can view results along the path in the form of an X-Y plot. Probe commands are used to determine model data and analysis results at selected locations.

Create paths in Session¶

class PathSession[source]¶

Bases: SessionBase

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.

Member Details:

Path( name, type, expression, circleDefinition, numSegments, startAngle, endAngle, radius, radialAngle, startRadius, endRadius, )[source]¶

This method creates a Path object.

Note

This function can be accessed by:

session.Path

Note

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

Parameters:¶

name¶

A String specifying the repository key.

type¶

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

expression¶

A sequence specifying the nodes or points that make up the path. The 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¶

A SymbolicConstant specifying the method in which the circle is being defined. This argument is valid only when type = CIRCUMFERENTIAL or RADIAL. Possible values are ORIGIN_AXIS and POINT_ARC.When the value is ORIGIN_AXIS, the first two points in expression are points on the rotational axis and the third point lies on the x-axis. When the value is POINT_ARC, the three points in expression are points lying on the arc of the circle.

numSegments¶

An Int specifying the number of equal segments in the path. This argument is valid only when type = CIRCUMFERENTIAL or RADIAL.

startAngle¶

A Float specifying the start angle of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

endAngle¶

A Float specifying the end angle of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

radius¶

The SymbolicConstant CIRCLE_RADIUS or a Float specifying the radius of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

radialAngle¶

A Float specifying the angle between the radial path and the X axis of the specified coordinate system. This argument is valid only when type = RADIAL.

startRadius¶

The SymbolicConstant CIRCLE_RADIUS or a Float specifying the start radius of the radial path. This argument is valid only when type = RADIAL.

endRadius¶

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

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

Parameters:¶

name¶: A string name for the spectrum.
colors¶: A sequence of strings indicating the colors of the spectrum.

Returns:¶

A Spectrum object.

Return type:¶

Spectrum

Stream(name, numPointsOnRake, pointA=(), pointB=(), path='')[source]¶

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

Parameters:¶

name¶: A string name for the stream.
numPointsOnRake¶: An integer specifying the number of points along the rake.
pointA=()¶: A tuple of 3 floats specifying the starting point of the rake. Alternatively, a string representation of the node selected in the viewport.
pointB=()¶: A tuple of 3 floats specifying the end point of the rake. Alternatively, a string representation of the node selected in the viewport.
path=''¶: APath object that specifies the rake.

Returns:¶

A Stream object.

Return type:¶

Stream

Create free bodies in Session¶

class FreeBody[source]¶

Bases: object

The FreeBody object defines a section across which resultant forces and moments are computed.

Note

This object can be accessed by:

import visualization
session.freeBodies[name]

Note

Check FreeBody on help.3ds.com/2024.

Public Methods:

`FreeBodyFromEdges`(name, edges[, ...])	This method creates a FreeBody object and places it in the freeBodies repository.
`FreeBodyFromFaces`(name, faces[, ...])	This method creates a FreeBody object and places it in the freeBodies repository.
`FreeBodyFromNodesElements`(name, elements, nodes)	This method creates a FreeBody object and places it in the freeBodies repository.

Member Details:

FreeBodyFromEdges( name, edges, summationLoc=CENTROID, summationPoint=(), componentResolution=NORMAL_TANGENTIAL, csysName='', )[source]¶

This method creates a FreeBody object and places it in the freeBodies repository.

Note

This function can be accessed by:

session.FreeBodyFromEdges

Note

Check FreeBodyFromEdges on help.3ds.com/2024.

Parameters:¶

name¶: A string name for the free body.
edges¶: A DisplayGroup leaf object that specifies the physical constituents of the free body.
summationLoc=CENTROID¶: A SymbolicConstant specifying the location of the summation point. Possible values are CENTROID, NODAL_AVERAGE and SPECIFY. The default value is CENTROID.
summationPoint=()¶: A tuple of 3 floats specifying the summation point.
componentResolution=NORMAL_TANGENTIAL¶: A SymbolicConstant specifying the component resolution. Possible values are NORMAL_TANGENTIAL and CSYS. The default value is NORMAL_TANGENTIAL.
csysName=''¶: A string specifying the name of the coordinate system.

Returns:¶

A FreeBody object.

Return type:¶

FreeBody

FreeBodyFromFaces( name, faces, summationLoc=CENTROID, summationPoint=(), componentResolution=NORMAL_TANGENTIAL, csysName='', )[source]¶

This method creates a FreeBody object and places it in the freeBodies repository.

Note

This function can be accessed by:

session.FreeBodyFromEdges

Note

Check FreeBodyFromFaces on help.3ds.com/2024.

Parameters:¶

name¶: A string name for the free body.
faces¶: A DisplayGroup leaf object that specifies the physical constituents of the free body.
summationLoc=CENTROID¶: A SymbolicConstant specifying the location of the summation point. Possible values are CENTROID, NODAL_AVERAGE and SPECIFY. The default value is CENTROID.
summationPoint=()¶: A tuple of 3 floats specifying the summation point.
componentResolution=NORMAL_TANGENTIAL¶: A SymbolicConstant specifying the component resolution. Possible values are NORMAL_TANGENTIAL and CSYS. The default value is NORMAL_TANGENTIAL.
csysName=''¶: A string specifying the name of the coordinate system.

Returns:¶

A FreeBody object.

Return type:¶

FreeBody

FreeBodyFromNodesElements( name, elements, nodes, summationLoc=CENTROID, summationPoint=(), componentResolution=NORMAL_TANGENTIAL, csysName='', )[source]¶

This method creates a FreeBody object and places it in the freeBodies repository.

Note

This function can be accessed by:

session.FreeBodyFromEdges

Note

Check FreeBodyFromNodesElements on help.3ds.com/2024.

Parameters:¶

name¶: A string name for the free body.
elements¶: A DisplayGroup leaf object that specifies the physical constituents of the free body.
nodes¶: A DisplayGroup leaf object that specifies the physical constituents of the free body.
summationLoc=CENTROID¶: A SymbolicConstant specifying the location of the summation point. Possible values are CENTROID, NODAL_AVERAGE and SPECIFY. The default value is CENTROID.
summationPoint=()¶: A tuple of 3 floats specifying the summation point.
componentResolution=NORMAL_TANGENTIAL¶: A SymbolicConstant specifying the component resolution. Possible values are NORMAL_TANGENTIAL and CSYS. The default value is NORMAL_TANGENTIAL.
csysName=''¶: A string specifying the name of the coordinate system.

Returns:¶

A FreeBody object.

Return type:¶

FreeBody

Other Classes¶

class CurrentProbeValues[source]¶

Bases: object

The CurrentProbeValues object has no constructor. The CurrentProbeValues object is created when you import the Visualization module.

Note

This object can be accessed by:

import visualization
session.currentProbeValues

Note

Check CurrentProbeValues on help.3ds.com/2024.

Member Details:

values : --is-rst--:py:data:`~typing.Optional`\ \[:py:class:`~typing.Sequence`\ \[:py:class:`float`]] = None[source]¶: A tuple of Floats specifying the values obtained while probing. These values are updated constantly as the user moves the mouse over the object being probed.

class NodeQuery[source]¶

Bases: object

The NodeQuery object specifies nodes and their coordinates in a path. The NodeQuery object has no constructor or methods. Abaqus creates the nodeQuery member when you import the visualization module.

Note

This object can be accessed by:

import visualization
session.nodeQuery

Note

Check NodeQuery on help.3ds.com/2024.

Member Details:

nodeId : --is-rst--:py:class:`int` | :py:obj:`None` = None[source]¶: An Int specifying the ID of the most recently queried node. If the last query was unsuccessful, nodeID = −1.

nodePos : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A tuple of Floats specifying the X, Y, and Z coordinates of the most recently queried node.

class Path( name, type, expression, circleDefinition, numSegments, startAngle, endAngle, radius, radialAngle, startRadius, endRadius, )[source]¶

Bases: object

The Path object defines a line through your model by specifying a series of nodes or points.

Note

This object can be accessed by:

import visualization
session.paths[name]

Note

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

Member Details:

circleDefinition : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]¶: 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.

coordinates : --is-rst--:py:class:`list`\ \[:py:class:`~typing.Sequence`\ \[:py:class:`float`]] = [][source]¶: If type = NODE_LIST, coordinates is a sequence of tuples of three Floats. This can be used as the value for the expression argument when creating a Path object of type = POINT_LIST.

endAngle : --is-rst--:py:class:`float`[source]¶: A Float specifying the end angle of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

endRadius : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`][source]¶: The SymbolicConstant CIRCLE_RADIUS or a Float specifying the end radius of the radial path. This argument is valid only when type = RADIAL.

expression : --is-rst--:py:class:`tuple`[source]¶: of three Floats, specifying the coordinates of the points used to define a coordinate system.

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

numSegments : --is-rst--:py:class:`int`[source]¶: An Int specifying the number of equal segments in the path. This argument is valid only when type = CIRCUMFERENTIAL or RADIAL.

radialAngle : --is-rst--:py:class:`float`[source]¶: 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.

radius : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`][source]¶: The SymbolicConstant CIRCLE_RADIUS or a Float specifying the radius of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

startAngle : --is-rst--:py:class:`float`[source]¶: A Float specifying the start angle of the circumferential path. This argument is valid only when type = CIRCUMFERENTIAL.

startRadius : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`][source]¶: The SymbolicConstant CIRCLE_RADIUS or a Float specifying the start radius of the radial path. This argument is valid only when type = RADIAL.

type : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]¶: A SymbolicConstant specifying the type of path being created. Possible values are NODE_LIST, POINT_LIST, EDGE_LIST, CIRCUMFERENTIAL, and RADIAL.

class Spectrum(name, colors)[source]¶

Bases: object

The Spectrum object defines a color spectrum for the contour display.

Note

This object can be accessed by:

import visualization
session.spectrums[name]

Note

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

Member Details:

class Stream(name, numPointsOnRake, pointA=(), pointB=(), path='')[source]¶

Bases: object

TheStream object defines a set of streamlines in fluid mechanics.

Note

This object can be accessed by:

import visualization
session.streams[name]

Note

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

Member Details:

class ProbeOptions[source]¶

Bases: object

The ProbeOptions object is used to store settings associated with probing a model or an.

X - Y plot. The ProbeOptions object has no constructor. Abaqus creates the defaultProbeOptions and the probeOptions members when you import the Visualization module. When probing is initiated for the first time, the values in the probeOptions member are initialized using the values from the defaultProbeOptions member.

Note

This object can be accessed by:

import visualization
session.defaultProbeOptions
session.probeOptions

Note

Check ProbeOptions on help.3ds.com/2024.

Member Details:

attachedElements : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the elements attached to a node when probeObject = ODB and probeEntity = NODE. The default value is ON.

baseCoordinates : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the base coordinates of a node when probeObject = ODB and probeEntity = NODE. The default value is ON.

deformedCoordinates : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the deformed coordinates of a node when probeObject = ODB and probeEntity = NODE. The default value is ON.

elementConnectivity : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the element connectivity. This member is valid when probeObject = ODB and probeEntity = ELEMENT. The default value is ON.

elementFieldResults : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the element field output results. This member is valid when probeObject = ODB, probeEntity = ELEMENT, and isFieldOutputAvailable = ON. The default value is ON.

elementID : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the element ID information. This member is valid when probeObject = ODB and probeEntity = ELEMENT. The default value is ON.

elementType : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the element type information. This member is valid when probeObject = ODB and probeEntity = ELEMENT. The default value is ON.

interpolateXy : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to interpolate values within a line segment when probeObject = XYPlot. When interpolateXy = OFF, probing returns the nearest X - Y data point on the curve. When interpolateXy = ON, probing interpolates data to return a value at the nearest point on the curve. The default value is OFF.

isFieldOutputAvailable : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether field output is available for probing when probeObject = XYPlot. This member is read-only.

legend : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the legend for a curve being probed. This member is valid when probeObject = XYPlot. The default value is ON.

nodeFieldResults : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the node field output results. This member is valid when probeObject = ODB, probeEntity = NODE, and isFieldOutputAvailable = ON. The default value is ON.

nodeId : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the node ID when probeObject = ODB and probeEntity = NODE. The default value is ON.

partInstance : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the part instance information. This member is valid when probeObject = ODB. The default value is ON.

probeEntity : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ELEMENT'[source]¶: A SymbolicConstant specifying the entity being probed when probeObject = “ODB”. Possible values are NODE and ELEMENT. The default value is ELEMENT.

probeObject : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the type of the displayed object being probed. Possible values are “ODB” and “XYPlot”. This member is read-only.

probeOutputPosition : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]¶: A SymbolicConstant specifying the output position to probe for field output results when probeObject = “ODB”. Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, and ELEMENT_CENTROID.When probeEntity = NODE, the only possible value is NODAL. When probeEntity = ELEMENT, the only possible values are INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, and ELEMENT_CENTROID, and the default is INTEGRATION_POINT.

sequenceID : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the sequence ID of the point on the curve being probed. This member is valid when probeObject = XYPlot. The default value is ON.

setValues( options=None, probeEntity=ELEMENT, probeOutputPosition=None, partInstance=1, elementID=1, elementType=1, elementConnectivity=1, elementFieldResults=1, nodeId=1, baseCoordinates=1, deformedCoordinates=1, attachedElements=1, nodeFieldResults=1, legend=1, xValue=1, yValue=1, sequenceID=1, interpolateXy=0, )[source]¶

This method modifies the settings on the ProbeOptions object.

Note

Check ProbeOptions.setValues on help.3ds.com/2024.

Parameters:¶

options=None¶: A ProbeOptions object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None.
probeEntity=ELEMENT¶: A SymbolicConstant specifying the entity being probed when probeObject = “ODB”. Possible values are NODE and ELEMENT. The default value is ELEMENT.
probeOutputPosition=None¶: A SymbolicConstant specifying the output position to probe for field output results when probeObject = “ODB”. Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, and ELEMENT_CENTROID.When probeEntity = NODE, the only possible value is NODAL. When probeEntity = ELEMENT, the only possible values are INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, and ELEMENT_CENTROID, and the default is INTEGRATION_POINT.
partInstance=1¶: A Boolean specifying whether to display the part instance information. This member is valid when probeObject = ODB. The default value is ON.
elementID=1¶: A Boolean specifying whether to display the element ID information. This member is valid when probeObject = ODB and probeEntity = ELEMENT. The default value is ON.
elementType=1¶: A Boolean specifying whether to display the element type information. This member is valid when probeObject = ODB and probeEntity = ELEMENT. The default value is ON.
elementConnectivity=1¶: A Boolean specifying whether to display the element connectivity. This member is valid when probeObject = ODB and probeEntity = ELEMENT. The default value is ON.
elementFieldResults=1¶: A Boolean specifying whether to display the element field output results. This member is valid when probeObject = ODB, probeEntity = ELEMENT, and isFieldOutputAvailable = ON. The default value is ON.
nodeId=1¶: A Boolean specifying whether to display the node ID when probeObject = ODB and probeEntity = NODE. The default value is ON.
baseCoordinates=1¶: A Boolean specifying whether to display the base coordinates of a node when probeObject = ODB and probeEntity = NODE. The default value is ON.
deformedCoordinates=1¶: A Boolean specifying whether to display the deformed coordinates of a node when probeObject = ODB and probeEntity = NODE. The default value is ON.
attachedElements=1¶: A Boolean specifying whether to display the elements attached to a node when probeObject = ODB and probeEntity = NODE. The default value is ON.
nodeFieldResults=1¶: A Boolean specifying whether to display the node field output results. This member is valid when probeObject = ODB, probeEntity = NODE, and isFieldOutputAvailable = ON. The default value is ON.
legend=1¶: A Boolean specifying whether to display the legend for a curve being probed. This member is valid when probeObject = XYPlot. The default value is ON.
xValue=1¶: A Boolean specifying whether to display the X coordinate value of the point on the curve being probed. This member is valid when probeObject = XYPlot. The default value is ON.
yValue=1¶: A Boolean specifying whether to display the Y coordinate value of the point on the curve being probed. This member is valid when probeObject = XYPlot. The default value is ON.
sequenceID=1¶: A Boolean specifying whether to display the sequence ID of the point on the curve being probed. This member is valid when probeObject = XYPlot. The default value is ON.
interpolateXy=0¶: A Boolean specifying whether to interpolate values within a line segment when probeObject = XYPlot. When interpolateXy = OFF, probing returns the nearest X - Y data point on the curve. When interpolateXy = ON, probing interpolates data to return a value at the nearest point on the curve. The default value is OFF.

xValue : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the X coordinate value of the point on the curve being probed. This member is valid when probeObject = XYPlot. The default value is ON.

yValue : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to display the Y coordinate value of the point on the curve being probed. This member is valid when probeObject = XYPlot. The default value is ON.

class ProbeReport[source]¶

Bases: object

The ProbeReport object is used to store settings associated with tabular reports of probe data. The ProbeReport object has no constructor. Abaqus creates the defaultProbeReport and the probeReport members when you import the Visualization module. When probing is initiated for the first time, the values in the probeReport member are initialized using the values from the defaultProbeReport member.

Note

This object can be accessed by:

import visualization
session.defaultProbeReport
session.probeReport

Note

Check ProbeReport on help.3ds.com/2024.

Member Details:

setValues( options=None, numColumns=80, numDigits=6, numFormat=ENGINEERING, pageWidth=NO_LIMIT, printTotal=0, printMinMax=0, )[source]¶

This method modifies the ProbeReport object.

Note

Check ProbeReport.setValues on help.3ds.com/2024.

Parameters:¶

options=None¶: None or a ProbeReport object specifying values to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None.
numColumns=80¶: An Int specifying the number of columns in the report file. This argument is valid only when pageWidth = SPECIFY. The default value is 80.
numDigits=6¶: An Int specifying the number of significant digits to be written for decimal values. The default value is 6.
numFormat=ENGINEERING¶: A SymbolicConstant specifying the number format to be used when formatting decimal values. Possible values are AUTOMATIC, ENGINEERING, and SCIENTIFIC. The default value is ENGINEERING.
pageWidth=NO_LIMIT¶: A SymbolicConstant specifying the page width format. Possible values are NO_LIMIT and SPECIFY. The default value is NO_LIMIT.
printTotal=0¶: A Boolean specifying whether to print the total value of either the field output result (when probeObject = ”ODB”) or the X and Y coordinates (when probeObject = XYPlot). The default value is OFF.
printMinMax=0¶: A Boolean specifying whether to print the minimum and maximum values of either the field output result (when probeObject = ”ODB”) or the X and Y coordinates (when probeObject = XYPlot). The default value is OFF.

class SelectedProbeValues[source]¶

Bases: object

The SelectedProbeValues object has no constructor. The SelectedProbeValues object is created when you import the Visualization module.

Note

This object can be accessed by:

import visualization
session.selectedProbeValues

Note

Check SelectedProbeValues on help.3ds.com/2024.

Member Details:

fieldOutputAvailable : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether any probe values have been selected (as is necessary prior to writing to a file).

lastValues : --is-rst--:py:class:`tuple` = ()[source]¶: A tuple of Floats specifying the last sequence of the values member.

length : --is-rst--:py:class:`int` | :py:obj:`None` = None[source]¶: An Int specifying the length of the values member.

values : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A tuple of tuples of Floats specifying the selected probe values.