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

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.

Path(name: str, type: SymbolicConstantType, expression: tuple, circleDefinition: SymbolicConstantType, numSegments: int, startAngle: float, endAngle: float, radius: SymbolicConstantType | float, radialAngle: float, startRadius: SymbolicConstantType | float, endRadius: SymbolicConstantType | float) → Path[source]#

This method creates a Path object.

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.

Raises:

ModelError, ErrorUnsupportedNodeData, ErrorUnsupportedPointData, ErrorIncorrectPathData,
KeyError, ErrorEmptyPathName, ErrorPathNotFound, and ErrorNoOdbPathDisplay.
ValueError: When *type*=CIRCUMFERENTIAL or RADIAL, the three points specified in
expression are collinear.

Notes

This function can be accessed by:

session.Path

Spectrum(name: str, colors: tuple) → Spectrum[source]#

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

Parameters:

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

Returns:

A Spectrum object.

Notes

This function can be accessed by:

session.Spectrum

Stream(name: str, numPointsOnRake: str, pointA: tuple = (), pointB: tuple = (), path: str = '') → Stream[source]#

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

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.

Notes

This function can be accessed by:

session.Stream

Create free bodies in Session#

class FreeBody[source]#

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

Notes

This object can be accessed by:

import visualization
session.freeBodies[name]

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.

FreeBodyFromEdges(name: str, edges: str, summationLoc: SymbolicConstantType = 'CENTROID', summationPoint: tuple = (), componentResolution: SymbolicConstantType = 'NORMAL_TANGENTIAL', csysName: str = '')[source]#

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

Parameters:

name: A string name for the free body.
edges: A DisplayGroup leaf object that specifies the physical constituents of the free body.
summationLoc: 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: 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.

Notes

This function can be accessed by:

session.FreeBodyFromEdges

FreeBodyFromFaces(name: str, faces: str, summationLoc: SymbolicConstantType = 'CENTROID', summationPoint: tuple = (), componentResolution: SymbolicConstantType = 'NORMAL_TANGENTIAL', csysName: str = '')[source]#

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

Parameters:

name: A string name for the free body.
faces: A DisplayGroup leaf object that specifies the physical constituents of the free body.
summationLoc: 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: 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.

Notes

This function can be accessed by:

session.FreeBodyFromEdges

FreeBodyFromNodesElements(name: str, elements: str, nodes: str, summationLoc: SymbolicConstantType = 'CENTROID', summationPoint: tuple = (), componentResolution: SymbolicConstantType = 'NORMAL_TANGENTIAL', csysName: str = '')[source]#

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

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

Notes

This function can be accessed by:

session.FreeBodyFromEdges

Object features#

CurrentProbeValues#

class CurrentProbeValues[source]#

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

Notes

This object can be accessed by:

import visualization
session.currentProbeValues

Attributes:

values: tuple[float]: 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.

NodeQuery#

class NodeQuery[source]#

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.

Notes

This object can be accessed by:

import visualization
session.nodeQuery

Attributes:

nodeId: int: An Int specifying the ID of the most recently queried node. If the last query was unsuccessful, **nodeID**=−1.
nodePos: float: A tuple of Floats specifying the X-, Y-, and Z-coordinates of the most recently queried node.

Path#

class Path(name: str, type: SymbolicConstantType, expression: tuple, circleDefinition: SymbolicConstantType, numSegments: int, startAngle: float, endAngle: float, radius: SymbolicConstantType | float, radialAngle: float, startRadius: SymbolicConstantType | float, endRadius: SymbolicConstantType | float)[source]#

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

Notes

This object can be accessed by:

import visualization
session.paths[name]

Attributes:

coordinates: list[tuple[float]]: 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.

ProbeOptions#

class ProbeOptions[source]#

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.

Notes

This object can be accessed by:

import visualization
session.defaultProbeOptions
session.probeOptions

Attributes:

