Odb Display#

Odb display commands are used to store the context of an output database for a viewport.

Object features#

CommonOptions#

class CommonOptions[source]#

The CommonOptions object stores values and attributes that are common to all plot states. The CommonOptions object has no constructor command. Abaqus creates a defaultOdbDisplay.commonOptions member when you import the Visualization module. Abaqus creates a commonOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.commonOptions. Abaqus creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. CommonOptions objects are accessed in one of two ways: - The default common options. These settings are used as defaults when other commonOptions members are created. These settings can be set to customize user preferences. - The common options associated with a particular viewport. The CommonOptions object is derived from the DGCommonOptions object.

Notes

This object can be accessed by:

import visualization
session.defaultOdbDisplay.commonOptions
session.viewports[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.commonOptions
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.commonOptions
session.viewports[name].layers[name].odbDisplay.commonOptions
session.viewports[name].layers[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.commonOptions
session.viewports[name].layers[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.commonOptions
session.viewports[name].odbDisplay.commonOptions
session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.commonOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.commonOptions

Attributes:

deformationScaling: SymbolicConstant

A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The default value is AUTO.

uniformScaleFactor: float

A Float specifying the uniform deformation scaling constant when deformationScaling=UNIFORM. The default value is autoDeformationScaleValue.

autoDeformationScaleValue: float

A Float specifying the deformation scale factor value when deformationScaling=AUTO. This value is read-only.

nonuniformScaleFactor: float

A tuple of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The default value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue).

renderStyle: SymbolicConstant

A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The default value is SHADED.

visibleEdges: SymbolicConstant

A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. The default value is EXTERIOR.NONE can be used only when renderStyle=SHADED.

edgeLineStyle: SymbolicConstant

A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

edgeLineThickness: SymbolicConstant

A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

colorCodeOverride: Boolean

A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The default value is ON.

elemLabels: Boolean

A Boolean specifying whether to plot the element labels. The default value is OFF.

faceLabels: Boolean

A Boolean specifying whether to plot the face labels. The default value is OFF.

nodeLabels: Boolean

A Boolean specifying whether to plot the node labels. The default value is OFF.

nodeSymbols: Boolean

A Boolean specifying whether to plot the node symbols. The default value is OFF.

nodeSymbolType: SymbolicConstant

A SymbolicConstant specifying the node symbol types. Possible values are:

FILLED_CIRCLE
FILLED_SQUARE
FILLED_DIAMOND
FILLED_TRI
HOLLOW_CIRCLE
HOLLOW_SQUARE
HOLLOW_DIAMOND
HOLLOW_TRI
CROSS
XMARKER

The default value is HOLLOW_CIRCLE.

nodeSymbolSize: SymbolicConstant

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

elementShrink: Boolean

A Boolean specifying whether elements are displayed in a shrunk format. The default value is OFF.

elementShrinkFactor: int

An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0≤≤ elementShrinkPercentage ≤≤ 90. The default value is 5.

coordinateScale: Boolean

A Boolean specifying whether to scale coordinates. The default value is OFF.

normals: Boolean

A Boolean specifying whether to draw arrows that indicate the directions of element and surface normals. The default value is OFF.

normalDisplay: SymbolicConstant

A SymbolicConstant specifying whether to draw element normals or surface normals. Possible values are ELEMENT and SURFACE. The default value is ELEMENT.

normalArrowLength: SymbolicConstant

A SymbolicConstant specifying the length of the normal arrows. Possible values are SHORT, MEDIUM, and LONG. The default value is MEDIUM.

normalLineThickness: SymbolicConstant

A SymbolicConstant specifying the thickness of the normal arrows. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

normalArrowheadStyle: SymbolicConstant

A SymbolicConstant specifying the arrowhead style of the normal arrows. Possible values are NONE, FILLED, and WIRE. The default value is WIRE.

translucency: Boolean

A Boolean specifying whether to set translucency. The default value is OFF.

translucencyFactor: float

A Float specifying the translucency factor when translucency=ON. Possible values are 0.0≤≤ translucencyFactor ≤≤ 1.0. The default value is 0.3.

edgeColorWireHide: str

A String specifying the color to be used to plot the edges of the model when renderStyle=WIREFRAME or HIDDEN. The default value is “White”.

edgeColorFillShade: str

A String specifying the color to be used to plot the edges of the model when renderStyle=FILLED or SHADED. The default value is “Black”.

fillColor: str

A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The default value is “White”.

labelFont: str

A String specifying the label font to be used for all model labels. The default value is “--courier-medium-r-normal---120---m---“.

elemLabelColor: str

A String specifying the color to be used to plot the element labels. The default value is “Cyan”.

faceLabelColor: str

A String specifying the color to be used to plot the face labels. The default value is “Red”.

nodeLabelColor: str

A String specifying the color to be used to plot the node labels. The default value is “Yellow”.

nodeSymbolColor: str

A String specifying the color to be used to plot the node symbols. The default value is “Yellow”.

faceNormalColor: str

A String specifying the color to be used to plot the normal to a nonbeam element or to a surface. The default value is “Red”.

beamN1Color: str

A String specifying the color to be used to plot an arrow along the beam n1n1-direction. The default value is “Blue”.

beamN2Color: str

A String specifying the color to be used to plot an arrow along the beam n2n2-direction. The default value is “Red”.

beamTangentColor: str

A String specifying the color to be used to plot an arrow along the tangent to a beam. The default value is “White”.

coordinateScaleFactors: float

A tuple of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The default value is (1, 1, 1).

Methods

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

This method modifies the CommonOptions object.

setValues(options: CommonOptions | None = None, renderStyle: SymbolicConstantType = 'SHADED', visibleEdges: SymbolicConstantType = 'EXTERIOR', deformationScaling: SymbolicConstantType = 'AUTO', uniformScaleFactor: float | None = None, nonuniformScaleFactor: tuple = (), edgeColorWireHide: str = '', edgeColorFillShade: str = '', edgeLineStyle: SymbolicConstantType = 'SOLID', edgeLineThickness: SymbolicConstantType = 'VERY_THIN', fillColor: str = '', colorCodeOverride: BooleanType = 1, labelFont: str = '', elemLabels: BooleanType = 0, elemLabelColor: str = '', faceLabels: BooleanType = 0, faceLabelColor: str = '', nodeLabels: BooleanType = 0, nodeLabelColor: str = '', nodeSymbols: BooleanType = 0, nodeSymbolType: SymbolicConstantType = 'HOLLOW_CIRCLE', nodeSymbolColor: str = '', nodeSymbolSize: SymbolicConstantType = 'SMALL', elementShrink: BooleanType = 0, elementShrinkFactor: int = 5, coordinateScale: BooleanType = 0, coordinateScaleFactors: tuple = (), normals: BooleanType = 0, normalDisplay: SymbolicConstantType = 'ELEMENT', faceNormalColor: str = '', beamN1Color: str = '', beamN2Color: str = '', beamTangentColor: str = '', normalArrowLength: SymbolicConstantType = 'MEDIUM', normalLineThickness: SymbolicConstantType = 'VERY_THIN', normalArrowheadStyle: SymbolicConstantType = 'WIRE', translucency: BooleanType = 0, translucencyFactor: float = 0)[source]#

This method modifies the CommonOptions object.

Parameters:

options

A CommonOptions 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.

renderStyle

A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The default value is SHADED.

visibleEdges

A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. The default value is EXTERIOR.NONE can be used only when *renderStyle*=SHADED.

deformationScaling

A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The default value is AUTO.

uniformScaleFactor

A Float specifying the uniform deformation scaling constant when deformationScaling*=UNIFORM. The default value is *autoDeformationScaleValue.

nonuniformScaleFactor

A sequence of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling*=NONUNIFORM. The default value is (*autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue).

edgeColorWireHide

A String specifying the color to be used to plot the edges of the model when *renderStyle*=WIREFRAME or HIDDEN. The default value is “White”.

edgeColorFillShade

A String specifying the color to be used to plot the edges of the model when *renderStyle*=FILLED or SHADED. The default value is “Black”.

edgeLineStyle

A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

edgeLineThickness

A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

fillColor

A String specifying the color to be used to fill elements when *renderStyle*=FILLED or SHADED. The default value is “White”.

colorCodeOverride

A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The default value is ON.

labelFont

A String specifying the label font to be used for all model labels. The default value is “--courier-medium-r-normal---120---m---“.

elemLabels

A Boolean specifying whether to plot the element labels. The default value is OFF.

elemLabelColor

A String specifying the color to be used to plot the element labels. The default value is “Cyan”.

faceLabels

A Boolean specifying whether to plot the face labels. The default value is OFF.

faceLabelColor

A String specifying the color to be used to plot the face labels. The default value is “Red”.

nodeLabels

A Boolean specifying whether to plot the node labels. The default value is OFF.

nodeLabelColor

A String specifying the color to be used to plot the node labels. The default value is “Yellow”.

nodeSymbols

A Boolean specifying whether to plot the node symbols. The default value is OFF.

nodeSymbolType

A SymbolicConstant specifying the node symbol types. Possible values are:

FILLED_CIRCLE
FILLED_SQUARE
FILLED_DIAMOND
FILLED_TRI
HOLLOW_CIRCLE
HOLLOW_SQUARE
HOLLOW_DIAMOND
HOLLOW_TRI
CROSS
XMARKER

The default value is HOLLOW_CIRCLE.

nodeSymbolColor

A String specifying the color to be used to plot the node symbols. The default value is “Yellow”.

nodeSymbolSize

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

elementShrink

A Boolean specifying whether elements are displayed in a shrunk format. The default value is OFF.

elementShrinkFactor

An Int specifying the percentage to shrink the elements when elementShrink*=ON. Possible values are 0≤≤ *elementShrinkPercentage ≤≤ 90. The default value is 5.

coordinateScale

A Boolean specifying whether to scale coordinates. The default value is OFF.

coordinateScaleFactors

A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when *coordinateScale*=ON. The default value is (1, 1, 1).

normals

A Boolean specifying whether to draw arrows that indicate the directions of element and surface normals. The default value is OFF.

normalDisplay

A SymbolicConstant specifying whether to draw element normals or surface normals. Possible values are ELEMENT and SURFACE. The default value is ELEMENT.

faceNormalColor

A String specifying the color to be used to plot the normal to a nonbeam element or to a surface. The default value is “Red”.

beamN1Color

A String specifying the color to be used to plot an arrow along the beam n1n1-direction. The default value is “Blue”.

beamN2Color

A String specifying the color to be used to plot an arrow along the beam n2n2-direction. The default value is “Red”.

beamTangentColor

A String specifying the color to be used to plot an arrow along the tangent to a beam. The default value is “White”.

normalArrowLength

A SymbolicConstant specifying the length of the normal arrows. Possible values are SHORT, MEDIUM, and LONG. The default value is MEDIUM.

normalLineThickness

A SymbolicConstant specifying the thickness of the normal arrows. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

normalArrowheadStyle

A SymbolicConstant specifying the arrowhead style of the normal arrows. Possible values are NONE, FILLED, and WIRE. The default value is WIRE.

translucency

A Boolean specifying whether to set translucency. The default value is OFF.

translucencyFactor

A Float specifying the translucency factor when translucency*=ON. Possible values are 0.0≤≤ *translucencyFactor ≤≤ 1.0. The default value is 0.3.

Raises:

RangeError

ContourOptions#

class ContourOptions[source]#

The ContourOptions object stores values and attributes associated with a contour plot. The ContourOptions object has no constructor command. Abaqus creates a defaultOdbDisplay.contourOptions member when you import the Visualization module. Abaqus creates a contourOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.contourOptions. Abaqus creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. ContourOptions objects are accessed in one of two ways: - The default contour options. These settings are used as defaults when other contourOptions members are created. These settings can be set to customize user preferences. - The contour options associated with a particular viewport. The ContourOptions object is derived from the DGContourOptions object.

Notes

This object can be accessed by:

import visualization
session.defaultOdbDisplay.contourOptions
session.viewports[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.contourOptions
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.contourOptions
session.viewports[name].layers[name].odbDisplay.contourOptions
session.viewports[name].layers[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.contourOptions
session.viewports[name].layers[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.contourOptions
session.viewports[name].odbDisplay.contourOptions
session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.contourOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.contourOptions

Attributes:

contourType: SymbolicConstant: A SymbolicConstant specifying the contour type. Possible values are LINE, BANDED, QUILT, and ISOSURFACE. The default value is BANDED.
numIntervals: int: An Int specifying the number of intervals when contourStyle=UNIFORM. Possible values are 2 ≤≤ numIntervals ≤≤ 24. The default value is 12.
intervalType: SymbolicConstant: A SymbolicConstant specifying the interval type of the contour plot. Possible values are UNIFORM, LOG, and USER_DEFINED. The default value is UNIFORM.
maxAutoCompute: Boolean: A Boolean specifying whether the contour range maximum value should be computed from the output data to be contoured. The default value is ON.
maxValue: float: A Float specifying the contour range maximum value to be used in the plot when maxAutoCompute=ON. The default value is autoMaxValue.
minAutoCompute: Boolean: A Boolean specifying whether the contour range minimum value should be computed from the output data to be contoured. The default value is ON.
minValue: float: A Float specifying the contour range minimum value to be used in the plot when minAutoCompute=ON. The default value is autoMinValue.
animationAutoLimits: SymbolicConstant: A SymbolicConstant specifying the method to be used when contour limits are automatically computed for animation. animationAutoLimits will only effect the minimum limit and/or maximum limit when minAutoCompute and/or maxAutoCompute=True. Possible values are FIRST_AND_LAST, CURRENT_FRAME, RECOMPUTE_EACH_FRAME, and ALL_FRAMES. The default value is ALL_FRAMES.
outsideLimitsMode: SymbolicConstant: A SymbolicConstant specifying the color of contour values that exceed the limits of the plot. Possible values are SPECTRUM and SPECIFY.When outsideLimitsMode=SPECTRUM, the maximum and minimum contour spectrum colors are used for values that exceed the limits of the plot. When outsideLimitsMode=SPECIFY, the values of outsideLimitsAboveColor and outsideLimitsBelowColor are used for values that exceed the limits of the plot.
extrapolatedAveraging: Boolean: A Boolean specifying whether to auto-compute contour limits using extrapolated values alone or extrapolated values that are averaged. The default value is OFF.
showMaxLocation: Boolean: A Boolean specifying whether to display location of maximum value. The default value is OFF.
showMinLocation: Boolean: A Boolean specifying whether to display location of minimum value. The default value is OFF.
autoMaxValue: float: A Float specifying the maximum value to be used in the plot. The value is computed from the output data to be contoured. This value is read-only.
autoMinValue: float: A Float specifying the minimum value to be used in the plot. The value is computed from the output data to be contoured. This value is read-only.
outsideLimitsAboveColor: str: A String specifying the color to be used for values that exceed the limits of the plot when outsideLimitsMode=SPECIFY. The default value is “Grey80”.
outsideLimitsBelowColor: str: A String specifying the color to be used for values that exceed the limits of the plot when outsideLimitsMode=SPECIFY. The default value is “Grey20”.
spectrum: str: A String specifying the name of the color spectrum to be used in the contour plot. The default value is “Rainbow”.
reversedContourLegendRange: Boolean: A Boolean specifying whether the contour legend should show the lowest value at the top and the highest value at the bottom (reversedContourLegendRange=ON) or vice versa. The default value is OFF.
intervalValues: float: A tuple of Floats specifying the interval values when intervalType=USER_DEFINED.
contourMethod: SymbolicConstant: A SymbolicConstant specifying the contour rendering method. Possible values are TEXTURE_MAPPED and TESSELLATED. The default value is TEXTURE_MAPPED.
tickmarkPlots: Boolean: A Boolean specifying whether tick mark plots should be displayed on line-type elements. If tickmarkPlots=ON, Abaqus displays a tick mark plot. If tickmarkPlots=OFF, Abaqus displays contours on the element faces. The default value is OFF.
contourStyle: SymbolicConstant: A SymbolicConstant specifying the interval style of the contour plot. Possible values are CONTINUOUS and UNIFORM. The default value is UNIFORM.
contourEdges: Boolean: A Boolean specifying whether to plot the edges of each contour interval when contourType=BANDED or ISOSURFACE. The default value is OFF.
contourEdgeStyle: SymbolicConstant: A SymbolicConstant specifying the edge line style to be used to plot the contour edges when contourType=BANDED or ISOSURFACE. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
contourEdgeThickness: SymbolicConstant: A SymbolicConstant specifying the edge line thickness to be used to plot the edge of the contour intervals when contourType=BANDED or ISOSURFACE. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
averagedOrientationDisplay: Boolean: A Boolean specifying the display of the nodal averaged coordinate systems used when averaging element vector or tensor data. The default value is OFF.
matchingPlyLabels: Boolean: A Boolean specifying whether the label for the matching ply shows up in the viewport. The default value is OFF.
colorByMatchingPlies: Boolean: A Boolean specifying whether the contour color is driven by the matching ply. The default value is OFF.
tickmarkAxisLength: SymbolicConstant: A SymbolicConstant specifying the length of the tick mark plot axes. Possible values are SHORT, MEDIUM, and LONG. The default value is MEDIUM.
tickmarkBaseValue: float: A Float specifying the base contour value defining the tick mark axis contour value that intersects the elements. Possible values are autoMinValue ≤≤ tickmarkBaseValue ≤≤ autoMaxValue. The default value is 0.0.
tickmarkOrientation: SymbolicConstant: A SymbolicConstant specifying the orientation of the tick mark plots. Possible values are N1 and N2. The default value is N2.
edgeColorLine: str: A String specifying the edge color to be used when contourType=LINE. The default value is “White”.
edgeColorBandedQuilt: str: A String specifying the edge color to be used when contourType=BANDED or QUILT. The default value is “Black”.
contourEdgeColor: str: A String specifying the color to be used to plot the contour edges when contourType=BANDED or ISOSURFACE. The default value is “Grey60”.
tickmarkCurveColor: str: A String specifying the color to be used to plot the tick mark curve. The default value is “Cyan”.
intervalLineAttributes: SymbolicConstant: A tuple of tuples of SymbolicConstants specifying the line style and line thickness for each interval in the plot when contourType=LINE. The size of the outer sequence must be equal to numIntervals-1. The inner sequence consists of two SymbolicConstants specifying the line style and line thickness. For possible values, refer to the edgeLineStyle and edgeLineThickness members of the DGCommonOptions object. The default is ((SOLID, VERY_THIN), ).
legendHideOutsideLimits: Boolean: A Boolean specifying whether to hide the values outside the specified min/max in the contour legend. This setting hides the autoMinValue and autoMaxValue from the spectrum when legendHideOutsideLimits=ON.The default value is OFF.

Methods

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

This method modifies the ContourOptions object.

setValues(options: ContourOptions | None = None, contourType: SymbolicConstantType = 'BANDED', contourMethod: SymbolicConstantType = 'TEXTURE_MAPPED', tickmarkPlots: BooleanType = 0, contourStyle: SymbolicConstantType = 'UNIFORM', numIntervals: int = 12, intervalType: SymbolicConstantType = 'UNIFORM', intervalValues: tuple = (), maxAutoCompute: BooleanType = 1, maxValue: float | None = None, minAutoCompute: BooleanType = 1, minValue: float | None = None, animationAutoLimits: SymbolicConstantType = 'ALL_FRAMES', edgeColorLine: str = '', edgeColorBandedQuilt: str = '', spectrum: str = '', reversedContourLegendRange: BooleanType = 0, outsideLimitsMode: SymbolicConstantType | None = None, outsideLimitsAboveColor: str = '', outsideLimitsBelowColor: str = '', intervalLineAttributes: SymbolicConstantType | None = None, contourEdges: BooleanType = 0, contourEdgeColor: str = '', contourEdgeStyle: SymbolicConstantType = 'SOLID', contourEdgeThickness: SymbolicConstantType = 'VERY_THIN', tickmarkAxisLength: SymbolicConstantType = 'MEDIUM', tickmarkBaseValue: float = 0, tickmarkOrientation: SymbolicConstantType = 'N2', tickmarkCurveColor: str = '', averagedOrientationDisplay: BooleanType = 0, extrapolatedAveraging: BooleanType = 0, showMaxLocation: BooleanType = 0, showMinLocation: BooleanType = 0, legendHideOutsideLimits: BooleanType = 0)[source]#

This method modifies the ContourOptions object.

Parameters:

options: A ContourOptions 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.
contourType: A SymbolicConstant specifying the contour type. Possible values are LINE, BANDED, QUILT, and ISOSURFACE. The default value is BANDED.
contourMethod: A SymbolicConstant specifying the contour rendering method. Possible values are TEXTURE_MAPPED and TESSELLATED. The default value is TEXTURE_MAPPED.
tickmarkPlots: A Boolean specifying whether tick mark plots should be displayed on line-type elements. If *tickmarkPlots*=ON, Abaqus displays a tick mark plot. If *tickmarkPlots*=OFF, Abaqus displays contours on the element faces. The default value is OFF.
contourStyle: A SymbolicConstant specifying the interval style of the contour plot. Possible values are CONTINUOUS and UNIFORM. The default value is UNIFORM.
numIntervals: An Int specifying the number of intervals when contourStyle*=UNIFORM. Possible values are 2 ≤≤ *numIntervals ≤≤ 24. The default value is 12.
intervalType: A SymbolicConstant specifying the interval type of the contour plot. Possible values are UNIFORM, LOG, and USER_DEFINED. The default value is UNIFORM.
intervalValues: A sequence of Floats specifying the interval values when *intervalType*=USER_DEFINED.
maxAutoCompute: A Boolean specifying whether the contour range maximum value should be computed from the output data to be contoured. The default value is ON.
maxValue: A Float specifying the contour range maximum value to be used in the plot when maxAutoCompute*=ON. The default value is *autoMaxValue.
minAutoCompute: A Boolean specifying whether the contour range minimum value should be computed from the output data to be contoured. The default value is ON.
minValue: A Float specifying the contour range minimum value to be used in the plot when minAutoCompute*=ON. The default value is *autoMinValue.
animationAutoLimits: A SymbolicConstant specifying the method to be used when contour limits are automatically computed for animation. animationAutoLimits will only effect the minimum limit and/or maximum limit when minAutoCompute and/or *maxAutoCompute*=True. Possible values are FIRST_AND_LAST, CURRENT_FRAME, RECOMPUTE_EACH_FRAME, and ALL_FRAMES. The default value is ALL_FRAMES.
edgeColorLine: A String specifying the edge color to be used when *contourType*=LINE. The default value is “White”.
edgeColorBandedQuilt: A String specifying the edge color to be used when *contourType*=BANDED or QUILT. The default value is “Black”.
spectrum: A String specifying the name of the color spectrum to be used in the contour plot. The default value is “Rainbow”.
reversedContourLegendRange: A Boolean specifying whether the contour legend should show the lowest value at the top and the highest value at the bottom (*reversedContourLegendRange*=ON) or vice versa. The default value is OFF.
outsideLimitsMode: A SymbolicConstant specifying the color of contour values that exceed the limits of the plot. Possible values are SPECTRUM and SPECIFY.When outsideLimitsMode*=SPECTRUM, the maximum and minimum contour spectrum colors are used for values that exceed the limits of the plot. When *outsideLimitsMode*=SPECIFY, the values of *outsideLimitsAboveColor and outsideLimitsBelowColor are used for values that exceed the limits of the plot.
outsideLimitsAboveColor: A String specifying the color to be used for values that exceed the limits of the plot when *outsideLimitsMode*=SPECIFY. The default value is “Grey80”.
outsideLimitsBelowColor: A String specifying the color to be used for values that exceed the limits of the plot when *outsideLimitsMode*=SPECIFY. The default value is “Grey20”.
intervalLineAttributes: A sequence of sequences of SymbolicConstants specifying the line style and line thickness for each interval in the plot when contourType*=LINE. The size of the outer sequence must be equal to *numIntervals-1. The inner sequence consists of two SymbolicConstants specifying the line style and line thickness. For possible values, refer to the edgeLineStyle and edgeLineThickness members of the DGCommonOptions object. The default is ((SOLID, VERY_THIN), ).
contourEdges: A Boolean specifying whether to plot the edges of each contour interval when *contourType*=BANDED or ISOSURFACE. The default value is OFF.
contourEdgeColor: A String specifying the color to be used to plot the contour edges when *contourType*=BANDED or ISOSURFACE. The default value is “Grey60”.
contourEdgeStyle: A SymbolicConstant specifying the edge line style to be used to plot the contour edges when *contourType*=BANDED or ISOSURFACE. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
contourEdgeThickness: A SymbolicConstant specifying the edge line thickness to be used to plot the edge of the contour intervals when *contourType*=BANDED or ISOSURFACE. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
tickmarkAxisLength: A SymbolicConstant specifying the length of the tick mark plot axes. Possible values are SHORT, MEDIUM, and LONG. The default value is MEDIUM.
tickmarkBaseValue: A Float specifying the base contour value defining the tick mark axis contour value that intersects the elements. Possible values are autoMinValue ≤≤ tickmarkBaseValue ≤≤ autoMaxValue. The default value is 0.0.
tickmarkOrientation: A SymbolicConstant specifying the orientation of the tick mark plots. Possible values are N1 and N2. The default value is N2.
tickmarkCurveColor: A String specifying the color to be used to plot the tick mark curve. The default value is “Cyan”.
averagedOrientationDisplay: A Boolean specifying the display of the nodal averaged coordinate systems used when averaging element vector or tensor data. The default value is OFF.
extrapolatedAveraging: A Boolean specifying whether to auto-compute contour limits using extrapolated values alone or extrapolated values that are averaged. The default value is OFF.
showMaxLocation: A Boolean specifying whether to display location of maximum value. The default value is OFF.
showMinLocation: A Boolean specifying whether to display location of minimum value. The default value is OFF.
legendHideOutsideLimits: A Boolean specifying whether to hide the values outside the specified minimum/maximum for the contour interval when *legendHideOutsideLimits*=ON. The default value is OFF.

Raises:

RangeError

DefaultOdbDisplay#

class DefaultOdbDisplay[source]#

The DefaultOdbDisplay object is a limited-functionality version of the OdbDisplay object.

Notes

This object can be accessed by:

import visualization
session.defaultOdbDisplay

Attributes:

basicOptions: BasicOptions: A BasicOptions object.
commonOptions: CommonOptions: A CommonOptions object.
contourOptions: ContourOptions: A ContourOptions object.
displayBodyOptions: DisplayBodyOptions: A DisplayBodyOptions object.
freeBodyOptions: FreeBodyOptions: A FreeBodyOptions object.
streamOptions: StreamOptions: A StreamOptions object.
materialOrientationOptions: OrientationOptions: An OrientationOptions object.
superimposeOptions: SuperimposeOptions: A SuperimposeOptions object.
symbolOptions: SymbolOptions: A SymbolOptions object.
viewCutOptions: ViewCutOptions: A ViewCutOptions object.

DisplayBodyOptions#

class DisplayBodyOptions[source]#

The DisplayBodyOptions object stores values and attributes that are common to all plot states. The DisplayBodyOptions object has no constructor command. Abaqus creates a defaultOdbDisplay.displayBodyOptions member when you import the Visualization module. Abaqus creates a displayBodyOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.displayBodyOptions. Abaqus creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. DisplayBodyOptions objects are accessed in one of two ways: - The default display body options. These settings are used as defaults when other displayBodyOptions members are created. These settings can be set to customize user preferences. - The display body options associated with a particular viewport. The DisplayBodyOptions object is derived from the DGDisplayBodyOptions object.

Notes

This object can be accessed by:

import visualization
session.defaultOdbDisplay.displayBodyOptions
session.viewports[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.displayBodyOptions
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.displayBodyOptions
session.viewports[name].layers[name].odbDisplay.displayBodyOptions
session.viewports[name].layers[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.displayBodyOptions
session.viewports[name].layers[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.displayBodyOptions
session.viewports[name].odbDisplay.displayBodyOptions
session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.displayBodyOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.displayBodyOptions

Attributes:

visibleEdges: SymbolicConstant: A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. The default value is EXTERIOR.NONE can be used only when renderStyle=SHADED.
edgeLineStyle: SymbolicConstant: A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
edgeLineThickness: SymbolicConstant: A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
colorCodeOverride: Boolean: A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The default value is ON.
elementShrink: Boolean: A Boolean specifying whether elements are displayed in a shrunk format. The default value is OFF.
elementShrinkFactor: int: An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0≤ elementShrinkPercentage ≤ 90. The default value is 5.
coordinateScale: Boolean: A Boolean specifying whether to scale coordinates. The default value is OFF.
translucency: Boolean: A Boolean specifying whether to set translucency. The default value is OFF.
translucencyFactor: float: A Float specifying the translucency factor when translucency=ON. Possible values are 0.0≤ translucencyFactor ≤ 1.0. The default value is 0.3.
edgeColorWireHide: str: A String specifying the color to be used to plot the edges of the model when renderStyle=WIREFRAME or HIDDEN. The default value is “White”.
edgeColorFillShade: str: A String specifying the color to be used to plot the edges of the model when renderStyle=FILLED or SHADED. The default value is “Black”.
fillColor: str: A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The default value is “White”.
coordinateScaleFactors: float: A tuple of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The default value is (1, 1, 1).

Methods

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

This method modifies the DisplayBodyOptions object.

setValues(options: DisplayBodyOptions | None = None, visibleEdges: SymbolicConstantType = 'EXTERIOR', edgeColorWireHide: str = '', edgeColorFillShade: str = '', edgeLineStyle: SymbolicConstantType = 'SOLID', edgeLineThickness: SymbolicConstantType = 'VERY_THIN', fillColor: str = '', colorCodeOverride: BooleanType = 1, elementShrink: BooleanType = 0, elementShrinkFactor: int = 5, coordinateScale: BooleanType = 0, coordinateScaleFactors: tuple = (), translucency: BooleanType = 0, translucencyFactor: float = 0)[source]#

This method modifies the DisplayBodyOptions object.

Parameters:

options: A DisplayBodyOptions 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.
visibleEdges: A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. The default value is EXTERIOR.NONE can be used only when *renderStyle*=SHADED.
edgeColorWireHide: A String specifying the color to be used to plot the edges of the model when *renderStyle*=WIREFRAME or HIDDEN. The default value is “White”.
edgeColorFillShade: A String specifying the color to be used to plot the edges of the model when *renderStyle*=FILLED or SHADED. The default value is “Black”.
edgeLineStyle: A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
edgeLineThickness: A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
fillColor: A String specifying the color to be used to fill elements when *renderStyle*=FILLED or SHADED. The default value is “White”.
colorCodeOverride: A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The default value is ON.
elementShrink: A Boolean specifying whether elements are displayed in a shrunk format. The default value is OFF.
elementShrinkFactor: An Int specifying the percentage to shrink the elements when elementShrink*=ON. Possible values are 0≤elementShrinkPercentage ≤ 90. The default value is 5.
coordinateScale: A Boolean specifying whether to scale coordinates. The default value is OFF.
coordinateScaleFactors: A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when *coordinateScale*=ON. The default value is (1, 1, 1).
translucency: A Boolean specifying whether to set translucency. The default value is OFF.
translucencyFactor: A Float specifying the translucency factor when translucency*=ON. Possible values are 0.0≤ *translucencyFactor ≤ 1.0. The default value is 0.3.

Raises:

RangeError

OdbDisplay#

class OdbDisplay[source]#

The OdbDisplay object stores the context of an output database for a viewport. The OdbDisplay object has no constructor. Abaqus creates the defaultOdbDisplay member when you import the Visualization module. Abaqus creates the odbDisplay member when a viewport is created, using the attributes from the previous active viewport. The previous active viewport contains the attributes from the defaultOdbDisplay object for the session. The attributes from the defaultOdbDisplay object are copied from the previous active viewport to create the new viewport. OdbDisplay objects are accessed in one of two ways: - The default output database display options. These settings are used as defaults when other odbDisplay members are created and can be set to customize user preferences. - The output database display options associated with a particular viewport.

Notes

This object can be accessed by:

session.viewports[name].layers[name].odbDisplay
import visualization
session.viewports[name].odbDisplay

Attributes:

name: str

A String specifying the name of the output database associated with the OdbDisplay object.

fieldSteps: tuple

A tuple of Strings specifying field steps. Each item in the sequence consists of a tuple that contains the following step information:

element0: A String specifying the step name.

element1: A String specifying the step description.

element2: A Float specifying the time value at the start of the step.

element3: A Float specifying the time period of the step.

element4: A Float specifying the user modified time period of the step.

element5: An Int specifying the domain type of the step. Possible values are:

0: Time domain

1: Frequency domain

2: Modal domain

3: Arc Length (Riks) domain

element6: A String specifying the default frame label.

element7: A sequence of strings specifying the frame labels for all available frames

in the step.

element8: A sequence of floats specifying the frame values for all available frames

in the step.

element9: A Int specifying whether the step is user defined. Possible values are 0

indicating the step is defined in the analysis and 1 indicating the step is user defined.

element10: A sequence of machine readable strings encoding the currently active

frame numbers.

fieldVariables: OdbFieldVarList

An OdbFieldVarList object.

modelVariableList: OdbModelFieldVarList

An OdbModelFieldVarList object.

nodeSet: dict[str, OdbSet]

A repository of OdbSet objects specifying the set label. The repository is read-only.

elementSet: dict[str, OdbSet]

A repository of OdbSet objects specifying the set label. The repository is read-only.

surfaceSet: dict[str, OdbSet]

A repository of OdbSet objects specifying the set label. The repository is read-only.

display: DisplayOptions

A DisplayOptions object.

contourOptions: ContourOptions

A ContourOptions object.

commonOptions: CommonOptions

A CommonOptions object.

symbolOptions: SymbolOptions

A SymbolOptions object.

superimposeOptions: SuperimposeOptions

A SuperimposeOptions object.

displayBodyOptions: DisplayBodyOptions

A DisplayBodyOptions object.

freeBodyOptions: FreeBodyOptions

A FreeBodyOptions object.

streamOptions: StreamOptions

A StreamOptions object.

viewCutOptions: ViewCutOptions

A ViewCutOptions object.

viewCuts: dict[str, ViewCut]

A repository of ViewCut objects.

displayGroup: DisplayGroup

A DisplayGroup object specifying the current display group an object in the displayGroups member of Session.

displayGroupInstances: DisplayGroupInstanceRepository

A DisplayGroupInstanceRepository object.

basicOptions: BasicOptions

A BasicOptions object.

materialOrientationOptions: OrientationOptions

An OrientationOptions object.

fieldFrame: tuple[str]

A tuple of Strings specifying the step label and the frame label when the current step is user defined. Alternatively, fieldFrame maybe specified as a pair of Ints with the step index and the frame index, when the current step is defined in the analysis.

primaryVariable: tuple

A tuple specifying variables. Each item in the sequence consists of a tuple containing the following elements:

Element 0: A String specifying the variable label.

Element 1: An Int specifying the output position. Possible integer values are:

0: UNDEFINED_POSITION

1: NODAL

2: INTEGRATION_POINT

3: ELEMENT_FACE

4: ELEMENT_NODAL

5: WHOLE_ELEMENT

6: ELEMENT_CENTROID

7: WHOLE_REGION

8: WHOLE_PART_INSTANCE

9: WHOLE_MODEL

10: GENERAL_PARTICLE

Element 2: An Int specifying the data type. Possible values are:

0: ENUMERATION

1: BOOLEAN

2: INTEGER

3: SCALAR

4: VECTOR

5: QUATERNION_2D

6: QUATERNION_3D

7: TENSOR

8: TENSOR_3D_FULL

9: TENSOR_3D_PLANAR

10: TENSOR_3D_SURFACE

11: TENSOR_2D_PLANAR

12: TENSOR_2D_SURFACE

Element 3: An Int specifying the storage type. Possible values are:

0: FLOAT

1: DOUBLE

2: INTEGER

3: BOOLEAN

Element 4: An Int specifying the refinement type. Possible values are:

0: NO_REFINEMENT

1: INVARIANT

2: COMPONENT

Element 5: A String specifying the refinement label.

Element 6: An Int specifying the refinement index.

Element 7: An Int specifying whether section point information is available. Possible

values are 1 when section point information is available; 0, when this information is unavailable.

Element 8: A sequence of a String specifying the name of the ply and category

selection tuples (see below) specifying the section point information. A category selection tuple consists of the following elements:

Element 0: A String specifying the category label.

Element 1: An Int specifying whether to use both top and bottom section points to

obtain results. Possible values are 1 to use both section points and 0 to use only the top section point.

Element 2: An Int specifying the top section point index.

Element 3: A String specifying the top section label.

Element 4: An Int specifying the bottom section point index.

Element 5: A String specifying the bottom section label.

Element 6: An Int specifying the category id.

Element 9: An Int specifying whether the data are complex. Possible values are 1 when

the data are complex; 0, when the data is not complex.

Element 10: A Float specifying the minimum possible value for the data.
Element 11: A Float specifying the maximum possible value for the data.
Element 12: An Int specifying whether the data is derived. Possible values are 1 when

the data is derived; 0, when the data is not derived.

deformedVariable: tuple

A tuple specifying variables.For information on the sequence, see the member primaryVariable.

statusVariable: SymbolicConstant

A tuple of SymbolicConstants specifying variables.For information on the sequence, see the member primaryVariable.

symbolVariable: SymbolicConstant

A tuple of SymbolicConstants specifying variables.For information on the sequence, see the member primaryVariable.

applyStatusToUndeformed: SymbolicConstant

A tuple of SymbolicConstants specifying a Boolean to specify if elements are to be removed in undeformed states based on an active status variable

statusInsideRange: SymbolicConstant

A tuple of SymbolicConstants specifying a Boolean to specify if the status range should be inside a specified minimum and maximum. The range will be outside when false.

statusMinimum: float

A tuple of Floats specifying a Float value for the minimum status range value.

statusMaximum: float

A tuple of Floats specifying a Float value for the maximum status range value.

useStatus: SymbolicConstant

A tuple of SymbolicConstants specifying a Boolean to specify if elements are to be removed based on the status variable

firstFrame: str

A pair of Ints specifying the step index and the frame index of the first available frame. This sequence is read-only.

prevFrame: str

A pair of Ints specifying the step index and the frame index of the frame previous to the current frame. This sequence is read-only.

nextFrame: str

A pair of Ints specifying the step index and the frame index of the frame following the current frame. This sequence is read-only.

lastFrame: str

A pair of Ints specifying the step index and the frame index of the last available frame. This sequence is read-only.

Methods

`ViewCut`(name, shape, origin, normal, axis2, ...)	This method creates a ViewCut object.
`moveCameraToCsys`()	This method specifies a new position for the camera.
`setDeformedVariable`(variableLabel, field)	This method specifies the field output variable or FieldOutput object to be used when displaying the deformed shape of the model.
`setPrimarySectionPoint`(sectionPoint, activePly)	This method specifies the section point for the current primary, symbol and status variables.
`setPrimaryVariable`(variableLabel, field, ...)	This method specifies the field output variable for which to obtain results.
`setStatusVariable`(variableLabel, field, ...)	This method specifies the field output variable for filtering element display based on a status criteria.
`setStreamVariable`(variableLabel)	This method specifies the field output variable for which to obtain results used for stream plots.
`setSymbolVariable`(variableLabel, field, ...)	This method specifies the field output variable for which to obtain results used for symbol plots.
`setValues`([visibleDisplayGroups, viewCut, ...])	This method specifies member values for the OdbDisplay object.

setFrame

ViewCut(name: str, shape: SymbolicConstantType, origin: tuple, normal: SymbolicConstantType | float, axis2: SymbolicConstantType | float, csysName: str, cylinderAxis: SymbolicConstantType | float, followDeformation: BooleanType = 0, overrideAveraging: BooleanType = 1, referenceFrame: SymbolicConstantType = 'FIRST_FRAME') → ViewCut[source]#

This method creates a ViewCut object.

Parameters:

name: A String specifying the repository key.
shape: A SymbolicConstant specifying the shape of the ViewCut object. Possible values are PLANE, CYLINDER, SPHERE, and ISOSURFACE.
origin: A sequence of three Floats specifying the X-, Y-, and Z-coordinates of the origin of the plane, cylinder or sphere cut. This origin is not required if the cut shape is ISOSURFACE or if the cut is defined by the csysName argument.
normal: A sequence of Floats specifying the X-, Y-, and Z-coordinates of the normal axis to the plane defining the cut, when the plane is defined using the origin argument or a SymbolicConstant defining this normal axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. This axis is not required if the cut shape is CYLINDER, SPHERE or ISOSURFACE.
axis2: A sequence of three Floats specifying the X-, Y-, and Z-coordinates of the second axis of the plane defining the cut, when the plane is defined using the origin argument or a SymbolicConstant defining this second axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. This axis is used to rotate the plane cut. It is not required if the cut shape is CYLINDER, SPHERE or ISOSURFACE.
csysName: A String specifying the name of the DatumCsys object to be used to define the cut. This name is not required if the cut shape is ISOSURFACE or if the cut is defined by the origin argument.
cylinderAxis: A sequence of Floats specifying the X-, Y-, and Z-coordinates of the cylinder axis defining the cut, when the cut is defined using the origin argument or a SymbolicConstant defining this cylinder axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. This axis is not required if the cut shape is PLANE, SPHERE, or ISOSURFACE.
followDeformation: A Boolean specifying whether the cut will follow the deformation or be static. The default value is OFF.
overrideAveraging: A Boolean specifying averaging for element based fields associated with isosurface cuts will be set to compute-average with a threshold of 100% when true. The current field options will be used when false. The default value is ON.
referenceFrame: A SymbolicConstant specifying which reference frame will be used when the cut follows the deformation. Possible values are FIRST_FRAME, LAST_FRAME, and CURRENT_FRAME. The default value is FIRST_FRAME.

Returns:

A ViewCut object.

Notes

This function can be accessed by:

session.viewports[name].layers[name].odbDisplay.ViewCut
session.viewports[name].odbDisplay.ViewCut

moveCameraToCsys()[source]#: This method specifies a new position for the camera. It is available only when movieMode*=ON (in the View object). The new camera position is the origin of the coordinate system specified by the *cameraCsysName member of the BasicOptions object.

setDeformedVariable(variableLabel: str, field: str)[source]#

This method specifies the field output variable or FieldOutput object to be used when displaying the deformed shape of the model.

Parameters:

variableLabel: A String specifying the field output variable.
field: A String specifying the FieldOutput object.

Raises:

If the viewport is not associated with any Odb object:
The current viewport is not associated with an ODB file. Requested operation

cancelled.

setPrimarySectionPoint(sectionPoint: dict, activePly: str)[source]#

This method specifies the section point for the current primary, symbol and status variables.

Parameters:

sectionPoint: A Dictionary with String keys and String values. Each key specifies a region in the model; the corresponding value specifies a section point within that region. For example:sectionPoint={‘shell < MAT > < 7 section points >’:’SPOS, (fraction = 1.0)’, ‘shell < MAT > < 5 section points >’: ‘SPOS, (fraction = 1.0)’, }
activePly: A String specifying the active ply name.

Raises:

If the viewport is not associated with any Odb object:
The current viewport is not associated with an ODB file. Requested operation

cancelled.

setPrimaryVariable(variableLabel: str, field: str, outputPosition: SymbolicConstantType, refinement: SymbolicConstantType | None = None, sectionPoint: dict | None = None)[source]#

This method specifies the field output variable for which to obtain results.

Parameters:

variableLabel: A String specifying the field output variable. The variableLabel and field arguments are mutually exclusive.
field: A String specifying the FieldOutput object. The variableLabel and field arguments are mutually exclusive.
outputPosition: A SymbolicConstant specifying the position from which to obtain data. Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, ELEMENT_CENTROID, WHOLE_ELEMENT, WHOLE_REGION, WHOLE_PART_INSTANCE, WHOLE_MODEL, and GENERAL_PARTICLE. Data can be obtained only from the position at which they were written to the output database during the analysis.
refinement: A sequence of a SymbolicConstant and a String. Possible values for the SymbolicConstant are INVARIANT and COMPONENT. The String specifies an available component or invariant for the specified variableLabel. This argument is required only if a refinement is available for the specified variableLabel.
sectionPoint: A Dictionary with String keys and String values. Each key specifies a region in the model; the corresponding value specifies a section point within that region. For example:sectionPoint={‘shell < MAT > < 7 section points >’:’SPOS, (fraction = 1.0)’, ‘shell < MAT > < 5 section points >’: ‘SPOS, (fraction = 1.0)’, }

Raises:

If the viewport is not associated with any Odb object:
The current viewport is not associated with an ODB file. Requested operation

cancelled.

setStatusVariable(variableLabel: str, field: str, outputPosition: SymbolicConstantType, refinement: SymbolicConstantType | None = None, sectionPoint: dict | None = None, statusMinimum: float | None = None, statusMaximum: float | None = None, statusInsideRange: BooleanType = 0, useStatus: BooleanType = 0, applyStatusToUndeformed: BooleanType = False)[source]#

This method specifies the field output variable for filtering element display based on a status criteria.

Parameters:

variableLabel: A String specifying the field output variable. The variableLabel and field arguments are mutually exclusive.
field: A String specifying the FieldOutput object. The variableLabel and field arguments are mutually exclusive.
outputPosition: A SymbolicConstant specifying the position from which to obtain data. Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, ELEMENT_CENTROID, WHOLE_ELEMENT, WHOLE_REGION, WHOLE_PART_INSTANCE, WHOLE_MODEL, and GENERAL_PARTICLE. Data can be obtained only from the position at which they were written to the output database during the analysis.
refinement: A sequence of a SymbolicConstant and a String. Possible values for the SymbolicConstant are INVARIANT and COMPONENT. The String specifies an available component or invariant for the specified variableLabel. This argument is required only if a refinement is available for the specified variableLabel.
sectionPoint: A Dictionary with String keys and String values. Each key specifies a region in the model; the corresponding value specifies a section point within that region. For example:sectionPoint={‘shell < MAT > < 7 section points >’:’SPOS, (fraction = 1.0)’, ‘shell < MAT > < 5 section points >’: ‘SPOS, (fraction = 1.0)’, }
statusMinimum: A Float specifying the minimum result value to be considered for element removal.
statusMaximum: A Float specifying the maximum result value to be considered for element removal.
statusInsideRange: A Boolean utilized when both statusMinimum and statusMaximum are given. Elements will be removed when they contain values between the minimum and maximum, inclusive, when true. Elements will be removed when they contain values outside of the minimum and maximum, exclusive, when false.
useStatus: A Boolean to specify if the status variable is to be active.
applyStatusToUndeformed: A Boolean to specify if the active status variable is to remove elements from undeformed plots. The default value is False.

Raises:

If the viewport is not associated with any Odb object:
The current viewport is not associated with an ODB file. Requested operation

cancelled.

setStreamVariable(variableLabel: str)[source]#

This method specifies the field output variable for which to obtain results used for stream plots. This variable must be in the form of nodal vector data.

Parameters:

variableLabel: A String specifying the field output variable.

Raises:

If the viewport is not associated with any Odb object:
The current viewport is not associated with an ODB file. Requested operation

cancelled.

setSymbolVariable(variableLabel: str, field: str, outputPosition: SymbolicConstantType, refinement: SymbolicConstantType | None = None, sectionPoint: dict | None = None, tensorQuantity: SymbolicConstantType | None = None, vectorQuantity: SymbolicConstantType | None = None)[source]#

This method specifies the field output variable for which to obtain results used for symbol plots. This variable must be in the form of vector or tensor data. The output quantity can also be specified with this command to control the display of resultants, or components.

Parameters:

variableLabel: A String specifying the field output variable. The variableLabel and field arguments are mutually exclusive.
field: A String specifying the FieldOutput object. The variableLabel and field arguments are mutually exclusive.
outputPosition: A SymbolicConstant specifying the position from which to obtain data. Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, ELEMENT_CENTROID, WHOLE_ELEMENT, WHOLE_REGION, WHOLE_PART_INSTANCE, WHOLE_MODEL, and GENERAL_PARTICLE. Data can be obtained only from the position at which they were written to the output database during the analysis.
refinement: A sequence of a SymbolicConstant and a String. Possible values for the SymbolicConstant are INVARIANT and COMPONENT. The String specifies an available component or invariant for the specified variableLabel. This argument is required only if a refinement is available for the specified variableLabel.
sectionPoint: A Dictionary with String keys and String values. Each key specifies a region in the model; the corresponding value specifies a section point within that region. For example:sectionPoint={‘shell < MAT > < 7 section points >’:’SPOS, (fraction = 1.0)’, ‘shell < MAT > < 5 section points >’: ‘SPOS, (fraction = 1.0)’, }
tensorQuantity: A SymbolicConstant specifying the tensor quantity to be displayed with the symbol. This value is set in the SymbolOptions object.
vectorQuantity: A SymbolicConstant specifying the vector quantity to be displayed with the symbol. This value is set in the SymbolOptions object.

Raises:

If the viewport is not associated with any Odb object:
The current viewport is not associated with an ODB file. Requested operation

cancelled.

setValues(visibleDisplayGroups: str = '', viewCut: BooleanType = 0, viewCutNames: str = '')[source]#

This method specifies member values for the OdbDisplay object.

Parameters:

visibleDisplayGroups: A List of DisplayGroup objects.
viewCut: A Boolean specifying whether to display the cut. The default value is OFF.
viewCutNames: A List of ViewCut objects.

OrientationOptions#

class OrientationOptions[source]#

The OrientationOptions object stores values and attributes associated with a material orientation plot. The OrientationOptions object has no constructor command. Abaqus creates a defaultOdbDisplay.materialOrientationOptions member when you import the Visualization module. Abaqus creates a materialOrientationOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.materialOrientationOptions. Abaqus creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. OrientationOptions objects are accessed in one of two ways: - The default material orientation options. These settings are used as defaults when other materialOrientationOptions members are created. These settings can be set to customize user preferences. - The material orientation options associated with a particular viewport. The OrientationOptions object is derived from the DGOrientationOptions object.

Notes

This object can be accessed by:

import visualization
session.defaultOdbDisplay.materialOrientationOptions
session.viewports[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.materialOrientationOptions
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.materialOrientationOptions
session.viewports[name].layers[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.materialOrientationOptions
session.viewports[name].layers[name].odbDisplay.materialOrientationOptions
session.viewports[name].layers[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.materialOrientationOptions
session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.materialOrientationOptions
session.viewports[name].odbDisplay.materialOrientationOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.materialOrientationOptions

Attributes:

showAxis1: Boolean: A Boolean specifying whether axis 1 of the material orientation triad should be displayed. The default value is ON.
showAxis2: Boolean: A Boolean specifying whether axis 2 of the material orientation triad should be displayed. The default value is ON.
showAxis3: Boolean: A Boolean specifying whether axis 3 of the material orientation triad should be displayed. The default value is ON.
symbolSize: float: A Float specifying the size of the material orientation triad. The default value is 12.0.
lineThickness: SymbolicConstant: A SymbolicConstant specifying the thickness of the material orientation triad. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
orientation: SymbolicConstant: A SymbolicConstant specifying the orientation used for composites. Possible values are PLY and LAYUP. The default value is PLY.
arrowheadStyle: SymbolicConstant: A SymbolicConstant specifying the arrowhead style for the material orientation triad. Possible values are NONE, FILLED, and WIRE. The default value is NONE.
scaleMode: SymbolicConstant: A SymbolicConstant specifying the scaling basis for the material orientation triad. Possible values are MODEL_SIZE and SCREEN_SIZE. The default value is MODEL_SIZE.
axis1Color: str: A String specifying the color of axis 1 of the material orientation triad. The default value is “Cyan”.
axis2Color: str: A String specifying the color of axis 2 of the material orientation triad. The default value is “Yellow”.
axis3Color: str: A String specifying the color of axis 3 of the material orientation triad. The default value is “Red”.

Methods

setValues([options, axis1Color, showAxis1, ...])

This method modifies the OrientationOptions object.

setValues(options: OrientationOptions | None = None, axis1Color: str = '', showAxis1: BooleanType = 1, axis2Color: str = '', showAxis2: BooleanType = 1, axis3Color: str = '', showAxis3: BooleanType = 1, symbolSize: float = 12, lineThickness: SymbolicConstantType = 'VERY_THIN', orientation: SymbolicConstantType = 'PLY', arrowheadStyle: SymbolicConstantType = 'NONE', scaleMode: SymbolicConstantType = 'MODEL_SIZE')[source]#

This method modifies the OrientationOptions object.

Parameters:

options: An OrientationOptions 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.
axis1Color: A String specifying the color of axis 1 of the material orientation triad. The default value is “Cyan”.
showAxis1: A Boolean specifying whether axis 1 of the material orientation triad should be displayed. The default value is ON.
axis2Color: A String specifying the color of axis 2 of the material orientation triad. The default value is “Yellow”.
showAxis2: A Boolean specifying whether axis 2 of the material orientation triad should be displayed. The default value is ON.
axis3Color: A String specifying the color of axis 3 of the material orientation triad. The default value is “Red”.
showAxis3: A Boolean specifying whether axis 3 of the material orientation triad should be displayed. The default value is ON.
symbolSize: A Float specifying the size of the material orientation triad. The default value is 12.0.
lineThickness: A SymbolicConstant specifying the thickness of the material orientation triad. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
orientation: A SymbolicConstant specifying the orientation used for composites. Possible values are PLY and LAYUP. The default value is PLY.
arrowheadStyle: A SymbolicConstant specifying the arrowhead style for the material orientation triad. Possible values are NONE, FILLED, and WIRE. The default value is NONE.
scaleMode: A SymbolicConstant specifying the scaling basis for the material orientation triad. Possible values are MODEL_SIZE and SCREEN_SIZE. The default value is MODEL_SIZE.

Raises:

RangeError

SuperimposeOptions#

class SuperimposeOptions[source]#

The SuperimposeOptions object stores values and attributes associated with the undeformed shape when the display contains both the deformed shape and the undeformed shape. The SuperimposeOptions object has no constructor command. Abaqus creates a defaultOdbDisplay.superimposeOptions member when you import the Visualization module. Abaqus creates a superimposeOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.superimposeOptions. Abaqus creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. SuperimposeOptions objects are accessed in one of two ways: - The default superimpose options. These settings are used as defaults when other superimposeOptions members are created. These settings can be set to customize user preferences. - The superimpose options associated with a particular viewport. The SuperimposeOptions object is derived from the DGSuperimposeOptions object.

Notes

This object can be accessed by:

import visualization
session.defaultOdbDisplay.superimposeOptions
session.viewports[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.superimposeOptions
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.superimposeOptions
session.viewports[name].layers[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.superimposeOptions
session.viewports[name].layers[name].odbDisplay.superimposeOptions
session.viewports[name].layers[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.superimposeOptions
session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.superimposeOptions
session.viewports[name].odbDisplay.superimposeOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.superimposeOptions

Attributes:

deformedOffsetMode: SymbolicConstant: A SymbolicConstant specifying the offset of the deformed shape from the undeformed shape. Possible values are NONE, UNIFORM, and NONUNIFORM. The default value is NONE.NONE specifies that there should be no offset of the deformed shape from the undeformed shape.
uniformOffset: float: A Float specifying the uniform offset value when deformedOffsetMode=UNIFORM. The default value is 0.0.
nonuniformOffset: float: A tuple of three Floats specifying the offset value in each of the three coordinate directions when deformedOffsetMode=NONUNIFORM. The default value is (0, 0, 0).
renderStyle: SymbolicConstant: A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The default value is WIREFRAME.
visibleEdges: SymbolicConstant: A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. The default value is FEATURE.NONE can be used only when renderStyle=SHADED.
edgeLineStyle: SymbolicConstant: A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
edgeLineThickness: SymbolicConstant: A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
colorCodeOverride: Boolean: A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The default value is ON.
elemLabels: Boolean: A Boolean specifying whether to plot the element labels. The default value is OFF.
faceLabels: Boolean: A Boolean specifying whether to plot the face labels. The default value is OFF.
nodeLabels: Boolean: A Boolean specifying whether to plot the node labels. The default value is OFF.
nodeSymbols: Boolean: A Boolean specifying whether to plot the node symbols. The default value is OFF.
nodeSymbolType: SymbolicConstant: A SymbolicConstant specifying the node symbol types. Possible values are:FILLED_CIRCLEFILLED_SQUAREFILLED_DIAMONDFILLED_TRIHOLLOW_CIRCLEHOLLOW_SQUAREHOLLOW_DIAMONDHOLLOW_TRICROSSXMARKERThe default value is HOLLOW_CIRCLE.
nodeSymbolSize: SymbolicConstant: A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The default value is SMALL.
elementShrink: Boolean: A Boolean specifying whether elements are displayed in a shrunk format. The default value is OFF.
elementShrinkFactor: int: An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0≤ elementShrinkPercentage ≤ 90. The default value is 5.
coordinateScale: Boolean: A Boolean specifying whether to scale coordinates. The default value is OFF.
normals: Boolean: A Boolean specifying whether to draw arrows that indicate the directions of element and surface normals. The default value is OFF.
normalDisplay: SymbolicConstant: A SymbolicConstant specifying whether to draw element normals and surface normals. Possible values are ELEMENT and SURFACE. The default value is ELEMENT.
normalArrowLength: SymbolicConstant: A SymbolicConstant specifying the length of the normal arrows. Possible values are SHORT, MEDIUM, and LONG. The default value is MEDIUM.
normalLineThickness: SymbolicConstant: A SymbolicConstant specifying the thickness of the normal arrows. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
normalArrowheadStyle: SymbolicConstant: A SymbolicConstant specifying the arrowhead style of the normal arrows. Possible values are NONE, FILLED, and WIRE. The default value is WIRE.
translucency: Boolean: A Boolean specifying whether to set translucency. The default value is OFF.
translucencyFactor: float: A Float specifying the translucency factor when translucency=ON. Possible values are 0.0≤ translucencyFactor ≤ 1.0. The default value is 0.3.
edgeColorWireHide: str: A String specifying the color to be used to plot the edges of the model when renderStyle=WIREFRAME or HIDDEN. The default value is “Green”.
edgeColorFillShade: str: A String specifying the color to be used to plot the edges of the model when renderStyle=FILLED or SHADED. The default value is “Black”.
fillColor: str: A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The default value is “Green”.
labelFont: str: A String specifying the label font to be used for all model labels. The default value is “--courier-medium-r-normal---120---m---“.
elemLabelColor: str: A String specifying the color to be used to plot the element labels. The default value is “Cyan”.
faceLabelColor: str: A String specifying the color to be used to plot the face labels. The default value is “Red”.
nodeLabelColor: str: A String specifying the color to be used to plot the node labels. The default value is “Yellow”.
nodeSymbolColor: str: A String specifying the color to be used to plot the node symbols. The default value is “Yellow”.
faceNormalColor: str: A String specifying the color to be used to plot the normal to a nonbeam element or to a surface. The default value is “Red”.
beamN1Color: str: A String specifying the color to be used to plot an arrow along the beam n1n1-direction. The default value is “Blue”.
beamN2Color: str: A String specifying the color to be used to plot an arrow along the beam n2n2-direction. The default value is “Red”.
beamTangentColor: str: A String specifying the color to be used to plot an arrow along the tangent to a beam. The default value is “White”.
coordinateScaleFactors: float: A tuple of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The default value is (1, 1, 1).

Methods

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

This method modifies the SuperimposeOptions object.

setValues(options: SuperimposeOptions | None = None, renderStyle: SymbolicConstantType = 'WIREFRAME', visibleEdges: SymbolicConstantType = 'FEATURE', edgeColorWireHide: str = '', edgeColorFillShade: str = '', edgeLineStyle: SymbolicConstantType = 'SOLID', edgeLineThickness: SymbolicConstantType = 'VERY_THIN', colorCodeOverride: BooleanType = 1, fillColor: str = '', labelFont: str = '', elemLabels: BooleanType = 0, elemLabelColor: str = '', faceLabels: BooleanType = 0, faceLabelColor: str = '', nodeLabels: BooleanType = 0, nodeLabelColor: str = '', nodeSymbols: BooleanType = 0, nodeSymbolType: SymbolicConstantType = 'HOLLOW_CIRCLE', nodeSymbolColor: str = '', nodeSymbolSize: SymbolicConstantType = 'SMALL', elementShrink: BooleanType = 0, elementShrinkFactor: int = 5, coordinateScale: BooleanType = 0, coordinateScaleFactors: tuple = (), normals: BooleanType = 0, normalDisplay: SymbolicConstantType = 'ELEMENT', faceNormalColor: str = '', beamN1Color: str = '', beamN2Color: str = '', beamTangentColor: str = '', normalArrowLength: SymbolicConstantType = 'MEDIUM', normalLineThickness: SymbolicConstantType = 'VERY_THIN', normalArrowheadStyle: SymbolicConstantType = 'WIRE', translucency: BooleanType = 0, translucencyFactor: float = 0, deformedOffsetMode: SymbolicConstantType = 'NONE', uniformOffset: float = 0, nonuniformOffset: tuple = ())[source]#

This method modifies the SuperimposeOptions object.

Parameters:

options: A SuperimposeOptions 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.
renderStyle: A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The default value is WIREFRAME.
visibleEdges: A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. The default value is FEATURE.NONE can be used only when *renderStyle*=SHADED.
edgeColorWireHide: A String specifying the color to be used to plot the edges of the model when *renderStyle*=WIREFRAME or HIDDEN. The default value is “Green”.
edgeColorFillShade: A String specifying the color to be used to plot the edges of the model when *renderStyle*=FILLED or SHADED. The default value is “Black”.
edgeLineStyle: A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
edgeLineThickness: A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
colorCodeOverride: A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The default value is ON.
fillColor: A String specifying the color to be used to fill elements when *renderStyle*=FILLED or SHADED. The default value is “Green”.
labelFont: A String specifying the label font to be used for all model labels. The default value is “--courier-medium-r-normal---120---m---“.
elemLabels: A Boolean specifying whether to plot the element labels. The default value is OFF.
elemLabelColor: A String specifying the color to be used to plot the element labels. The default value is “Cyan”.
faceLabels: A Boolean specifying whether to plot the face labels. The default value is OFF.
faceLabelColor: A String specifying the color to be used to plot the face labels. The default value is “Red”.
nodeLabels: A Boolean specifying whether to plot the node labels. The default value is OFF.
nodeLabelColor: A String specifying the color to be used to plot the node labels. The default value is “Yellow”.
nodeSymbols: A Boolean specifying whether to plot the node symbols. The default value is OFF.
nodeSymbolType: A SymbolicConstant specifying the node symbol types. Possible values are:FILLED_CIRCLEFILLED_SQUAREFILLED_DIAMONDFILLED_TRIHOLLOW_CIRCLEHOLLOW_SQUAREHOLLOW_DIAMONDHOLLOW_TRICROSSXMARKERThe default value is HOLLOW_CIRCLE.
nodeSymbolColor: A String specifying the color to be used to plot the node symbols. The default value is “Yellow”.
nodeSymbolSize: A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The default value is SMALL.
elementShrink: A Boolean specifying whether elements are displayed in a shrunk format. The default value is OFF.
elementShrinkFactor: An Int specifying the percentage to shrink the elements when elementShrink*=ON. Possible values are 0≤ *elementShrinkPercentage ≤ 90. The default value is 5.
coordinateScale: A Boolean specifying whether to scale coordinates. The default value is OFF.
coordinateScaleFactors: A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when *coordinateScale*=ON. The default value is (1, 1, 1).
normals: A Boolean specifying whether to draw arrows that indicate the directions of element and surface normals. The default value is OFF.
normalDisplay: A SymbolicConstant specifying whether to draw element normals and surface normals. Possible values are ELEMENT and SURFACE. The default value is ELEMENT.
faceNormalColor: A String specifying the color to be used to plot the normal to a nonbeam element or to a surface. The default value is “Red”.
beamN1Color: A String specifying the color to be used to plot an arrow along the beam n1n1-direction. The default value is “Blue”.
beamN2Color: A String specifying the color to be used to plot an arrow along the beam n2n2-direction. The default value is “Red”.
beamTangentColor: A String specifying the color to be used to plot an arrow along the tangent to a beam. The default value is “White”.
normalArrowLength: A SymbolicConstant specifying the length of the normal arrows. Possible values are SHORT, MEDIUM, and LONG. The default value is MEDIUM.
normalLineThickness: A SymbolicConstant specifying the thickness of the normal arrows. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
normalArrowheadStyle: A SymbolicConstant specifying the arrowhead style of the normal arrows. Possible values are NONE, FILLED, and WIRE. The default value is WIRE.
translucency: A Boolean specifying whether to set translucency. The default value is OFF.
translucencyFactor: A Float specifying the translucency factor when translucency*=ON. Possible values are 0.0≤ *translucencyFactor ≤ 1.0. The default value is 0.3.
deformedOffsetMode: A SymbolicConstant specifying the offset of the deformed shape from the undeformed shape. Possible values are NONE, UNIFORM, and NONUNIFORM. The default value is NONE.NONE specifies that there should be no offset of the deformed shape from the undeformed shape.
uniformOffset: A Float specifying the uniform offset value when *deformedOffsetMode*=UNIFORM. The default value is 0.0.
nonuniformOffset: A sequence of three Floats specifying the offset value in each of the three coordinate directions when *deformedOffsetMode*=NONUNIFORM. The default value is (0, 0, 0).

Raises:

RangeError

SymbolOptions#

class SymbolOptions[source]#

The SymbolOptions object stores values and attributes associated with a symbol plot. The SymbolOptions object has no constructor command. Abaqus creates a defaultOdbDisplay.symbolOptions member when you import the Visualization module. Abaqus creates a symbolOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.symbolOptions. Abaqus creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. SymbolOptions objects are accessed in one of two ways: - The default symbol options. These settings are used as defaults when other symbolOptions members are created. These settings can be set to customize user preferences. - The symbol options associated with a particular viewport. The SymbolOptions object is derived from the DGSymbolOptions object.

Notes

This object can be accessed by:

import visualization
session.defaultOdbDisplay.symbolOptions
session.viewports[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.symbolOptions
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.symbolOptions
session.viewports[name].layers[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.symbolOptions
session.viewports[name].layers[name].odbDisplay.symbolOptions
session.viewports[name].layers[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.symbolOptions
session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.symbolOptions
session.viewports[name].odbDisplay.symbolOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.symbolOptions

Attributes:

vectorQuantity: SymbolicConstant: A SymbolicConstant specifying the vector quantity to display. Possible values are RESULTANT and VECTOR_COMPONENT. The default value is RESULTANT.
vectorMaxValueAutoCompute: Boolean: A Boolean specifying whether the maximum vector value is to be computed automatically. The default value is ON.
vectorMaxValue: float: A Float specifying the user-specified maximum vector value. The default value is autoVectorMaxValue.
vectorMinValueAutoCompute: Boolean: A Boolean specifying whether the minimum vector value is to be computed automatically. The default value is ON.
vectorMinValue: float: A Float specifying the user-specified minimum vector value. The default value is autoVectorMinValue.
tensorQuantity: SymbolicConstant: A SymbolicConstant specifying the tensor quantity to display. Possible values are ALL_PRINCIPAL_COMPONENTS, PRINCIPAL_COMPONENT, ALL_DIRECT_COMPONENTS, and DIRECT_COMPONENT. The default value is ALL_PRINCIPAL_COMPONENTS.
tensorMaxValueAutoCompute: Boolean: A Boolean specifying whether the maximum tensor value is to be computed automatically. The default value is ON.
tensorMaxValue: float: A Float specifying the user-specified maximum tensor value. The default value is autoTensorMaxValue.
tensorMinValueAutoCompute: Boolean: A Boolean specifying whether the minimum tensor value is to be computed automatically. The default value is ON.
tensorMinValue: float: A Float specifying the user-specified minimum tensor value. The default value is autoTensorMinValue.
autoVectorMaxValue: typing.Union[SymbolicConstant, float]: The SymbolicConstant NOT_SET or a Float specifying the vector maximum value when vectorMaxValueAutoCompute=ON. This value is read-only. The default value is NOT_SET.
autoVectorMinValue: typing.Union[SymbolicConstant, float]: The SymbolicConstant NOT_SET or a Float specifying the vector minimum value when vectorMinValueAutoCompute=ON. This value is read-only. The default value is NOT_SET.
autoTensorMaxValue: typing.Union[SymbolicConstant, float]: The SymbolicConstant NOT_SET or a Float specifying the tensor maximum value when tensorMaxValueAutoCompute=ON. This value is read-only. The default value is NOT_SET.
autoTensorMinValue: typing.Union[SymbolicConstant, float]: The SymbolicConstant NOT_SET or a Float specifying the tensor minimum value when tensorMinValueAutoCompute=ON. This value is read-only. The default value is NOT_SET.
vectorLineThickness: SymbolicConstant: A SymbolicConstant specifying the vector line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
vectorColorMethod: SymbolicConstant: A SymbolicConstant specifying the vector color method. Possible values are UNIFORM and SPECTRUM. The default value is SPECTRUM.
tensorColorMethod: SymbolicConstant: A SymbolicConstant specifying the tensor color method. Possible values are UNIFORM and SPECTRUM. The default value is SPECTRUM.
vectorArrowheadStyle: SymbolicConstant: A SymbolicConstant specifying the vector arrowhead style. Possible values are NONE, FILLED, and WIRE. The default value is WIRE.
arrowSymbolSize: int: An Int specifying the length of vector and tensor symbols. The default value is 6.
vectorIntervalNumber: int: An Int specifying the number of color intervals for vector symbols. The default value is 12.
symbolDensity: float: A Float specifying the factor for randomized sampling. The default value is 1.0.
constantLengthArrows: Boolean: A Boolean specifying whether to use constant-length arrows for vector symbols. The default value is OFF.
tensorIntervalNumber: int: An Int specifying the number of color intervals for tensor symbols. The default value is 12.
tensorLineThickness: SymbolicConstant: A SymbolicConstant specifying the line thickness of the tensor symbols. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
tensorArrowheadStyle: SymbolicConstant: A SymbolicConstant specifying the arrowhead style of the tensor symbols. Possible values are NONE, FILLED, and WIRE. The default value is WIRE.
numberFormatT: SymbolicConstant: A SymbolicConstant specifying the number format for tensor. Possible values are SCIENTIFIC, FIXED, and ENGINEERING. The default value is SCIENTIFIC.
numberFormatV: SymbolicConstant: A SymbolicConstant specifying the number format for vector. Possible values are SCIENTIFIC, FIXED, and ENGINEERING. The default value is SCIENTIFIC.
arrowScaleMode: SymbolicConstant: A SymbolicConstant specifying the arrow scaling mode. Possible values are MODEL_SIZE and SCREEN_SIZE. The default value is MODEL_SIZE.
drawLabelT: Boolean: A Boolean specifying whether to draw tensor labels. The default value is OFF.
drawLabelV: Boolean: A Boolean specifying whether to draw vector labels. The default value is OFF.
numDigitsT: int: An Int specifying the number of digits in the tensor label. The default value is 2.
numDigitsV: int: An Int specifying the number of digits in the vector label. The default value is 2.
vectorColor: str: A String specifying the vector color. The default value is “Red”.
vectorColorSpectrum: str: A String specifying the vector color spectrum name. The default value is “Rainbow”.
tensorColorSpectrum: str: A String specifying the tensor color spectrum name. The default value is “Rainbow”.
textColorT: str: A String specifying the text color for tensor. The default value is “Yellow”.
textColorV: str: A String specifying the text color for vector. The default value is “Yellow”.
textFontT: str: A String specifying the text font for tensor. The default value is “verdana”.
textFontV: str: A String specifying the text font for vector. The default value is “verdana”.
tensorMaxPrinColor: str: A String specifying the color of the maximum principal tensor symbols. The default value is “Red”.
tensorMinPrinColor: str: A String specifying the color of the minimum principal tensor symbols. The default value is “Cyan”.
tensorMidPrinColor: str: A String specifying the color of the intermediate principal tensor symbols. The default value is “Yellow”.
tensorSelectedPrinColor: str: A String specifying the color of the selected principal tensor symbols. The default value is “Red”.

Methods

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

This method modifies the SymbolOptions object.

setValues(options: SymbolOptions | None = None, vectorQuantity: SymbolicConstantType = 'RESULTANT', vectorLineThickness: SymbolicConstantType = 'VERY_THIN', vectorArrowheadStyle: SymbolicConstantType = 'WIRE', vectorColor: str = '', vectorColorMethod: SymbolicConstantType = 'SPECTRUM', vectorColorSpectrum: str = '', vectorIntervalNumber: int = 12, symbolDensity: float = 1, constantLengthArrows: BooleanType = 0, tensorColorMethod: SymbolicConstantType = 'SPECTRUM', tensorColorSpectrum: str = '', tensorIntervalNumber: int = 12, vectorMaxValueAutoCompute: BooleanType = 1, vectorMaxValue: float | None = None, vectorMinValueAutoCompute: BooleanType = 1, vectorMinValue: float | None = None, tensorQuantity: SymbolicConstantType = 'ALL_PRINCIPAL_COMPONENTS', arrowSymbolSize: int = 6, tensorMaxPrinColor: str = '', tensorMinPrinColor: str = '', tensorMidPrinColor: str = '', tensorSelectedPrinColor: str = '', tensorLineThickness: SymbolicConstantType = 'VERY_THIN', tensorArrowheadStyle: SymbolicConstantType = 'WIRE', tensorMaxValueAutoCompute: BooleanType = 1, tensorMaxValue: float | None = None, tensorMinValueAutoCompute: BooleanType = 1, tensorMinValue: float | None = None)[source]#

This method modifies the SymbolOptions object.

Parameters:

options: A SymbolOptions 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.
vectorQuantity: A SymbolicConstant specifying the vector quantity to display. Possible values are RESULTANT and VECTOR_COMPONENT. The default value is RESULTANT.
vectorLineThickness: A SymbolicConstant specifying the vector line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
vectorArrowheadStyle: A SymbolicConstant specifying the vector arrowhead style. Possible values are NONE, FILLED, and WIRE. The default value is WIRE.
vectorColor: A String specifying the vector color. The default value is “Red”.
vectorColorMethod: A SymbolicConstant specifying the vector color method. Possible values are UNIFORM and SPECTRUM. The default value is SPECTRUM.
vectorColorSpectrum: A String specifying the vector color spectrum name. The default value is “Rainbow”.
vectorIntervalNumber: An Int specifying the number of color intervals for vector symbols. The default value is 12.
symbolDensity: A Float specifying the factor for randomized sampling. The default value is 1.0.
constantLengthArrows: A Boolean specifying whether to use constant-length arrows for vector symbols. The default value is OFF.
tensorColorMethod: A SymbolicConstant specifying the tensor color method. Possible values are UNIFORM and SPECTRUM. The default value is SPECTRUM.
tensorColorSpectrum: A String specifying the tensor color spectrum name. The default value is “Rainbow”.
tensorIntervalNumber: An Int specifying the number of color intervals for tensor symbols. The default value is 12.
vectorMaxValueAutoCompute: A Boolean specifying whether the maximum vector value is to be computed automatically. The default value is ON.
vectorMaxValue: A Float specifying the user-specified maximum vector value. The default value is autoVectorMaxValue.
vectorMinValueAutoCompute: A Boolean specifying whether the minimum vector value is to be computed automatically. The default value is ON.
vectorMinValue: A Float specifying the user-specified minimum vector value. The default value is autoVectorMinValue.
tensorQuantity: A SymbolicConstant specifying the tensor quantity to display. Possible values are ALL_PRINCIPAL_COMPONENTS, PRINCIPAL_COMPONENT, ALL_DIRECT_COMPONENTS, and DIRECT_COMPONENT. The default value is ALL_PRINCIPAL_COMPONENTS.
arrowSymbolSize: An Int specifying the length of vector and tensor symbols. The default value is 6.
tensorMaxPrinColor: A String specifying the color of the maximum principal tensor symbols. The default value is “Red”.
tensorMinPrinColor: A String specifying the color of the minimum principal tensor symbols. The default value is “Cyan”.
tensorMidPrinColor: A String specifying the color of the intermediate principal tensor symbols. The default value is “Yellow”.
tensorSelectedPrinColor: A String specifying the color of the selected principal tensor symbols. The default value is “Red”.
tensorLineThickness: A SymbolicConstant specifying the line thickness of the tensor symbols. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.
tensorArrowheadStyle: A SymbolicConstant specifying the arrowhead style of the tensor symbols. Possible values are NONE, FILLED, and WIRE. The default value is WIRE.
tensorMaxValueAutoCompute: A Boolean specifying whether the maximum tensor value is to be computed automatically. The default value is ON.
tensorMaxValue: A Float specifying the user-specified maximum tensor value. The default value is autoTensorMaxValue.
tensorMinValueAutoCompute: A Boolean specifying whether the minimum tensor value is to be computed automatically. The default value is ON.
tensorMinValue: A Float specifying the user-specified minimum tensor value. The default value is autoTensorMinValue.

Raises:

RangeError

ViewCut#

class ViewCut(name: str, shape: SymbolicConstantType, origin: tuple, normal: SymbolicConstantType | float, axis2: SymbolicConstantType | float, csysName: str, cylinderAxis: SymbolicConstantType | float, followDeformation: BooleanType = 0, overrideAveraging: BooleanType = 1, referenceFrame: SymbolicConstantType = 'FIRST_FRAME')[source]#

The ViewCut object is used to store values and attributes associate with ViewCut type objects. ViewCut objects can be created using the methods described below. The methods accessed via the OdbDisplay object cause the ViewCut object to be added to the session.viewports[name].odbDisplay.viewCuts repository.

Notes

This object can be accessed by:

import visualization
session.viewports[name].layers[name].odbDisplay.viewCuts[name]
session.viewports[name].odbDisplay.viewCuts[name]

Attributes:

angle: float: A Float specifying the rotation angle of the cut defined with a shape set to PLANE.
motion: SymbolicConstant: A SymbolicConstant specifying the type of motion for the cut defined with a shape set to PLANE. Possible values are TRANSLATE and ROTATE. The default value is TRANSLATE.
position: float: A Float specifying the position of the cut defined with a shape set to PLANE.
radius: float: A Float specifying the radius of the cut defined with a shape set to CYLINDER or SPHERE.
rotationAxis: SymbolicConstant: A SymbolicConstant specifying the rotation axis for the cut defined with a shape set to PLANE. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_2.
value: float: A Float specifying the value of the cut defined with a shape set to ISOSURFACE.
showModelAboveCut: Boolean: A Boolean specifying whether to display the model above the cut. The default value is OFF.
showModelOnCut: Boolean: A Boolean specifying whether to display the model on the cut. The default value is ON.
showModelBelowCut: Boolean: A Boolean specifying whether to display the model below the cut. The default value is ON.
showFreeBodyCut: Boolean: A Boolean specifying whether to display the free body cut. The default value is OFF.
active: Boolean: A Boolean specifying whether the cut is displayed.
cutRange: tuple[float]: A pair of Floats specifying the acceptable range for positioning the cut.
crossSectionalArea: float: A Float returning the cross-sectional area of the cut when showFreeBodyCut is set to ON.

Methods

`setValues`([angle, motion, position, radius, ...])	This method modifies the ViewCut object.
`updateVariable`()	This method updates the field associated with an isosurface cut to be consistent with the current primary variable.

setValues(angle: float | None = None, motion: SymbolicConstantType = 'TRANSLATE', position: float | None = None, radius: float | None = None, rotationAxis: SymbolicConstantType = 'AXIS_2', value: float | None = None, showModelAboveCut: BooleanType = 0, showModelOnCut: BooleanType = 1, showModelBelowCut: BooleanType = 1, showFreeBodyCut: BooleanType = 0, csysName: str = '', origin: tuple = (), normal: SymbolicConstantType | float = 'AXIS_1', axis2: SymbolicConstantType | float = 'AXIS_2', cylinderAxis: SymbolicConstantType | float = 'AXIS_3', followDeformation: BooleanType = 0, overrideAveraging: BooleanType = 1, referenceFrame: SymbolicConstantType = 'FIRST_FRAME')[source]#

This method modifies the ViewCut object.

Parameters:

angle: A Float specifying the rotation angle of the cut defined with a shape set to PLANE.
motion: A SymbolicConstant specifying the type of motion for the cut defined with a shape set to PLANE. Possible values are TRANSLATE and ROTATE. The default value is TRANSLATE.
position: A Float specifying the position of the cut defined with a shape set to PLANE.
radius: A Float specifying the radius of the cut defined with a shape set to CYLINDER or SPHERE.
rotationAxis: A SymbolicConstant specifying the rotation axis for the cut defined with a shape set to PLANE. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_2.
value: A Float specifying the value of the cut defined with a shape set to ISOSURFACE.
showModelAboveCut: A Boolean specifying whether to display the model above the cut. The default value is OFF.
showModelOnCut: A Boolean specifying whether to display the model on the cut. The default value is ON.
showModelBelowCut: A Boolean specifying whether to display the model below the cut. The default value is ON.
showFreeBodyCut: A Boolean specifying whether to display the free body cut. The default value is OFF.
csysName: A String specifying the name of the DatumCsys object to be used to define the cut. This name is not required if the cut shape is ISOSURFACE or if the cut is defined by the origin argument.
origin: A sequence of three Floats specifying the X-, Y-, and Z-coordinates of the origin of the plane, cylinder or sphere cut. This origin is not required if the cut shape is ISOSURFACE or if the cut is defined by the csysName argument.
normal: A sequence of Floats specifying the X-, Y-, and Z-coordinates of the normal axis to the plane defining the cut, when the plane is defined using the origin argument or a SymbolicConstant defining this normal axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. This axis is not required if the cut shape is CYLINDER, SPHERE or ISOSURFACE.
axis2: A sequence of three Floats specifying the X-, Y-, and Z-coordinates of the second axis of the plane defining the cut, when the plane is defined using the origin argument or a SymbolicConstant defining this second axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. This axis is used to rotate the plane cut. It is not required if the cut shape is CYLINDER, SPHERE or ISOSURFACE.
cylinderAxis: A sequence of Floats specifying the X-, Y-, and Z-coordinates of the cylinder axis defining the cut, when the cut is defined using the origin argument or a SymbolicConstant defining this cylinder axis, when the cut is defined by the csysName argument. Possible values are AXIS_1, AXIS_2, AXIS_3. This axis is not required if the cut shape is PLANE, SPHERE, or ISOSURFACE.
followDeformation: A Boolean specifying whether the cut will follow the deformation or be static. The default value is OFF.
overrideAveraging: A Boolean specifying averaging for element based fields associated with isosurface cuts will be set to compute-average with a threshold of 100% when true. The current field options will be used when false. The default value is ON.
referenceFrame: A SymbolicConstant specifying which reference frame will be used when the cut follows the deformation. Possible values are FIRST_FRAME, LAST_FRAME, and CURRENT_FRAME. The default value is FIRST_FRAME.

updateVariable()[source]#: This method updates the field associated with an isosurface cut to be consistent with the current primary variable.

ViewerOptions#

class ViewerOptions[source]#

The ViewerOptions object specifies options to set the result caching parameters. The ViewerOptions object has no constructor. Abaqus creates the viewerOptions member when a session is started.

Notes

This object can be accessed by:

import visualization
session.viewerOptions

Methods

setValues([primaryVariableCaching, ...])

This method modifies the ViewerOptions object.

setValues(primaryVariableCaching: BooleanType = 1, deformedVariableCaching: BooleanType = 1, cutVariableCaching: BooleanType = 1, odbUpdateChecking: BooleanType = 1, odbUpdateCheckInterval: int = 0)[source]#

This method modifies the ViewerOptions object.

Parameters:

primaryVariableCaching: A Boolean specifying whether results are currently cached. Caching improves the performance of subsequent access. The default value is ON.
deformedVariableCaching: A Boolean specifying whether deformation vectors are currently cached. Caching improves the performance of subsequent access. The default value is ON.
cutVariableCaching: A Boolean specifying whether the values used for displaying cut models are currently cached. Caching improves the performance of subsequent access. The default value is ON.
odbUpdateChecking: A Boolean specifying whether the current .odb file should be checked for updates. Setting odbUpdateChecking to OFF can improve Viewer performance when accessing data from a remote file. The default value is ON.
odbUpdateCheckInterval: An Int specifying the minimum time between status checks (in seconds). The default value is 0.