probeEntity: SymbolicConstant: A SymbolicConstant specifying the entity being probed when **probeObject**=”ODB”. Possible values are NODE and ELEMENT. The default value is ELEMENT.
probeOutputPosition: SymbolicConstant: 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: Boolean: A Boolean specifying whether to display the part instance information. This member is valid when probeObject=ODB. The default value is ON.
elementID: Boolean: 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: Boolean: 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: Boolean: 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: Boolean: 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: Boolean: A Boolean specifying whether to display the node ID when probeObject=ODB and probeEntity=NODE. The default value is ON.
baseCoordinates: Boolean: A Boolean specifying whether to display the base coordinates of a node when probeObject=ODB and probeEntity=NODE. The default value is ON.
deformedCoordinates: Boolean: A Boolean specifying whether to display the deformed coordinates of a node when probeObject=ODB and probeEntity=NODE. The default value is ON.
attachedElements: Boolean: A Boolean specifying whether to display the elements attached to a node when probeObject=ODB and probeEntity=NODE. The default value is ON.
nodeFieldResults: Boolean: 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: Boolean: 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: Boolean: 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: Boolean: 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: Boolean: 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: Boolean: 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: Boolean: A Boolean specifying whether field output is available for probing when probeObject=XYPlot. This member is read-only.
probeObject: str: A String specifying the type of the displayed object being probed. Possible values are “ODB” and “XYPlot”. This member is read-only.

Methods

setValues([options, probeEntity, ...])

This method modifies the settings on the ProbeOptions object.

setValues(options: ProbeOptions | None = None, probeEntity: SymbolicConstantType = 'ELEMENT', probeOutputPosition: SymbolicConstantType | None = None, partInstance: BooleanType = 1, elementID: BooleanType = 1, elementType: BooleanType = 1, elementConnectivity: BooleanType = 1, elementFieldResults: BooleanType = 1, nodeId: BooleanType = 1, baseCoordinates: BooleanType = 1, deformedCoordinates: BooleanType = 1, attachedElements: BooleanType = 1, nodeFieldResults: BooleanType = 1, legend: BooleanType = 1, xValue: BooleanType = 1, yValue: BooleanType = 1, sequenceID: BooleanType = 1, interpolateXy: BooleanType = 0)[source]#

This method modifies the settings on the ProbeOptions object.

Parameters:

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

ProbeReport#

class ProbeReport[source]#

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.

Notes

This object can be accessed by:

import visualization
session.defaultProbeReport
session.probeReport

Methods

setValues([options, numColumns, numDigits, ...])

This method modifies the ProbeReport object.

setValues(options: str | None = None, numColumns: int = 80, numDigits: int = 6, numFormat: SymbolicConstantType = 'ENGINEERING', pageWidth: SymbolicConstantType = 'NO_LIMIT', printTotal: BooleanType = 0, printMinMax: BooleanType = 0)[source]#

This method modifies the ProbeReport object.

Parameters:

options: 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: 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: An Int specifying the number of significant digits to be written for decimal values. The default value is 6.
numFormat: A SymbolicConstant specifying the number format to be used when formatting decimal values. Possible values are AUTOMATIC, ENGINEERING, and SCIENTIFIC. The default value is ENGINEERING.
pageWidth: A SymbolicConstant specifying the page width format. Possible values are NO_LIMIT and SPECIFY. The default value is NO_LIMIT.
printTotal: A Boolean specifying whether to print the total value of either the field output result (when probeObject*=”ODB”) or the *x- and y-coordinates (when *probeObject*=XYPlot). The default value is OFF.
printMinMax: A Boolean specifying whether to print the minimum and maximum values of either the field output result (when probeObject*=”ODB”) or the *x- and y-coordinates (when *probeObject*=XYPlot). The default value is OFF.

SelectedProbeValues#

class SelectedProbeValues[source]#

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

Notes

This object can be accessed by:

import visualization
session.selectedProbeValues

Attributes:

length: int: An Int specifying the length of the values member.
fieldOutputAvailable: Boolean: A Boolean specifying whether any probe values have been selected (as is necessary prior to writing to a file).
values: float: A tuple of tuples of Floats specifying the selected probe values.
lastValues: tuple: A tuple of Floats specifying the last sequence of the values member.

Spectrum#

class Spectrum(name: str, colors: tuple)[source]#

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

Notes

This object can be accessed by:

import visualization
session.spectrums[name]

Stream#

class Stream(name: str, numPointsOnRake: str, pointA: tuple = (), pointB: tuple = (), path: str = '')[source]#

TheStream object defines a set of streamlines in fluid mechanics.

Notes

This object can be accessed by:

import visualization
session.streams[name]