Plot Options

Plot options commands are used to control the appearance of plots in the Visualization module. Plots can be undeformed, deformed, contour, symbol, or material orientation.

Other Classes

class BasicOptions[source]

Bases: _CopyOptionsBase

The BasicOptions object stores values and attributes associated with an OdbDisplay object. The BasicOptions object has no constructor command. Abaqus creates the defaultOdbDisplay.basicOptions member when you import the Visualization module. Abaqus creates a basicOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.basicOptions. 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. BasicOptions objects are accessed in one of two ways:

  • The default basic options: these settings are used as defaults when other basicOptions members are created. These settings can be set to customize user preferences.

  • The basic options associated with a particular viewport.

Note

This object can be accessed by:

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

Note

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

Member Details:

accountForDeactivatedElems : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to account for deactivated elements. The default value is ON.

automaticExtrudeDepth : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]

A Float specifying the automatic extrude depth used to extrude analytical rigid surfaces in the default setting. This value is read-only.

averageElementOutput : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to average the element output. The default value is ON.

averageOnlyDisplayed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to average only values on displayed elements. The default value is ON.

averagingThreshold : --is-rst--:py:class:`float` = 75[source]

A Float specifying the nodal averaging threshold percentage. Possible values are 0 < averagingThreshold < 100. The default value is 75.0.

bcDisplay : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to display boundary conditions. The default value is OFF.

beamScaleFactor : --is-rst--:py:class:`float` = 1[source]

A Float specifying the beam profile scale factor. The beamScaleFactor must be greater than zero. The default value is 1.0.

cameraCsysName : --is-rst--:py:class:`str` = ''[source]

A String specifying the name of the coordinate system driving the moving camera.

cameraFollowsRotation : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the camera, when it moves, follows the rotation of the coordinate system. The default value is OFF.

cameraMovesWithCsys : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the camera moves with the coordinate system. The default value is OFF.

complexAngle : --is-rst--:py:class:`float` = 0[source]

A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_MAG_AT_ANGLE. The default value is 0.0.

computeOutput : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'EXTRAPOLATE_AVERAGE_COMPUTE'[source]

A Boolean specifying whether to average only values on displayed elements. The default value is ON.

connectorDisplay : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to display connectors. The default value is OFF.

coordSystemDisplay : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to display coordinate systems. The default value is OFF.

couplingDisplay : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to display coupling constraints. The default value is ON.

curveRefinementLevel : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'COARSE'[source]

A SymbolicConstant specifying the refinement level for drawing curves. Possible values are EXTRA_COARSE, COARSE, MEDIUM, FINE, and EXTRA_FINE. The default value is COARSE.

datumCsys : --is-rst--:py:class:`~abaqus.Datum.DatumCsys.DatumCsys` = <abaqus.Datum.DatumCsys.DatumCsys object>[source]

A DatumCsys object specifying the coordinate system to use for results transformation when transformationType = USER_SPECIFIED.

envelopeCriteria : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MAX_ABS_VALUE'[source]

A SymbolicConstant specifying the envelope criterion. Possible values are MAX_VALUE, MIN_VALUE, and MAX_ABS_VALUE. The default value is MAX_ABS_VALUE.

envelopeDataPosition : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'INTEGRATION_POINT'[source]

A SymbolicConstant specifying the output position for envelope calculations. Possible values are CENTROID, ELEMENT_NODAL, and INTEGRATION_POINT. The default value is INTEGRATION_POINT.

extrapAlgorithm : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]

A SymbolicConstant specifying the extrapolation algorithm. This member is for internal use only. The only possible value is EXTRAP_COMPUTE_AVERAGE.

extrudeArs : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to extrude analytical surfaces. The default value is ON or OFF depending on characteristics of your model.

extrudeArsDepth : --is-rst--:py:class:`float` = 1[source]

A Float specifying the depth (in model units) by which the analytical surfaces are to be extruded when extrudeArs = ON. The default value is 1.0.

extrudeArsDepthAutoCompute : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to use automatic depth determination when extruding analytical surfaces. The default value is ON. The default value is ON.

extrudeElem : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to extrude deformable elements. The default value is ON or OFF depending on characteristics of your model.

extrudeElemDepth : --is-rst--:py:class:`float` = 1[source]

A Float specifying the depth (in model units) by which the deformable elements are to be extruded when extrudeElem = ON. The default value is 1.0.

featureAngle : --is-rst--:py:class:`float` = 30[source]

A Float specifying the feature angle to be used when visibleEdges = FEATURE. The default value is 30.0.

highlightConnectorPts : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to highlight connector points. The default value is ON.

includeFeatureBoundaries : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to include additional averaging boundaries for shells and membranes based on feature edges. The default value is ON.

massElements : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to display mass, heat capacity and inertia elements. massElements is valid only when pointElements = ON. The default value is OFF.

mirrorAboutXyPlane : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to mirror about the XY plane. The default value is OFF.

mirrorAboutXzPlane : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to mirror about the XZ plane. The default value is OFF.

mirrorAboutYzPlane : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to mirror about the YZ plane. The default value is OFF.

mirrorCsysName : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'GLOBAL'[source]

The SymbolicConstant GLOBAL or a String specifying the name of the mirror’s coordinate system. The default value is GLOBAL.

mirrorDisplayBodies : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to mirror display bodies. The default value is OFF.

mirrorPatternOrder : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MIRROR_RECT_CIRC'[source]

A SymbolicConstant specifying the order of operations to create the mirror pattern. Possible values are MIRROR_RECT_CIRC, RECT_MIRROR_CIRC, MIRROR_CIRC_RECT, RECT_CIRC_MIRROR, CIRC_MIRROR_RECT, and CIRC_RECT_MIRROR. The default value is MIRROR_RECT_CIRC.

modelCanExtrude : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the model contains any elements or surfaces that can be extruded.

noResultsColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the color of elements that do not have any results. The default value is “White”.

numSectors : --is-rst--:py:class:`int` | :py:obj:`None` = None[source]

An Int specifying the number of sectors of a cyclic symmetric model. The value is automatically computed from the cyclic symmetric model. This value is read-only.

numSweepSegmentsArs : --is-rst--:py:class:`int` | :py:obj:`None` = None[source]

An Int specifying the number of segments to display when sweepArs = ON. The default value is 10 or 20, depending on characteristics of your model.

numSweepSegmentsElem : --is-rst--:py:class:`int` | :py:obj:`None` = None[source]

An Int specifying the number of segments to display when sweepElem = ON. The default value is 10 or 20, depending on characteristics of your model.

numericForm : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'REAL'[source]

A SymbolicConstant specifying the numeric form in which to display results that contain complex numbers. Possible values are COMPLEX_MAGNITUDE, COMPLEX_PHASE, REAL, IMAGINARY, COMPLEX_MAG_AT_ANGLE, COMPLEX_ENVELOPE_MAX_ABS, COMPLEX_ENVELOPE_MAX, and COMPLEX_ENVELOPE_MIN. The default value is REAL.

Changed in version 2019: Add possible values: COMPLEX_ENVELOPE_MAX_ABS, COMPLEX_ENVELOPE_MAX, and COMPLEX_ENVELOPE_MIN.

otherSymbolSize : --is-rst--:py:class:`int` = 6[source]

An Int specifying the size of various glyph symbols (boundary conditions, coupling constraints, etc.). The default value is 6.

patternCsysName : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'GLOBAL'[source]

The SymbolicConstant GLOBAL or a String specifying the name of the pattern’s coordinate system. The default value is GLOBAL.

patternNumCircular : --is-rst--:py:class:`int` = 1[source]

An Int specifying the number of patterns to create in a circular pattern. The default value is 1.

patternNumX : --is-rst--:py:class:`int` = 1[source]

An Int specifying the number of patterns to create in the X-direction for a rectangular pattern. The default value is 1.

patternNumY : --is-rst--:py:class:`int` = 1[source]

An Int specifying the number of patterns to create in the Y-direction for a rectangular pattern. The default value is 1.

patternNumZ : --is-rst--:py:class:`int` = 1[source]

An Int specifying the number of patterns to create in the Z-direction for a rectangular pattern. The default value is 1.

patternOffsetX : --is-rst--:py:class:`float` = 0[source]

A Float specifying the offset of the pattern along the X-axis for a rectangular pattern. The default value is 0.0.

patternOffsetY : --is-rst--:py:class:`float` = 0[source]

A Float specifying the offset of the pattern along the Y-axis for a rectangular pattern. The default value is 0.0.

patternOffsetZ : --is-rst--:py:class:`float` = 0[source]

A Float specifying the offset of the pattern along the Z-axis for a rectangular pattern. The default value is 0.0.

patternRotationAxis : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ZAXIS'[source]

A SymbolicConstant specifying the axis of rotation for a circular. Possible values are XAXIS, YAXIS, and ZAXIS. The default value is ZAXIS.

patternTotalAngle : --is-rst--:py:class:`float` = 360[source]

A Float specifying the total angle of a circular pattern. The default value is 360.0.

pc3dElements : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to display PC3D elements. pc3dElements is valid only when pointElements = ON. The default value is ON.

pd3dElements : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to display PD3D elements. pd3dElements is valid only when pointElements = ON. The default value is ON.

plyResultLocation : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MIDDLE'[source]

A SymbolicConstant specifying the ply result location. Possible values are BOTTOM, MIDDLE, TOP, and TOP_AND_BOTTOM. The default value is MIDDLE.

pointElements : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to display point type elements. The default value is ON.

quantityToPlot : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'FIELD_OUTPUT'[source]

A SymbolicConstant specifying the quantity to plot. Possible values are FIELD_OUTPUT and DISCONTINUITIES. The default value is FIELD_OUTPUT.

referencePoints : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to display reference points. referencePoints is valid only when pointElements = ON. The default value is ON.

regionAveraging : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to ignore region boundaries when computing values. The default value is ON.

regionBoundaries : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ODB_REGIONS'[source]

A SymbolicConstant specifying the type of averaging region boundaries. Possible values are NONE, ODB_REGIONS, ELEMENT_SET, and DISPLAY_GROUPS. The default value is ODB_REGIONS.

renderBeamProfiles : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to render the beam profiles. The default value is OFF.

renderShellThickness : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to render the shell thickness. The default value is OFF.

rigidTransformDeformed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to perform a rigid transformation of current deformedVariable based on the active user specific system The default value is OFF.

rigidTransformPrimary : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to perform a rigid transformation of nodal vector datasets based on the active user specific system The default value is OFF.

scratchCoordSystemDisplay : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to display coordinate systems that represent user-defined orientations. The default value is OFF.

sectionPointScheme : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'CATEGORY_BASED'[source]

A SymbolicConstant specifying the section point scheme. Possible values are CATEGORY_BASED and PLY_BASED. The default value is CATEGORY_BASED.

sectionResults : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'USE_BOTTOM'[source]

A SymbolicConstant specifying which of the section points to use. Possible values are USE_BOTTOM, USE_TOP, USE_BOTTOM_AND_TOP, and USE_ENVELOPE. The default value is USE_BOTTOM.

sectorAngle : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]

A Float specifying the sector angle of a cyclic symmetric model. The value is automatically computed from the cyclic symmetric model. This value is read-only.

sectorSelectionType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SELECT_BY_NUMBER'[source]

A SymbolicConstant specifying how sectors will be selected for sweeping. Possible values are SELECT_BY_NUMBER, SELECT_BY_ANGLE, and SELECT_ALL. The default value is SELECT_BY_NUMBER.

selectedSectorNumbers : --is-rst--:py:data:`~typing.Optional`\ \[:py:class:`~typing.Sequence`\ \[:py:class:`int`]] = None[source]

A tuple of Ints specifying which sectors to display when sectorSelectionType = SELECT_BY_NUMBER. Possible values are 1 ≤ selectedSectorNumbers ≤ the number of sectors. The default value is (1).

setValues(
options=None,
*,
cameraCsysName='',
cameraMovesWithCsys=0,
cameraFollowsRotation=0,
averagingThreshold=75,
quantityToPlot=FIELD_OUTPUT,
curveRefinementLevel=COARSE,
noResultsColor='',
featureAngle=30,
otherSymbolSize=6,
renderBeamProfiles=0,
beamScaleFactor=1,
renderShellThickness=0,
shellScaleFactor=1,
accountForDeactivatedElems=1,
bcDisplay=0,
connectorDisplay=0,
highlightConnectorPts=1,
showConnectorAxes=1,
showConnectorType=1,
pointElements=1,
referencePoints=1,
massElements=0,
springElements=0,
spotWelds=0,
tracerParticles=0,
pc3dElements=1,
pd3dElements=1,
sweepArs=0,
sweepElem=0,
sweepStartAngleArs=0,
sweepStartAngleElem=0,
sweepEndAngleArs=360,
sweepEndAngleElem=180,
numSweepSegmentsArs=None,
numSweepSegmentsElem=None,
numericForm=REAL,
complexAngle=0,
sectionResults=USE_BOTTOM,
envelopeCriteria=MAX_ABS_VALUE,
envelopeDataPosition=INTEGRATION_POINT,
plyResultLocation=MIDDLE,
sectionPointScheme=CATEGORY_BASED,
sweepSectors=0,
sectorSelectionType=SELECT_BY_NUMBER,
selectedSectorNumbers=(),
sweepSectorStartAngle=0,
sweepSectorEndAngle=360,
extrudeArs=0,
extrudeArsDepthAutoCompute=1,
extrudeElem=0,
extrudeArsDepth=1,
extrudeElemDepth=1,
mirrorPatternOrder=MIRROR_RECT_CIRC,
mirrorCsysName=GLOBAL,
mirrorAboutXyPlane=0,
mirrorAboutXzPlane=0,
mirrorAboutYzPlane=0,
mirrorDisplayBodies=0,
patternCsysName=GLOBAL,
patternNumX=1,
patternNumY=1,
patternNumZ=1,
patternOffsetX=0,
patternOffsetY=0,
patternOffsetZ=0,
patternRotationAxis=ZAXIS,
patternTotalAngle=360,
patternNumCircular=1,
couplingDisplay=1,
coordSystemDisplay=0,
scratchCoordSystemDisplay=0,
transformationType=DEFAULT,
datumCsys=None,
rigidTransformPrimary=0,
rigidTransformDeformed=0,
transformOnDeformed=1,
averageElementOutput=1,
averageOnlyDisplayed=1,
computeOutput=EXTRAPOLATE_AVERAGE_COMPUTE,
regionBoundaries=ODB_REGIONS,
useRegionBoundaries=1,
userRegions=(),
includeFeatureBoundaries=1,
)[source]

This method modifies the BasicOptions object.

Note

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

Parameters:
options=None

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

cameraCsysName=''

A String specifying the name of the coordinate system driving the moving camera.

cameraMovesWithCsys=0

A Boolean specifying whether the camera moves with the coordinate system. The default value is OFF.

cameraFollowsRotation=0

A Boolean specifying whether the camera, when it moves, follows the rotation of the coordinate system. The default value is OFF.

averagingThreshold=75

A Float specifying the nodal averaging threshold percentage. Possible values are 0 < averagingThreshold < 100. The default value is 75.0.

quantityToPlot=FIELD_OUTPUT

A SymbolicConstant specifying the quantity to plot. Possible values are FIELD_OUTPUT and DISCONTINUITIES. The default value is FIELD_OUTPUT.

curveRefinementLevel=COARSE

A SymbolicConstant specifying the refinement level for drawing curves. Possible values are EXTRA_COARSE, COARSE, MEDIUM, FINE, and EXTRA_FINE. The default value is COARSE.

noResultsColor=''

A String specifying the color of elements that do not have any results. The default value is “White”.

featureAngle=30

A Float specifying the feature angle to be used when visibleEdges = FEATURE. The default value is 30.0.

otherSymbolSize=6

An Int specifying the size of various glyph symbols (boundary conditions, coupling constraints, etc.). The default value is 6.

renderBeamProfiles=0

A Boolean specifying whether to render the beam profiles. The default value is OFF.

beamScaleFactor=1

A Float specifying the beam profile scale factor. The beamScaleFactor must be greater than zero. The default value is 1.0.

renderShellThickness=0

A Boolean specifying whether to render the shell thickness. The default value is OFF.

shellScaleFactor=1

A Float specifying the shell thickness scale factor. The shellScaleFactor must be greater than zero. The default value is 1.0.

accountForDeactivatedElems=1

A Boolean specifying whether to account for deactivated elements. The default value is ON.

bcDisplay=0

A Boolean specifying whether to display boundary conditions. The default value is OFF.

connectorDisplay=0

A Boolean specifying whether to display connectors. The default value is OFF.

highlightConnectorPts=1

A Boolean specifying whether to highlight connector points. The default value is ON.

showConnectorAxes=1

A Boolean specifying whether to display connector orientations or coordinate systems. The default value is ON.

showConnectorType=1

A Boolean specifying whether to display the text that describes the connector type. The default value is ON.

pointElements=1

A Boolean specifying whether to display point type elements. The default value is ON.

referencePoints=1

A Boolean specifying whether to display reference points. referencePoints is valid only when pointElements = ON. The default value is ON.

massElements=0

A Boolean specifying whether to display mass, heat capacity and inertia elements. massElements is valid only when pointElements = ON. The default value is OFF.

springElements=0

A Boolean specifying whether to display spring and dashpot elements. springElements is valid only when pointElements = ON. The default value is OFF.

spotWelds=0

A Boolean specifying whether to display spot weld and distributed coupling elements. spotWelds is valid only when pointElements = ON. The default value is OFF.

tracerParticles=0

A Boolean specifying whether to display tracer particles. tracerParticles is valid only when pointElements = ON. The default value is OFF.

pc3dElements=1

A Boolean specifying whether to display PC3D elements. pc3dElements is valid only when pointElements = ON. The default value is ON.

pd3dElements=1

A Boolean specifying whether to display PD3D elements. pd3dElements is valid only when pointElements = ON. The default value is ON.

sweepArs=0

A Boolean specifying whether to sweep the analytical surfaces. The default value is ON or OFF, depending on the characteristics of your model.

sweepElem=0

A Boolean specifying whether to sweep the deformable elements. The default value is ON or OFF, depending on the characteristics of your model.

sweepStartAngleArs=0

A Float specifying the starting angle (in degrees) from which to sweep the analytical surfaces when sweepArs = ON. The default value is 0.0.

sweepStartAngleElem=0

A Float specifying the starting angle (in degrees) from which to sweep the model when sweepElem = ON. The default value is 0.0.

sweepEndAngleArs=360

A Float specifying the angle (in degrees) through which to sweep the analytical surfaces when sweepArs = ON. The default value is 360.0.

sweepEndAngleElem=180

A Float specifying the angle (in degrees) through which to sweep the model when sweepElem = ON. The default value is 180.0.

numSweepSegmentsArs=None

An Int specifying the number of segments to display when sweepArs = ON. The default value is 10 or 20, depending on characteristics of your model.

numSweepSegmentsElem=None

An Int specifying the number of segments to display when sweepElem = ON. The default value is 10 or 20, depending on characteristics of your model.

numericForm=REAL

A SymbolicConstant specifying the numeric form in which to display results that contain complex numbers. Possible values are COMPLEX_MAGNITUDE, COMPLEX_PHASE, REAL, IMAGINARY, COMPLEX_MAG_AT_ANGLE, COMPLEX_ENVELOPE_MAX_ABS, COMPLEX_ENVELOPE_MAX, and COMPLEX_ENVELOPE_MIN. The default value is REAL.

Changed in version 2019: Add possible values: COMPLEX_ENVELOPE_MAX_ABS, COMPLEX_ENVELOPE_MAX, and COMPLEX_ENVELOPE_MIN.

complexAngle=0

A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_MAG_AT_ANGLE. The default value is 0.0.

sectionResults=USE_BOTTOM

A SymbolicConstant specifying which of the section points to use. Possible values are USE_BOTTOM, USE_TOP, USE_BOTTOM_AND_TOP, and USE_ENVELOPE. The default value is USE_BOTTOM.

envelopeCriteria=MAX_ABS_VALUE

A SymbolicConstant specifying the envelope criterion. Possible values are MAX_VALUE, MIN_VALUE, and MAX_ABS_VALUE. The default value is MAX_ABS_VALUE.

envelopeDataPosition=INTEGRATION_POINT

A SymbolicConstant specifying the output position for envelope calculations. Possible values are CENTROID, ELEMENT_NODAL, and INTEGRATION_POINT. The default value is INTEGRATION_POINT.

plyResultLocation=MIDDLE

A SymbolicConstant specifying the ply result location. Possible values are BOTTOM, MIDDLE, TOP, and TOP_AND_BOTTOM. The default value is MIDDLE.

sectionPointScheme=CATEGORY_BASED

A SymbolicConstant specifying the section point scheme. Possible values are CATEGORY_BASED and PLY_BASED. The default value is CATEGORY_BASED.

sweepSectors=0

A Boolean specifying whether to sweep the cyclic symmetry sectors. The default value is OFF.

sectorSelectionType=SELECT_BY_NUMBER

A SymbolicConstant specifying how sectors will be selected for sweeping. Possible values are SELECT_BY_NUMBER, SELECT_BY_ANGLE, and SELECT_ALL. The default value is SELECT_BY_NUMBER.

selectedSectorNumbers=()

A sequence of Ints specifying which sectors to display when sectorSelectionType = SELECT_BY_NUMBER. Possible values are 1 ≤ selectedSectorNumbers ≤ the number of sectors. The default value is (1).

sweepSectorStartAngle=0

A Float specifying the angle (in degrees) from which to sweep cyclic symmetry sectors when sweepSectors = ON. Possible values are multiples of the sector angle such that 0 ≤ sweepSectorStartAngle ≤ 360. The default value is 0.0.

sweepSectorEndAngle=360

A Float specifying the angle (in degrees) through which to sweep cyclic symmetry sectors when sweepSectors = ON. Possible values are multiples of the sector angle such that 0 < sweepSectorEndAngle ≤ 360. The default value is 360.0.

extrudeArs=0

A Boolean specifying whether to extrude analytical surfaces. The default value is ON or OFF depending on characteristics of your model.

extrudeArsDepthAutoCompute=1

A Boolean specifying whether to use automatic depth determination when extruding analytical surfaces. The default value is ON. The default value is ON.

extrudeElem=0

A Boolean specifying whether to extrude deformable elements. The default value is ON or OFF depending on characteristics of your model.

extrudeArsDepth=1

A Float specifying the depth (in model units) by which the analytical surfaces are to be extruded when extrudeArs = ON. The default value is 1.0.

extrudeElemDepth=1

A Float specifying the depth (in model units) by which the deformable elements are to be extruded when extrudeElem = ON. The default value is 1.0.

mirrorPatternOrder=MIRROR_RECT_CIRC

A SymbolicConstant specifying the order of operations to create the mirror pattern. Possible values are MIRROR_RECT_CIRC, RECT_MIRROR_CIRC, MIRROR_CIRC_RECT, RECT_CIRC_MIRROR, CIRC_MIRROR_RECT, and CIRC_RECT_MIRROR. The default value is MIRROR_RECT_CIRC.

mirrorCsysName=GLOBAL

The SymbolicConstant GLOBAL or a String specifying the name of the mirror’s coordinate system. The default value is GLOBAL.

mirrorAboutXyPlane=0

A Boolean specifying whether to mirror about the XY plane. The default value is OFF.

mirrorAboutXzPlane=0

A Boolean specifying whether to mirror about the XZ plane. The default value is OFF.

mirrorAboutYzPlane=0

A Boolean specifying whether to mirror about the YZ plane. The default value is OFF.

mirrorDisplayBodies=0

A Boolean specifying whether to mirror display bodies. The default value is OFF.

patternCsysName=GLOBAL

The SymbolicConstant GLOBAL or a String specifying the name of the pattern’s coordinate system. The default value is GLOBAL.

patternNumX=1

An Int specifying the number of patterns to create in the X-direction for a rectangular pattern. The default value is 1.

patternNumY=1

An Int specifying the number of patterns to create in the Y-direction for a rectangular pattern. The default value is 1.

patternNumZ=1

An Int specifying the number of patterns to create in the Z-direction for a rectangular pattern. The default value is 1.

patternOffsetX=0

A Float specifying the offset of the pattern along the X-axis for a rectangular pattern. The default value is 0.0.

patternOffsetY=0

A Float specifying the offset of the pattern along the Y-axis for a rectangular pattern. The default value is 0.0.

patternOffsetZ=0

A Float specifying the offset of the pattern along the Z-axis for a rectangular pattern. The default value is 0.0.

patternRotationAxis=ZAXIS

A SymbolicConstant specifying the axis of rotation for a circular. Possible values are XAXIS, YAXIS, and ZAXIS. The default value is ZAXIS.

patternTotalAngle=360

A Float specifying the total angle of a circular pattern. The default value is 360.0.

patternNumCircular=1

An Int specifying the number of patterns to create in a circular pattern. The default value is 1.

couplingDisplay=1

A Boolean specifying whether to display coupling constraints. The default value is ON.

coordSystemDisplay=0

A Boolean specifying whether to display coordinate systems. The default value is OFF.

scratchCoordSystemDisplay=0

A Boolean specifying whether to display coordinate systems that represent user-defined orientations. The default value is OFF.

transformationType=DEFAULT

A SymbolicConstant specifying the transformation to apply to the PrimaryVariable. Possible values are DEFAULT, NODAL, USER_SPECIFIED, ANGULAR, and LAYUP_ORIENTATION. The default value is DEFAULT.If transformationType = NODAL, Abaqus will transform nodal vector fields into any orientation defined in the analysis with the TRANSFORM option. Setting transformationType = NODAL has no effect on element-based results.If transformationType = USER_SPECIFIED, Abaqus will transform tensor and vector fields into the coordinate system specified by datumCsys.If transformationType = LAYUP_ORIENTATION, Abaqus will transform tensor and vector fields into the layup orientation defined in the composite section. The odb should contain the field SORIENT in order to use this option.

datumCsys=None

A DatumCsys object specifying the coordinate system to use for results transformation when transformationType = USER_SPECIFIED.

rigidTransformPrimary=0

A Boolean specifying whether to perform a rigid transformation of nodal vector datasets based on the active user specific system The default value is OFF.

rigidTransformDeformed=0

A Boolean specifying whether to perform a rigid transformation of current deformedVariable based on the active user specific system The default value is OFF.

transformOnDeformed=1

A Boolean specifying whether to include the effects of deformation on the transformation calculations The default value is ON.

averageElementOutput=1

A Boolean specifying whether to average the element output. The default value is ON.

averageOnlyDisplayed=1

A Boolean specifying whether to average only values on displayed elements. The default value is ON.

computeOutput=EXTRAPOLATE_AVERAGE_COMPUTE

A SymbolicConstant specifying the order or the computations to be performed. Possible values are EXTRAPOLATE_AVERAGE_COMPUTE, EXTRAPOLATE_COMPUTE_AVERAGE, EXTRAPOLATE_COMPUTE, EXTRAPOLATE_COMPUTE_DISCONTINUITIES, and RAW_DATA. The default value is EXTRAPOLATE_AVERAGE_COMPUTE.

regionBoundaries=ODB_REGIONS

A SymbolicConstant specifying the type of averaging region boundaries. Possible values are NONE, ODB_REGIONS, ELEMENT_SET, and DISPLAY_GROUPS. The default value is ODB_REGIONS.

useRegionBoundaries=1

A Boolean specifying whether to use region boundaries when averaging. The default value is ON.

userRegions=()

A sequence of Strings specifying either element set or display group names (depending on the value of regionBoundaries) defining the averaging region boundaries. The default value is an empty sequence.

includeFeatureBoundaries=1

A Boolean specifying whether to include additional averaging boundaries for shells and membranes based on feature edges. The default value is ON.

Raises:

RangeError – If featureAngle is not in the valid range.

shellScaleFactor : --is-rst--:py:class:`float` = 1[source]

A Float specifying the shell thickness scale factor. The shellScaleFactor must be greater than zero. The default value is 1.0.

showConnectorAxes : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to display connector orientations or coordinate systems. The default value is ON.

showConnectorType : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to display the text that describes the connector type. The default value is ON.

spotWelds : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to display spot weld and distributed coupling elements. spotWelds is valid only when pointElements = ON. The default value is OFF.

springElements : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to display spring and dashpot elements. springElements is valid only when pointElements = ON. The default value is OFF.

sweepArs : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to sweep the analytical surfaces. The default value is ON or OFF, depending on the characteristics of your model.

sweepElem : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to sweep the deformable elements. The default value is ON or OFF, depending on the characteristics of your model.

sweepEndAngleArs : --is-rst--:py:class:`float` = 360[source]

A Float specifying the angle (in degrees) through which to sweep the analytical surfaces when sweepArs = ON. The default value is 360.0.

sweepEndAngleElem : --is-rst--:py:class:`float` = 180[source]

A Float specifying the angle (in degrees) through which to sweep the model when sweepElem = ON. The default value is 180.0.

sweepModelType : --is-rst--:py:class:`int` | :py:obj:`None` = None[source]

An Int specifying the types of sweepable elements and surfaces contained in the model, if any.

sweepSectorEndAngle : --is-rst--:py:class:`float` = 360[source]

A Float specifying the angle (in degrees) through which to sweep cyclic symmetry sectors when sweepSectors = ON. Possible values are multiples of the sector angle such that 0 < sweepSectorEndAngle ≤ 360. The default value is 360.0.

sweepSectorStartAngle : --is-rst--:py:class:`float` = 0[source]

A Float specifying the angle (in degrees) from which to sweep cyclic symmetry sectors when sweepSectors = ON. Possible values are multiples of the sector angle such that 0 ≤ sweepSectorStartAngle ≤ 360. The default value is 0.0.

sweepSectors : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to sweep the cyclic symmetry sectors. The default value is OFF.

sweepStartAngleArs : --is-rst--:py:class:`float` = 0[source]

A Float specifying the starting angle (in degrees) from which to sweep the analytical surfaces when sweepArs = ON. The default value is 0.0.

sweepStartAngleElem : --is-rst--:py:class:`float` = 0[source]

A Float specifying the starting angle (in degrees) from which to sweep the model when sweepElem = ON. The default value is 0.0.

tracerParticles : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to display tracer particles. tracerParticles is valid only when pointElements = ON. The default value is OFF.

transformOnDeformed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to include the effects of deformation on the transformation calculations The default value is ON.

transformationType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'DEFAULT'[source]

A SymbolicConstant specifying the transformation to apply to the PrimaryVariable. Possible values are DEFAULT, NODAL, USER_SPECIFIED, ANGULAR, and LAYUP_ORIENTATION. The default value is DEFAULT.If transformationType = NODAL, Abaqus will transform nodal vector fields into any orientation defined in the analysis with the TRANSFORM option. Setting transformationType = NODAL has no effect on element-based results.If transformationType = USER_SPECIFIED, Abaqus will transform tensor and vector fields into the coordinate system specified by datumCsys.If transformationType = LAYUP_ORIENTATION, Abaqus will transform tensor and vector fields into the layup orientation defined in the composite section. The odb should contain the field SORIENT in order to use this option.

useRegionBoundaries : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to use region boundaries when averaging. The default value is ON.

userRegions : --is-rst--:py:class:`tuple` = ()[source]

A tuple of Strings specifying either element set or display group names (depending on the value of regionBoundaries) defining the averaging region boundaries. The default value is an empty sequence.

class CouplingConstraint[source]

Bases: object

The CouplingConstraint object.

Note

This object can be accessed by:

import visualization
session.odbData[name].kinematicCouplings[i]
session.odbData[name].distributingCouplings[i]
session.odbData[name].shellSolidCouplings[i]

Note

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

Member Details:

constraintData()[source]

This method returns node numbers of the surface being controlled by the control point.

Return type:

Tuple-of-Ints Dictionary specifying the node numbers on the controlled surface.

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the coupling name. This attribute is read-only.

type : --is-rst--:py:class:`str` = ''[source]

A String specifying the type of coupling. This attribute is read-only.

class DGCommonOptions[source]

Bases: object

The DGCommonOptions object stores values and attributes that are common to all plot states. The DGCommonOptions object has no constructor command. Abaqus creates an odbDisplayOptions.commonOptions member when a display group instance is created, using values from odbDisplay.commonOptions.

Note

This object can be accessed by:

session.viewports[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.commonOptions
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.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.displayGroupInstances[name].odbDisplayOptions.commonOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.commonOptions

Note

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

Member Details:

beamN1Color : --is-rst--:py:class:`str` = ''[source]

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

beamN2Color : --is-rst--:py:class:`str` = ''[source]

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

beamTangentColor : --is-rst--:py:class:`str` = ''[source]

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

colorCodeOverride : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

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.

coordinateScale : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

coordinateScaleFactors : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]

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

edgeColorFillShade : --is-rst--:py:class:`str` = ''[source]

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

edgeColorWireHide : --is-rst--:py:class:`str` = ''[source]

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

edgeLineStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLID'[source]

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

edgeLineThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

elemLabelColor : --is-rst--:py:class:`str` = ''[source]

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

elemLabels : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

elementShrink : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

elementShrinkFactor : --is-rst--:py:class:`int` = 5[source]

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

faceLabelColor : --is-rst--:py:class:`str` = ''[source]

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

faceLabels : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

faceNormalColor : --is-rst--:py:class:`str` = ''[source]

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

fillColor : --is-rst--:py:class:`str` = ''[source]

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

labelFont : --is-rst--:py:class:`str` = ''[source]

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

nodeLabelColor : --is-rst--:py:class:`str` = ''[source]

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

nodeLabels : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

nodeSymbolColor : --is-rst--:py:class:`str` = ''[source]

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

nodeSymbolSize : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SMALL'[source]

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

nodeSymbolType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'HOLLOW_CIRCLE'[source]

A SymbolicConstant specifying the node symbol types. Possible values are:FILLED_CIRCLEFILLED_SQUAREFILLED_DIAMONDFILLED_TRIHOLLOW_CIRCLEHOLLOW_SQUAREHOLLOW_DIAMONDHOLLOW_TRICROSSXMARKERThe default value is HOLLOW_CIRCLE.

nodeSymbols : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

normalArrowLength : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MEDIUM'[source]

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

normalArrowheadStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'WIRE'[source]

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

normalDisplay : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ELEMENT'[source]

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

normalLineThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

normals : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

renderStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SHADED'[source]

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

translucency : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

translucencyFactor : --is-rst--:py:class:`float` = 0[source]

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

visibleEdges : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'EXTERIOR'[source]

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.

class DGContourOptions[source]

Bases: object

The DGContourOptions object stores values and attributes associated with a contour plot. The DGContourOptions object has no constructor command. Abaqus creates an odbDisplayOptions.contourOptions member when a display group instance is created, using values from odbDisplay.contourOptions.

Note

This object can be accessed by:

session.viewports[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.contourOptions
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.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.displayGroupInstances[name].odbDisplayOptions.contourOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.contourOptions

Note

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

Member Details:

averagedOrientationDisplay : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying the display of the nodal averaged coordinate systems used when averaging element vector or tensor data. The default value is OFF.

colorByMatchingPlies : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the contour color is driven by the matching ply. The default value is OFF.

contourEdgeColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the color to be used to plot the contour edges when contourType = BANDED or ISOSURFACE. The default value is “Grey60”.

contourEdgeStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLID'[source]

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

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.

contourEdges : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to plot the edges of each contour interval when contourType = BANDED or ISOSURFACE. The default value is OFF.

contourMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'TEXTURE_MAPPED'[source]

A SymbolicConstant specifying the contour rendering method. Possible values are TEXTURE_MAPPED and TESSELLATED. The default value is TEXTURE_MAPPED.

contourStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'UNIFORM'[source]

A SymbolicConstant specifying the interval style of the contour plot. Possible values are CONTINUOUS and UNIFORM. The default value is UNIFORM.

edgeColorBandedQuilt : --is-rst--:py:class:`str` = ''[source]

A String specifying the edge color to be used when contourType = BANDED or QUILT. The default value is “Black”.

edgeColorLine : --is-rst--:py:class:`str` = ''[source]

A String specifying the edge color to be used when contourType = LINE. The default value is “White”.

intervalLineAttributes : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]

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), ).

matchingPlyLabels : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the label for the matching ply shows up in the viewport. The default value is OFF.

tickmarkAxisLength : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MEDIUM'[source]

A SymbolicConstant specifying the length of the tick mark plot axes. Possible values are SHORT, MEDIUM, and LONG. The default value is MEDIUM.

tickmarkBaseValue : --is-rst--:py:class:`float` = 0[source]

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.

tickmarkCurveColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the color to be used to plot the tick mark curve. The default value is “Cyan”.

tickmarkOrientation : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'N2'[source]

A SymbolicConstant specifying the orientation of the tick mark plots. Possible values are N1 and N2. The default value is N2.

tickmarkPlots : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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.

class DGDisplayBodyOptions[source]

Bases: object

The DGDisplayBodyOptions object stores values and attributes applied to display bodies. The DGDisplayBodyOptions object has no constructor command. Abaqus creates an odbDisplayOptions.displayBodyOptions member when a display group instance is created, using values from odbDisplay.displayBodyOptions.

Note

This object can be accessed by:

session.viewports[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.displayBodyOptions
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions.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.displayGroupInstances[name].odbDisplayOptions.displayBodyOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.displayBodyOptions

Note

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

Member Details:

colorCodeOverride : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

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.

coordinateScale : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

coordinateScaleFactors : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]

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

edgeColorFillShade : --is-rst--:py:class:`str` = ''[source]

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

edgeColorWireHide : --is-rst--:py:class:`str` = ''[source]

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

edgeLineStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLID'[source]

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

edgeLineThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

elementShrink : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

elementShrinkFactor : --is-rst--:py:class:`int` = 5[source]

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

fillColor : --is-rst--:py:class:`str` = ''[source]

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

translucency : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

translucencyFactor : --is-rst--:py:class:`float` = 0[source]

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

visibleEdges : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'EXTERIOR'[source]

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.

class DGOrientationOptions[source]

Bases: object

The DGOrientationOptions object stores values and attributes associated with a material orientation plot. The DGOrientationOptions object has no constructor command. Abaqus creates an odbDisplayOptions.materialOrientationOptions member when a display group instance is created, using values from odbDisplay.materialOrientationOptions.

Note

This object can be accessed by:

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].partDisplay.displayGroupInstances[name].odbDisplayOptions.materialOrientationOptions
session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.materialOrientationOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.materialOrientationOptions

Note

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

Member Details:

arrowheadStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]

A SymbolicConstant specifying the arrowhead style for the material orientation triad. Possible values are NONE, FILLED, and WIRE. The default value is NONE.

axis1Color : --is-rst--:py:class:`str` = ''[source]

A String specifying the color of axis 1 of the material orientation triad. The default value is “Cyan”.

axis2Color : --is-rst--:py:class:`str` = ''[source]

A String specifying the color of axis 2 of the material orientation triad. The default value is “Yellow”.

axis3Color : --is-rst--:py:class:`str` = ''[source]

A String specifying the color of axis 3 of the material orientation triad. The default value is “Red”.

lineThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

A SymbolicConstant specifying the orientation used for composites. Possible values are PLY and LAYUP. The default value is PLY.

scaleMode : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MODEL_SIZE'[source]

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.

showAxis1 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether axis 1 of the material orientation triad should be displayed. The default value is ON.

showAxis2 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether axis 2 of the material orientation triad should be displayed. The default value is ON.

showAxis3 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether axis 3 of the material orientation triad should be displayed. The default value is ON.

symbolSize : --is-rst--:py:class:`float` = 6[source]

A Float specifying the size of the material orientation triad. The default value is 6.0.

class DGSuperimposeOptions[source]

Bases: object

The DGSuperimposeOptions object stores values and attributes associated with the undeformed shape when the display contains both the deformed shape and the undeformed shape. The DGSuperimposeOptions object has no constructor command. Abaqus creates an odbDisplayOptions.superimposeOptions member when a display group instance is created, using values from odbDisplay.superimposeOptions.

Note

This object can be accessed by:

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].partDisplay.displayGroupInstances[name].odbDisplayOptions.superimposeOptions
session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.superimposeOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.superimposeOptions

Note

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

Member Details:

beamN1Color : --is-rst--:py:class:`str` = ''[source]

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

beamN2Color : --is-rst--:py:class:`str` = ''[source]

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

beamTangentColor : --is-rst--:py:class:`str` = ''[source]

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

colorCodeOverride : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

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.

coordinateScale : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

coordinateScaleFactors : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]

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

edgeColorFillShade : --is-rst--:py:class:`str` = ''[source]

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

edgeColorWireHide : --is-rst--:py:class:`str` = ''[source]

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

edgeLineStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLID'[source]

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

edgeLineThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

elemLabelColor : --is-rst--:py:class:`str` = ''[source]

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

elemLabels : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

elementShrink : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

elementShrinkFactor : --is-rst--:py:class:`int` = 5[source]

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

faceLabelColor : --is-rst--:py:class:`str` = ''[source]

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

faceLabels : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

faceNormalColor : --is-rst--:py:class:`str` = ''[source]

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

fillColor : --is-rst--:py:class:`str` = ''[source]

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

labelFont : --is-rst--:py:class:`str` = ''[source]

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

nodeLabelColor : --is-rst--:py:class:`str` = ''[source]

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

nodeLabels : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

nodeSymbolColor : --is-rst--:py:class:`str` = ''[source]

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

nodeSymbolSize : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SMALL'[source]

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

nodeSymbolType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'HOLLOW_CIRCLE'[source]

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.

nodeSymbols : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

normalArrowLength : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MEDIUM'[source]

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

normalArrowheadStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'WIRE'[source]

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

normalDisplay : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ELEMENT'[source]

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

normalLineThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

normals : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

renderStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'WIREFRAME'[source]

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

translucency : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

translucencyFactor : --is-rst--:py:class:`float` = 0[source]

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

visibleEdges : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'FEATURE'[source]

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.

class DGSymbolOptions[source]

Bases: object

The DGSymbolOptions object stores values and attributes associated with a symbol plot. The DGSymbolOptions object has no constructor command. Abaqus creates an odbDisplayOptions.symbolOptions member when a display group instance is created, using values from odbDisplay.symbolOptions.

Note

This object can be accessed by:

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].partDisplay.displayGroupInstances[name].odbDisplayOptions.symbolOptions
session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions.symbolOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions.symbolOptions

Note

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

Member Details:

arrowScaleMode : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MODEL_SIZE'[source]

A SymbolicConstant specifying the arrow scaling mode. Possible values are MODEL_SIZE and SCREEN_SIZE. The default value is MODEL_SIZE.

arrowSymbolSize : --is-rst--:py:class:`int` = 6[source]

An Int specifying the length of vector and tensor symbols. The default value is 6.

constantLengthArrows : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to use constant-length arrows for vector symbols. The default value is OFF.

drawLabelT : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to draw tensor labels. The default value is OFF.

drawLabelV : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to draw vector labels. The default value is OFF.

numDigitsT : --is-rst--:py:class:`int` = 2[source]

An Int specifying the number of digits in the tensor label. The default value is 2.

numDigitsV : --is-rst--:py:class:`int` = 2[source]

An Int specifying the number of digits in the vector label. The default value is 2.

numberFormatT : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SCIENTIFIC'[source]

A SymbolicConstant specifying the number format for tensor. Possible values are SCIENTIFIC, FIXED, and ENGINEERING. The default value is SCIENTIFIC.

numberFormatV : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SCIENTIFIC'[source]

A SymbolicConstant specifying the number format for vector. Possible values are SCIENTIFIC, FIXED, and ENGINEERING. The default value is SCIENTIFIC.

symbolDensity : --is-rst--:py:class:`float` = 1[source]

A Float specifying the factor for randomized sampling. The default value is 1.0.

tensorArrowheadStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'WIRE'[source]

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

tensorColorMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SPECTRUM'[source]

A SymbolicConstant specifying the tensor color method. Possible values are UNIFORM and SPECTRUM. The default value is SPECTRUM.

tensorColorSpectrum : --is-rst--:py:class:`str` = ''[source]

A String specifying the tensor color spectrum name. The default value is “Rainbow”.

tensorIntervalNumber : --is-rst--:py:class:`int` = 12[source]

An Int specifying the number of color intervals for tensor symbols. The default value is 12.

tensorLineThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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.

tensorMaxPrinColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the color of the maximum principal tensor symbols. The default value is “Red”.

tensorMidPrinColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the color of the intermediate principal tensor symbols. The default value is “Yellow”.

tensorMinPrinColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the color of the minimum principal tensor symbols. The default value is “Cyan”.

tensorSelectedPrinColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the color of the selected principal tensor symbols. The default value is “Red”.

textColorT : --is-rst--:py:class:`str` = ''[source]

A String specifying the text color for tensor. The default value is “Yellow”.

textColorV : --is-rst--:py:class:`str` = ''[source]

A String specifying the text color for vector. The default value is “Yellow”.

textFontT : --is-rst--:py:class:`str` = ''[source]

A String specifying the text font for tensor. The default value is “verdana”.

textFontV : --is-rst--:py:class:`str` = ''[source]

A String specifying the text font for vector. The default value is “verdana”.

vectorArrowheadStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'WIRE'[source]

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

vectorColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the vector color. The default value is “Red”.

vectorColorMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SPECTRUM'[source]

A SymbolicConstant specifying the vector color method. Possible values are UNIFORM and SPECTRUM. The default value is SPECTRUM.

vectorColorSpectrum : --is-rst--:py:class:`str` = ''[source]

A String specifying the vector color spectrum name. The default value is “Rainbow”.

vectorIntervalNumber : --is-rst--:py:class:`int` = 12[source]

An Int specifying the number of color intervals for vector symbols. The default value is 12.

vectorLineThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

class DetailPlotOptions[source]

Bases: object

The DetailPlotOptions object stores values and attributes associated with a Viewport object. The DetailPlotOptions object has no constructor command. Abaqus creates the detailPlotOptions member whenever a Viewport is created.

Note

This object can be accessed by:

session.viewports[name].detailPlotOptions

Note

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

Member Details:

plyStackPlotOptions : --is-rst--:py:class:`~abaqus.PlotOptions.PlyStackPlotOptions.PlyStackPlotOptions` = <abaqus.PlotOptions.PlyStackPlotOptions.PlyStackPlotOptions object>[source]

A PlyStackPlotOptions object.

class PlyStackPlotOptions[source]

Bases: _OptionsBase

The PlyStackPlotOptions object stores values and attributes associated with aViewport object. The PlyStackPlotOptions object has no constructor command. Abaqus creates the detailPlotOptions.plyStackPlotPlotOptions member whenever a Viewport is created.

Note

This object can be accessed by:

session.viewports[name].detailPlotOptions.plyStackPlotOptions

Note

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

Member Details:

allLabelsFont : --is-rst--:py:class:`str` = ''[source]

A String specifying the font for all the labels. The default value is “--verdana-medium-r-normal---80---p---” on Windows and “--verdana-medium-r-normal---90---p---” on Linux platforms. The default value is an empty string.

edgeStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLID'[source]

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

edgeThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

evenNumPlyColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the ply color for the even numbered plies. The numbering is based on the displayed plies and not on the actual ply number in the layup. The default value is “#A2B3FF”.

fiberColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the fiber color. The default value is “Red”.

fiberSpacing : --is-rst--:py:class:`float` = 0.1[source]

A Float specifying the spacing between the fibers. The default value is 0.1.

fiberStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLID'[source]

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

fiberThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

intPointsColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the through thickness integration points color. The default value is “Blue”.

materialNamesColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the material names text color. The default value is “Green”.

numLayers : --is-rst--:py:class:`int` = 30[source]

An Int specifying the number of plies to show. The default value is 30.

oddNumPlyColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the ply color for the odd numbered plies. The numbering is based on the displayed plies and not on the actual ply number in the layup. The default value is “#ECC9AD”.

orientationNamesColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the orientation names fiber angles text color. The default value is “Orange”.

plyDisplay : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'UNSYMMETRIC'[source]

A SymbolicConstant specifying whether to display the plies in an unsymmetric staircase fashion or symmetric staircase fashion. Possible values are UNSYMMETRIC and SYMMETRIC. The default value is UNSYMMETRIC.

plyNamesColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the ply names text color. The default value is “Yellow”.

referenceOutlineColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the reference outline color. The default value is “Red”.

referenceOutlineStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLID'[source]

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

referenceOutlineThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

referenceSurfaceColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the reference surface color. The default value is “White”.

renderStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SHADED'[source]

A SymbolicConstant specifying how the plies in the viewport are rendered. Possible values are WIRE_FRAME, FILLED, and SHADED. The default value is SHADED.

setValues(
*,
renderStyle=SHADED,
showEdges=0,
edgeStyle=SOLID,
edgeThickness=VERY_THIN,
plyDisplay=UNSYMMETRIC,
startLayer=1,
numLayers=30,
evenNumPlyColor='',
oddNumPlyColor='',
showFibers=1,
fiberColor='',
fiberStyle=SOLID,
fiberThickness=VERY_THIN,
fiberSpacing=0.1,
showReferencePlane=0,
referenceSurfaceColor='',
translucency=0,
translucencyFactor=0.3,
translucencySort=0,
showReferenceOutline=0,
referenceOutlineColor='',
referenceOutlineStyle=SOLID,
referenceOutlineThickness=VERY_THIN,
allLabelsFont='',
showMaterialNames=0,
materialNamesColor='',
showOrientationNames=0,
orientationNamesColor='',
showStateBlock=1,
stateBlockColor='',
showPlyNames=1,
plyNamesColor='',
showThicknessLabels=1,
thicknessLabelsColor='',
showIntPoints=0,
intPointsColor='',
sizeX=1.5,
sizeY=1.0,
sizeZ=0.8,
)[source]

This method modifies the PlyStackPlotOptions object.

Note

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

Parameters:
renderStyle=SHADED

A SymbolicConstant specifying how the plies in the viewport are rendered. Possible values are WIRE_FRAME, FILLED, and SHADED. The default value is SHADED.

showEdges=0

A Boolean specifying whether to draw the edges for the plies. The default value is OFF.

edgeStyle=SOLID

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

edgeThickness=VERY_THIN

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

plyDisplay=UNSYMMETRIC

A SymbolicConstant specifying whether to display the plies in an unsymmetric staircase fashion or symmetric staircase fashion. Possible values are UNSYMMETRIC and SYMMETRIC. The default value is UNSYMMETRIC.

startLayer=1

An Int specifying the start ply. The default value is 1.

numLayers=30

An Int specifying the number of plies to show. The default value is 30.

evenNumPlyColor=''

A String specifying the ply color for the even numbered plies. The numbering is based on the displayed plies and not on the actual ply number in the layup. The default value is “#A2B3FF”.

oddNumPlyColor=''

A String specifying the ply color for the odd numbered plies. The numbering is based on the displayed plies and not on the actual ply number in the layup. The default value is “#ECC9AD”.

showFibers=1

A Boolean specifying whether to show the fibers. The default value is ON.

fiberColor=''

A String specifying the fiber color. The default value is “Red”.

fiberStyle=SOLID

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

fiberThickness=VERY_THIN

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

fiberSpacing=0.1

A Float specifying the spacing between the fibers. The default value is 0.1.

showReferencePlane=0

A Boolean specifying whether to show the reference surface. The default value is OFF.

referenceSurfaceColor=''

A String specifying the reference surface color. The default value is “White”.

translucency=0

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

translucencyFactor=0.3

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

translucencySort=0

A Boolean specifying whether to use depth sorting. The default value is OFF.

showReferenceOutline=0

A Boolean specifying whether to show the reference outline. The default value is OFF.

referenceOutlineColor=''

A String specifying the reference outline color. The default value is “Red”.

referenceOutlineStyle=SOLID

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

referenceOutlineThickness=VERY_THIN

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

allLabelsFont=''

A String specifying the font for all the labels. The default value is “--verdana-medium-r-normal---80---p---” on Windows and “--verdana-medium-r-normal---90---p---” on Linux platforms. The default value is an empty string.

showMaterialNames=0

A Boolean specifying whether to show the material names. The default value is OFF.

materialNamesColor=''

A String specifying the material names text color. The default value is “Green”.

showOrientationNames=0

A Boolean specifying whether to show the orientation names or the fiber angles. The default value is OFF.

orientationNamesColor=''

A String specifying the orientation names fiber angles text color. The default value is “Orange”.

showStateBlock=1

A Boolean specifying whether to show the state block. The default value is ON.

stateBlockColor=''

A String specifying the state block text color. The default value is “White”.

showPlyNames=1

A Boolean specifying whether to show the ply names. The default value is ON.

plyNamesColor=''

A String specifying the ply names text color. The default value is “Yellow”.

showThicknessLabels=1

A Boolean specifying whether to show the thickness labels. The default value is ON.

thicknessLabelsColor=''

A String specifying the thickness labels text color. The default value is “Red”.

showIntPoints=0

A Boolean specifying whether to show the through thickness integration points. The default value is OFF.

intPointsColor=''

A String specifying the through thickness integration points color. The default value is “Blue”.

sizeX=1.5

A Float specifying the size of the ply in the X-direction. The default value is 1.5.

sizeY=1.0

A Float specifying the size of the ply in the Y-direction. The default value is 1.0.

sizeZ=0.8

A Float specifying the size of the ply in the Z-direction. The default value is 0.8.

showEdges : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to draw the edges for the plies. The default value is OFF.

showFibers : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to show the fibers. The default value is ON.

showIntPoints : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to show the through thickness integration points. The default value is OFF.

showMaterialNames : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to show the material names. The default value is OFF.

showOrientationNames : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to show the orientation names or the fiber angles. The default value is OFF.

showPlyNames : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to show the ply names. The default value is ON.

showReferenceOutline : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to show the reference outline. The default value is OFF.

showReferencePlane : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to show the reference surface. The default value is OFF.

showStateBlock : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to show the state block. The default value is ON.

showThicknessLabels : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to show the thickness labels. The default value is ON.

sizeX : --is-rst--:py:class:`float` = 1.5[source]

A Float specifying the size of the ply in the X-direction. The default value is 1.5.

sizeY : --is-rst--:py:class:`float` = 1.0[source]

A Float specifying the size of the ply in the Y-direction. The default value is 1.0.

sizeZ : --is-rst--:py:class:`float` = 0.8[source]

A Float specifying the size of the ply in the Z-direction. The default value is 0.8.

startLayer : --is-rst--:py:class:`int` = 1[source]

An Int specifying the start ply. The default value is 1.

stateBlockColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the state block text color. The default value is “White”.

thicknessLabelsColor : --is-rst--:py:class:`str` = ''[source]

A String specifying the thickness labels text color. The default value is “Red”.

translucency : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

translucencyFactor : --is-rst--:py:class:`float` = 0.3[source]

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

translucencySort : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to use depth sorting. The default value is OFF.

class DisplayOptions[source]

Bases: _CopyOptionsBase

The DisplayOptions object stores a plot state.

Note

This object can be accessed by:

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

Note

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

Member Details:

plotState : --is-rst--:py:class:`tuple`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:data:`...<Ellipsis>`] = (UNDEFORMED,)[source]

A tuple of SymbolicConstants specifying the plot state of the display. Possible values are UNDEFORMED, DEFORMED, CONTOURS_ON_UNDEF, CONTOURS_ON_DEF, SYMBOLS_ON_UNDEF, SYMBOLS_ON_DEF, ORIENT_ON_UNDEF, and ORIENT_ON_DEF. The default value is (UNDEFORMED).

setValues(options=None, plotState=(UNDEFORMED,))[source]

This method modifies the DisplayOptions object.

Note

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

Parameters:
options=None

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

plotState=(UNDEFORMED,)

A sequence of SymbolicConstants specifying the plot state of the display. Possible values are UNDEFORMED, DEFORMED, CONTOURS_ON_UNDEF, CONTOURS_ON_DEF, SYMBOLS_ON_UNDEF, SYMBOLS_ON_DEF, ORIENT_ON_UNDEF, and ORIENT_ON_DEF. The default value is (UNDEFORMED).

class FreeBodyOptions[source]

Bases: _OptionsBase

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

Note

This object can be accessed by:

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

Note

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

Member Details:

setValues(
*,
comp1ColorF='',
comp1ColorM='',
comp2ColorF='',
comp2ColorM='',
comp3ColorF='',
comp3ColorM='',
resultantColorF='',
resultantColorM='',
textColorF='',
textColorM='',
textFontF='',
textFontM='',
numberFormatF=SCIENTIFIC,
numberFormatM=SCIENTIFIC,
scaleModeF=MODEL_SIZE,
scaleModeM=MODEL_SIZE,
vectorDisplay=RESULTANT,
numDigitsF=3,
numDigitsM=3,
sizePercentageF=10,
sizePercentageM=10,
thresholdF=None,
thresholdM=None,
drawLabelF=1,
drawLabelM=1,
showComp1F=1,
showComp1M=1,
showComp2F=1,
showComp2M=1,
showComp3F=1,
showComp3M=1,
showForce=1,
showMoment=1,
constantLengthArrow=0,
)[source]

This method modifies the FreeBodyOptions object.

Note

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

Parameters:
comp1ColorF=''

A String specifying color of the first force component. The default value is “#FF1932”.

comp1ColorM=''

A String specifying color of the first moment component. The default value is “#0000FF”.

comp2ColorF=''

A String specifying color of the second force component. The default value is “#FF1932”.

comp2ColorM=''

A String specifying color of the second moment component. The default value is “#0000FF”.

comp3ColorF=''

A String specifying color of the third force component. The default value is “#FF1932”.

comp3ColorM=''

A String specifying color of the third moment component. The default value is “#0000FF”.

resultantColorF=''

A String specifying color of the resultant force. The default value is “#FF1932”.

resultantColorM=''

A String specifying color of the resultant moment. The default value is “#0000FF”.

textColorF=''

A String specifying text color for force. The default value is “Yellow”.

textColorM=''

A String specifying text color for moment. The default value is “Yellow”.

textFontF=''

A String specifying text font for force. The default value is “verdana”.

textFontM=''

A String specifying text font for moment. The default value is “verdana”.

numberFormatF=SCIENTIFIC

A SymbolicConstant specifying the number format for force. Possible values are SCIENTIFIC, FIXED, and ENGINEERING. The default value is SCIENTIFIC.

numberFormatM=SCIENTIFIC

A SymbolicConstant specifying the number format for moment. Possible values are SCIENTIFIC, FIXED, and ENGINEERING. The default value is SCIENTIFIC.

scaleModeF=MODEL_SIZE

A SymbolicConstant specifying the size scaling mode for force. Possible values are MODEL_SIZE and SCREEN_SIZE. The default value is MODEL_SIZE.

scaleModeM=MODEL_SIZE

A SymbolicConstant specifying the size scaling mode for moment. Possible values are MODEL_SIZE and SCREEN_SIZE. The default value is MODEL_SIZE.

vectorDisplay=RESULTANT

A SymbolicConstant specifying the vector display mode. Possible values are RESULTANT and COMPONENT. The default value is RESULTANT.

numDigitsF=3

An Int specifying the number of digits in the force label. The default value is 3.

numDigitsM=3

An Int specifying the number of digits in the moment label. The default value is 3.

sizePercentageF=10

A Float specifying the size of the force symbol as a percentage of the screen or model. The default value is 10.0.

sizePercentageM=10

A Float specifying the size of the moment symbol as a percentage of the screen or model. The default value is 10.0.

thresholdF=None

A Float specifying the force threshold value. The default value is 10⁻⁶.

thresholdM=None

A Float specifying the moment threshold value. The default value is 10⁻⁶.

drawLabelF=1

A Boolean specifying whether to draw force labels. The default value is ON.

drawLabelM=1

A Boolean specifying whether to draw moment labels. The default value is ON.

showComp1F=1

A Boolean specifying whether to show the first force component. The default value is ON.

showComp1M=1

A Boolean specifying whether to show the first moment component. The default value is ON.

showComp2F=1

A Boolean specifying whether to show the second force component. The default value is ON.

showComp2M=1

A Boolean specifying whether to show the second moment component. The default value is ON.

showComp3F=1

A Boolean specifying whether to show the third force component. The default value is ON.

showComp3M=1

A Boolean specifying whether to show the third moment component. The default value is ON.

showForce=1

A Boolean specifying whether to show forces. The default value is ON.

showMoment=1

A Boolean specifying whether to show moments. The default value is ON.

constantLengthArrow=0

A Boolean specifying whether to use a constant length for all arrows. The default value is OFF.

class HistoryVariable[source]

Bases: object

The HistoryVariable object stores history data.

Note

This object can be accessed by:

import visualization
session.odbData[name].historyVariables[i]

Note

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

Member Details:

legendLabel : --is-rst--:py:class:`str` = ''[source]

A String specifying the legend text. This String is read-only.

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the history request label. This String is read-only.

steps : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]

A tuple of (String, Int, SymbolicConstant) tuples specifying the steps. This sequence is read-only. Each inner sequence contains the following elements:stepLabel: A String specifying the step label. stepNumber: An Int specifying the step number. procedureDomain: A SymbolicConstant specifying the analysis type of the step, which can have these values: “TIME,” “FREQUENCY,” or “MODAL.”

class MdbData[source]

Bases: object

The MdbData object has no constructor. Abaqus creates an MdbData object when a cae file is opened or a new model is created. There is one MdbData for each model in session. MdbData is updated when it is displayed in a viewport.

Note

This object can be accessed by:

import visualization
session.mdbData[name]

Note

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

Member Details:

instances : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.MdbDataInstance.MdbDataInstance`] = {}[source]

A repository of MdbDataInstance objects specifying the list of instances. The repository is read-only.

stepPeriods : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]

A tuple of (String, Float) tuples specifying the stepName and the stepPeriod.

steps : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.MdbDataStep.MdbDataStep`] = {}[source]

A repository of MdbDataStep objects specifying the list of steps. The repository is read-only.

class MdbDataInstance[source]

Bases: object

The MdbDataInstance object instance data. It corresponds to same named part instance with a mesh in the cae model.

Note

This object can be accessed by:

import visualization
session.mdbData[name].instances[i]

Note

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

Member Details:

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the instance name. This attribute is read-only.

class MdbDataStep[source]

Bases: object

The MdbDataStep object.It corresponds to same named step in the cae model.

Note

This object can be accessed by:

import visualization
session.mdbData[name].steps[i]

Note

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

Member Details:

frames : --is-rst--:py:class:`~typing.List`\ \[:py:class:`~abaqus.PlotOptions.MdbDataFrame.MdbDataFrame`] = [][source]

A MdbDataFrameArray object specifying the list of frames. The list is read-only. There is only one frame in a step.

class MdbDataFrame[source]

Bases: object

The MdbDataFrame object. There is one and only MdbDataFrame in a MdbDataStep.

Note

This object can be accessed by:

import visualization
session.mdbData[name].steps[i].frames[i]

Note

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

Member Details:

class MpcConstraint[source]

Bases: object

The MpcConstraint object.

Note

This object can be accessed by:

import visualization
session.odbData[name].multiPointConstraints[i]

Note

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

Member Details:

constraintData()[source]

This method returns constraint data if any are associated with the object.

Returns:

A tuple containing coordinates of the nodes pertaining to the constraint.

Return type:

Sequence[float]

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the multipoint constraint name. This attribute is read-only.

class OdbAnalysisError[source]

Bases: object

The OdbAnalysisError object stores the description of different errors encountered during the analysis.

Note

This object can be accessed by:

import visualization
session.odbData[name].diagnosticData.analysisErrors[i]

Note

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

Member Details:

attemptNumber : --is-rst--:py:class:`str` = ''[source]

An int specifying the attempt number on which the analysis was aborted. This attribute is read-only.

category : --is-rst--:py:class:`str` = ''[source]

String specifying the category of error. This attribute is read-only.

data : --is-rst--:py:class:`~abaqus.PlotOptions.OdbAuxiliaryData.OdbAuxiliaryData` = <abaqus.PlotOptions.OdbAuxiliaryData.OdbAuxiliaryData object>[source]

An OdbAuxiliaryData object.

description : --is-rst--:py:class:`str` = ''[source]

String specifying the cause of the error. This attribute is read-only.

detailStrings : --is-rst--:py:class:`str` = ''[source]

String specifying the exact nature of the problem. This attribute is read-only.

incrementNumber : --is-rst--:py:class:`str` = ''[source]

An int specifying the increment number where the analysis was aborted. This attribute is read-only.

iterationNumber : --is-rst--:py:class:`str` = ''[source]

An int specifying the iteration number where the analysis was aborted. This attribute is read-only.

knowledgeItem : --is-rst--:py:class:`str` = ''[source]

String specifying the exact reason for the error encountered. This attribute is read-only.

numberOfVariations : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of variations. This attribute is read-only.

stepNumber : --is-rst--:py:class:`str` = ''[source]

An int specifying the step number on which the error was encountered. This attribute is read-only.

class OdbAuxiliaryData[source]

Bases: object

The OdbAuxiliaryData object stores auxiliary data related to the steps in the analysis.

Note

This object can be accessed by:

import visualization
session.odbData[name].diagnosticData.analysisErrors[i].data[i]
session.odbData[name].diagnosticData.analysisWarnings[i].data[i]
session.odbData[name].diagnosticData.steps[i].contactDiagnostics[i].data[i]

Note

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

Member Details:

elementInstanceNames : --is-rst--:py:class:`tuple` = ()[source]

A tuple consisting of element instance names. This attribute is read-only.

elementLabels : --is-rst--:py:class:`tuple` = ()[source]

A tuple consisting of element label names. This attribute is read-only.

hasValues : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether the OdbAuxiliaryData object has values in it. This attribute is read-only.

nodeInstanceNames : --is-rst--:py:class:`tuple` = ()[source]

A tuple consisting of node instance names. This attribute is read-only.

nodeLables : --is-rst--:py:class:`tuple` = ()[source]

A tuple consisting of node label names. This attribute is read-only.

class OdbAnalysisWarning[source]

Bases: object

The OdbAnalysisWarning object stores the description of different warnings encountered during the analysis.

Note

This object can be accessed by:

import visualization
session.odbData[name].diagnosticData.analysisWarnings[i]

Note

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

Member Details:

class OdbContactDiagnostics[source]

Bases: object

The OdbDiagnosticContact object.

Note

This object can be accessed by:

import visualization
session.odbData[name].diagnosticData.steps[i].contactDiagnostics[i]

Note

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

Member Details:

data : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbAuxiliaryData.OdbAuxiliaryData`] = {}[source]

A repository of OdbAuxiliaryData objects. This attribute is read-only.

defaultFormats : --is-rst--:py:class:`str` = ''[source]

A string specifying the default format value. This attribute is read-only.

description : --is-rst--:py:class:`str` = ''[source]

A string specifying the opening/overclosure status of the contact. This attribute is read-only.

detailStrings : --is-rst--:py:class:`tuple` = ()[source]

A sequence of strings specifying the nature of each of the contact pair. This attribute is read-only.

elementDescriptions : --is-rst--:py:class:`str` = ''[source]

A string specifying the element description. This attribute is read-only.

nodeDescriptions : --is-rst--:py:class:`str` = ''[source]

A string specifying the node description. This attribute is read-only.

type : --is-rst--:py:class:`str` = ''[source]

A string specifying the type of contact initialization. This attribute is read-only.

class OdbData[source]

Bases: _OptionsBase

The OdbData object stores non persistent values and attributes associated with an open odb for the given session. The OdbData object has no constructor. Abaqus creates the odbData repository when you import the Visualization module. Abaqus creates a OdbData object when an odb is opened.

Note

This object can be accessed by:

import visualization
session.odbData[name]

Note

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

Member Details:

activeFrames : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]

A tuple specifying the active frames, or the SymbolicConstant ALL. Each item in the sequence is a tuple defining the stepName followed by a sequence of expressions specifying frame numbers. The expression can be any of the following: - An Int specifying a single frame number; for example, 1. - A String specifying a single frame number ; for example, ‘7’. - A String specifying a sequence of frame numbers; for example, ‘3:5’ and ‘3:15:3’. For these expressions a negative number will indicate reverse numbering: -1 is the last frame of the step, -2 is the one before the last frame. Frame numbering starts at 0.

datumCsyses : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDataDatumCsys.OdbDataDatumCsys`] = {}[source]

A repository of OdbDataDatumCsys objects specifying the list of coordinate systems defined in the model. The repository is read-only.

diagnosticData : --is-rst--:py:class:`~abaqus.PlotOptions.OdbDiagnosticData.OdbDiagnosticData` = <abaqus.PlotOptions.OdbDiagnosticData.OdbDiagnosticData object>[source]

An OdbDiagnosticData object.

distributingCouplings : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.CouplingConstraint.CouplingConstraint`] = {}[source]

A repository of CouplingConstraint objects specifying the list of distributing couplings. The repository is read-only.

elementSets : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDataElementSet.OdbDataElementSet`] = {}[source]

A repository of OdbDataElementSet objects specifying the list of element sets. The repository is read-only.

historyVariables : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.HistoryVariable.HistoryVariable`] = {}[source]

A repository of HistoryVariable objects specifying the history request label. The repository is read-only.

instances : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDataInstance.OdbDataInstance`] = {}[source]

A repository of OdbDataInstance objects specifying the list of instances. The repository is read-only.

kinematicCouplings : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.CouplingConstraint.CouplingConstraint`] = {}[source]

A repository of CouplingConstraint objects specifying the list of kinematic couplings. The repository is read-only.

materials : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDataMaterial.OdbDataMaterial`] = {}[source]

A repository of OdbDataMaterial objects specifying the list of materials. The repository is read-only.

multiPointConstraints : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.MpcConstraint.MpcConstraint`] = {}[source]

A repository of MpcConstraint objects specifying the list of multipoint constraints. The repository is read-only.

nodeSets : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDataNodeSet.OdbDataNodeSet`] = {}[source]

A repository of OdbDataNodeSet objects specifying the list of node sets. The repository is read-only.

rigidbodies : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.RigidBodyConstraint.RigidBodyConstraint`] = {}[source]

A repository of RigidBodyConstraint objects specifying the list of rigid body constraints. The repository is read-only.

sections : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDataSection.OdbDataSection`] = {}[source]

A repository of OdbDataSection objects specifying the list of sections. The repository is read-only.

setValues(activeFrames=None, stepPeriods=())[source]

This method modifies the OdbData object.

Note

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

Parameters:
activeFrames=None

A sequence specifying the active frames, or the SymbolicConstant ALL. Each item in the sequence is a tuple defining the stepName followed by a sequence of expressions specifying frame numbers. The expression can be any of the following:An Int specifying a single frame number; for example, 1.A String specifying a single frame number ; for example, ‘7’.A String specifying a sequence of frame numbers; for example, ‘3:5’ and ‘3:15:3’.For these expressions a negative number will indicate reverse numbering: -1 is the last frame of the step, -2 is the one before the last frame. Frame numbering starts at 0.

stepPeriods=()

A sequence of (String, Float) sequences specifying the stepName and the stepPeriod. Alternatively, this member may take the value ODB_VALUES.

shellSolidCouplings : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.CouplingConstraint.CouplingConstraint`] = {}[source]

A repository of CouplingConstraint objects specifying the list of shellsolid couplings. The repository is read-only.

stepPeriods : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]

A tuple of (String, Float) tuples specifying the stepName and the stepPeriod. Alternatively, this member may take the value ODB_VALUES.

steps : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDataStep.OdbDataStep`] = {}[source]

A repository of OdbDataStep objects specifying the list of steps. The repository is read-only.

surfaceSets : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDataSurfaceSet.OdbDataSurfaceSet`] = {}[source]

A repository of OdbDataSurfaceSet objects specifying the list of surface sets. The repository is read-only.

ties : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.TieConstraint.TieConstraint`] = {}[source]

A repository of TieConstraint objects specifying the list of Tie constraints. The repository is read-only.

class OdbDataDatumCsys[source]

Bases: object

The OdbDataDatumCsys object stores coordinate system data.

Note

This object can be accessed by:

import visualization
session.odbData[name].datumCsyses[i]

Note

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

Member Details:

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the coordinate system name. This String is read-only.

origin : --is-rst--:py:class:`tuple` = ()[source]

A tuple of three Floats specifying a sequence of three floats specifying the origin. The default value is (0, 0, 0).

type : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]

A SymbolicConstant specifying the coordinate system type. This String is read-only. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL.

xAxis : --is-rst--:py:class:`tuple` = ()[source]

A tuple of three Floats specifying a sequence of three floats specifying the x-Axis vector. The default value is (1, 0, 0).

yAxis : --is-rst--:py:class:`tuple` = ()[source]

A tuple of three Floats specifying a sequence of three floats specifying the y-Axis vector. The default value is (0, 1, 0).

zAxis : --is-rst--:py:class:`tuple` = ()[source]

A tuple of three Floats specifying a sequence of three floats specifying the z-Axis vector. The default value is (0, 0, 1).

class OdbDataElementSet[source]

Bases: object

The OdbDataElementSet object stores element set data.

Note

This object can be accessed by:

import visualization
session.odbData[name].elementSets[i]

Note

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

Member Details:

elements : --is-rst--:py:class:`str` = ''[source]

A String-to-tuple-of-Ints Dictionary specifying the elements in the set. This attribute is read-only.

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the set name. This attribute is read-only.

class OdbDataInstance[source]

Bases: object

The OdbDataInstance object instance data.

Note

This object can be accessed by:

import visualization
session.odbData[name].instances[i]

Note

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

Member Details:

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the instance name. This attribute is read-only.

class OdbDataMaterial[source]

Bases: object

The OdbDataMaterial object stores material data.

Note

This object can be accessed by:

import visualization
session.odbData[name].materials[i]

Note

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

Member Details:

elements : --is-rst--:py:class:`str` = ''[source]

A String-to-tuple-of-Ints Dictionary specifying the elements in the set. This attribute is read-only.

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the set name. This attribute is read-only.

class OdbDataNodeSet[source]

Bases: object

The OdbDataNodeSet object stores node set data.

Note

This object can be accessed by:

import visualization
session.odbData[name].nodeSets[i]

Note

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

Member Details:

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the set name. This attribute is read-only.

nodes : --is-rst--:py:class:`str` = ''[source]

A String-to-tuple-of-Ints Dictionary specifying the nodes in the set. This attribute is read-only.

class OdbDataSection[source]

Bases: object

The OdbDataSection object stores section data.

Note

This object can be accessed by:

import visualization
session.odbData[name].sections[i]

Note

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

Member Details:

elements : --is-rst--:py:class:`str` = ''[source]

A String-to-tuple-of-Ints Dictionary specifying the elements in the set. This attribute is read-only.

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the set name. This attribute is read-only.

class OdbDataStep[source]

Bases: object

The OdbDataStep object.

Note

This object can be accessed by:

import visualization
session.odbData[name].steps[i]

Note

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

Member Details:

frames : --is-rst--:py:class:`~typing.List`\ \[:py:class:`~abaqus.PlotOptions.OdbDataFrame.OdbDataFrame`] = [][source]

An OdbDataFrameArray object specifying the list of frames. The list is read-only.

setValues(activateFrames, update=0)[source]

This method modifies the OdbDataStep object.

Note

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

Parameters:
activateFrames

A Boolean specifying whether to activate all the frames in the step.

update=0

A Boolean specifying whether to update the model. The default value is ON

class OdbDataSurfaceSet[source]

Bases: object

The OdbDataSurfaceSet object stores surface set data.

Note

This object can be accessed by:

import visualization
session.odbData[name].surfaceSets[i]

Note

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

Member Details:

elements : --is-rst--:py:class:`str` = ''[source]

A String-to-tuple-of-Ints Dictionary specifying the elements in the set. This attribute is read-only.

facets : --is-rst--:py:class:`str` = ''[source]

A String-to-tuple-of-Ints Dictionary specifying the facets corresponding to the elements. This attribute is read-only.

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the set name. This attribute is read-only.

class OdbDiagnosticData[source]

Bases: object

The OdbDiagnosticData object.

Note

This object can be accessed by:

import visualization
session.odbData[name].diagnosticData

Note

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

Member Details:

analysisErrors : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbAnalysisError.OdbAnalysisError`] = {}[source]

A repository of OdbAnalysisError objects.

analysisWarnings : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbAnalysisWarning.OdbAnalysisWarning`] = {}[source]

A repository of OdbAnalysisWarning objects.

isXplDoublePrecision : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether or not double precision is used for the analysis. This attribute is read-only.

jobStatus : --is-rst--:py:class:`str` = ''[source]

A String specifying the job status after the analysis. This attribute is read-only.

jobTime : --is-rst--:py:class:`~abaqus.PlotOptions.OdbJobTime.OdbJobTime` = <abaqus.PlotOptions.OdbJobTime.OdbJobTime object>[source]

An OdbJobTime object.

numDomains : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of domains. This attribute is read-only.

numberOfAnalysisErrors : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of analysis errors encountered. This attribute is read-only.

numberOfAnalysisWarnings : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of analysis warnings encountered. This attribute is read-only.

numberOfSteps : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of steps present in the analysis. This attribute is read-only.

numericalProblemSummary : --is-rst--:py:class:`~abaqus.PlotOptions.OdbNumericalProblemSummary.OdbNumericalProblemSummary` = <abaqus.PlotOptions.OdbNumericalProblemSummary.OdbNumericalProblemSummary object>[source]

An OdbNumericalProblemSummary object.

steps : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDiagnosticStep.OdbDiagnosticStep`] = {}[source]

A repository of OdbDiagnosticStep objects.

class RigidBodyConstraint[source]

Bases: object

The RigidBodyConstraint object.

Note

This object can be accessed by:

import visualization
session.odbData[name].rigidbodies[i]

Note

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

Member Details:

constraintData()[source]

This method returns constraint data if any are associated with the object.

Returns:

A String Value: NONE in the absence of constraint data.

Return type:

str

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the rigidbody constraint name. This attribute is read-only.

class TieConstraint[source]

Bases: object

The TieConstraint object.

Note

This object can be accessed by:

import visualization
session.odbData[name].ties[i]

Note

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

Member Details:

constraintData()[source]

This method returns constraint data if any are associated with the object.

Returns:

A tuple containing coordinates of the nodes pertaining to the constraint.

Return type:

Sequence[float]

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the tie constraint name. This attribute is read-only.

class OdbDataFrame[source]

Bases: object

The OdbDataFrame object.

Note

This object can be accessed by:

import visualization
session.odbData[name].steps[i].frames[i]

Note

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

Member Details:

setValues(activateFrame, update=0)[source]

This method modifies the OdbDataFrame object.

Note

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

Parameters:
activateFrame

A Boolean specifying whether to activate the frame.

update=0

A Boolean specifying whether to update the model. The default value is ON

class OdbDiagnosticAttempt[source]

Bases: object

The OdbDiagnosticAttempt object.

Note

This object can be accessed by:

import visualization
session.odbData[name].diagnosticData.steps[i].increments[i].attempts[i]

Note

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

Member Details:

autoStabilize : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying the state of Auto-stablilization. This attribute is read-only.

isConverged : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying the state of convergence for the attempt. This attribute is read-only.

isCutBack : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying the state of cutback. This attribute is read-only.

needsReordering : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether or not reordering is needed. This attribute is read-only.

numberOfCutbackDiagnostics : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of cutback diagnostics. This attribute is read-only.

numberOfIterations : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of iterations for the particular attempt. This attribute is read-only.

numberOfSevereDiscontinuityIterations : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of iterations with severe discontinuities This attribute is read-only.

size : --is-rst--:py:class:`str` = ''[source]

A float specifying the size of the increment of the particular attempt. This attribute is read-only.

class OdbDiagnosticStep[source]

Bases: object

The OdbDiagnosticStep object stores step data.

Note

This object can be accessed by:

import visualization
session.odbData[name].diagnosticData.steps[i]

Note

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

Member Details:

activeXplStatus : --is-rst--:py:class:`tuple` = ()[source]

A Tuple of the status values. This attribute is read-only.

characteristicElementLength : --is-rst--:py:class:`str` = ''[source]

A float specifying the characteristic element length for the step. This attribute is read-only.

contactDiagnostics : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbContactDiagnostics.OdbContactDiagnostics`] = {}[source]

A repository of OdbContactDiagnostics objects.

explicitIncrementStatus : --is-rst--:py:class:`tuple` = ()[source]

A sequence of string specifying the explicit increment status. This attribute is read-only.

extractData(incrementStatistics)[source]

This method creates a temporary XYData object, with increments on the x-axis and requested output on the y-axis.

Note

Check OdbDiagnosticStep.extractData on help.3ds.com/2024.

Parameters:
incrementStatistics

An enum specifying the requested output variable for the data table. Possible enum values are NUM_ATTEMPTS (the number of attempts), NUM_SDI (the number of severe discontinuity iterations), NUM_EQI (the number of equivalent iterations), NUM_ITERS (the number of iterations), STEP_TIME (the cumulative step time until that increment) or INC_SIZE (the step time for each increment).

extrapolation : --is-rst--:py:class:`str` = ''[source]

A String specifying the method (Linear or logarithmic) used for extrapolation. This attribute is read-only.

incrementationScheme : --is-rst--:py:class:`str` = ''[source]

A String specifying the method of incrementation (Auto or fixed). This attribute is read-only.

increments : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDiagnosticIncrement.OdbDiagnosticIncrement`] = {}[source]

A repository of OdbDiagnosticIncrement objects.

incrementsCompleted : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of completed increments. This attribute is read-only.

initialTimeIncrement : --is-rst--:py:class:`str` = ''[source]

A float specifying the initial increment size for the step. This attribute is read-only.

isNlgeom : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether or not the effects of geometric nonlinearities are considered. This attribute is read-only.

isPerturbation : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether or not the step is a perturbation step. This attribute is read-only.

isRiks : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether the step is static riks. This attribute is read-only.

isStabilized : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether or not stabilization for the system in any form is considered. This attribute is read-only.

isUnsymm : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether the matrix storage is unsymmetric. This attribute is read-only.

matrixSolver : --is-rst--:py:class:`str` = ''[source]

A string specifying the method of solving (Direct or Iterative). This attribute is read-only.

maximumNumberOfIncrements : --is-rst--:py:class:`str` = ''[source]

An int specifying the maximum number of allowed increments in the step. This attribute is read-only.

maximumTimeIncrement : --is-rst--:py:class:`str` = ''[source]

A float specifying the size of the allowed maximum time increment in the step. This attribute is read-only.

minimumTimeIncrement : --is-rst--:py:class:`str` = ''[source]

A float specifying the size of the allowed minimum time increment in the step. This attribute is read-only.

name : --is-rst--:py:class:`str` = ''[source]

A string specifying the name of the step. This attribute is read-only.

number : --is-rst--:py:class:`str` = ''[source]

An int specifying the step number. This attribute is read-only.

numberOfContactDiagnostics : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of contact diagnostics encountered. This attribute is read-only.

numberOfIncrements : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of increments taken in the step to complete the solution. This attribute is read-only.

numberOfXplStatus : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of the explicit status. This attribute is read-only.

stabilizeFactor : --is-rst--:py:class:`str` = ''[source]

A float specifying the stabilize factor. This attribute is read-only.

stepTimeCompleted : --is-rst--:py:class:`str` = ''[source]

A float specifying the time taken for the completion of the step. This attribute is read-only.

timePeriod : --is-rst--:py:class:`str` = ''[source]

A float specifying the duration for the step. This attribute is read-only.

class OdbJobTime[source]

Bases: object

The OdbJobTime object stores the analysis time of a job.

Note

This object can be accessed by:

import visualization
session.odbData[name].diagnosticData.jobTime

Note

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

Member Details:

systemTime : --is-rst--:py:class:`str` = ''[source]

A float specifying the systemtime for the analysis. This attribute is read-only.

userTime : --is-rst--:py:class:`str` = ''[source]

A float specifying the usertime for the analysis. This attribute is read-only.

wallclockTime : --is-rst--:py:class:`str` = ''[source]

A float specifying the wallclocktime for the analysis. This attribute is read-only.

class OdbNumericalProblemSummary[source]

Bases: object

The OdbNumericalProblemSummary object stores the numerical problem summary of a job.

Note

This object can be accessed by:

import visualization
session.odbData[name].diagnosticData.numericalProblemSummary

Note

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

Member Details:

convergedNegativeEigenValues : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether negative eigenvalues converged during the analysis. This attribute is read-only.

convergedNumericalSingularities : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether numerical singularities converged during the analysis. This attribute is read-only.

convergedZeroPivots : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether pivot points converged during the analysis. This attribute is read-only.

numberOfNegativeEigenValues : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of negative eigenvalues. This attribute is read-only.

numberOfNumericalSingularities : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of numerical singularities. This attribute is read-only.

numberOfZeroPivots : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of zero pivots. This attribute is read-only.

class OdbDiagnosticIncrement[source]

Bases: object

The OdbDiagnosticIncrement object.

Note

This object can be accessed by:

import visualization
session.odbData[name].diagnosticData.steps[i].increments[i]

Note

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

Member Details:

attempts : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.PlotOptions.OdbDiagnosticAttempt.OdbDiagnosticAttempt`] = {}[source]

A repository of OdbDiagnosticAttempt objects.

initialSize : --is-rst--:py:class:`str` = ''[source]

A float specifying the size of the initial increment. This attribute is read-only.

isConverged : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A boolean specifying whether the solution converged for the particular increment. This attribute is read-only.

numberOfAttempts : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of attempts for the particular increment. This attribute is read-only.

numberOfElementDiagnostics : --is-rst--:py:class:`str` = ''[source]

An int specifying the number of element diagnostics encountered for the particular increment. This attribute is read-only.

size : --is-rst--:py:class:`str` = ''[source]

A float specifying the size of the particular increment. This attribute is read-only.

stepTimeCompleted : --is-rst--:py:class:`str` = ''[source]

A float specifying the amount of step time completed in the particular increment. This attribute is read-only.

class OdbDisplayOptions[source]

Bases: object

The OdbDisplayOptions object stores the display options associated with an OdbInstance object. This object does not have a constructor. Abaqus creates the OdbDisplayOptions object when an OdbInstance object is created using the display options associated with the current viewport at the time of creation.

Note

This object can be accessed by:

import assembly
session.viewports[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name].odbDisplayOptions
import visualization
session.viewports[name].layers[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions
import part
session.viewports[name].layers[name].partDisplay.displayGroupInstances[name].odbDisplayOptions
session.viewports[name].odbDisplay.displayGroupInstances[name].odbDisplayOptions
session.viewports[name].partDisplay.displayGroupInstances[name].odbDisplayOptions

Note

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

Member Details:

commonOptions : --is-rst--:py:class:`~abaqus.PlotOptions.DGCommonOptions.DGCommonOptions` = <abaqus.PlotOptions.DGCommonOptions.DGCommonOptions object>[source]

A DGCommonOptions object.

contourOptions : --is-rst--:py:class:`~abaqus.PlotOptions.DGContourOptions.DGContourOptions` = <abaqus.PlotOptions.DGContourOptions.DGContourOptions object>[source]

A DGContourOptions object.

displayBodyOptions : --is-rst--:py:class:`~abaqus.PlotOptions.DGDisplayBodyOptions.DGDisplayBodyOptions` = <abaqus.PlotOptions.DGDisplayBodyOptions.DGDisplayBodyOptions object>[source]

A DGDisplayBodyOptions object.

materialOrientationOptions : --is-rst--:py:class:`~abaqus.PlotOptions.DGOrientationOptions.DGOrientationOptions` = <abaqus.PlotOptions.DGOrientationOptions.DGOrientationOptions object>[source]

A DGOrientationOptions object.

superimposeOptions : --is-rst--:py:class:`~abaqus.PlotOptions.DGSuperimposeOptions.DGSuperimposeOptions` = <abaqus.PlotOptions.DGSuperimposeOptions.DGSuperimposeOptions object>[source]

A DGSuperimposeOptions object.

symbolOptions : --is-rst--:py:class:`~abaqus.PlotOptions.DGSymbolOptions.DGSymbolOptions` = <abaqus.PlotOptions.DGSymbolOptions.DGSymbolOptions object>[source]

A DGSymbolOptions object.

class OptionArg(
renderStyle=WIREFRAME,
visibleEdges=FEATURE,
edgeColorWireHide='',
edgeColorFillShade='',
edgeLineStyle=SOLID,
edgeLineThickness=VERY_THIN,
colorCodeOverride=1,
fillColor='',
translucency=0,
translucencyFactor=0,
)[source]

Bases: object

The OptionArg object is used to store values and attributes as a temporary object to be associated with a viewCutOptions object. The OptionArg object has only a constructor command.

Note

This object can be accessed by:

import visualization
session.defaultOdbDisplay.viewCutOptions.aboveOptions
session.defaultOdbDisplay.viewCutOptions.belowOptions
session.defaultOdbDisplay.viewCutOptions.onOptions
session.viewports[name].layers[name].odbDisplay.viewCutOptions.aboveOptions
session.viewports[name].layers[name].odbDisplay.viewCutOptions.belowOptions
session.viewports[name].layers[name].odbDisplay.viewCutOptions.onOptions
session.viewports[name].odbDisplay.viewCutOptions.aboveOptions
session.viewports[name].odbDisplay.viewCutOptions.belowOptions
session.viewports[name].odbDisplay.viewCutOptions.onOptions

Note

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

Member Details:

colorCodeOverride : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

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.

edgeColorFillShade : --is-rst--:py:class:`str` = ''[source]

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

edgeColorWireHide : --is-rst--:py:class:`str` = ''[source]

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

edgeLineStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLID'[source]

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

edgeLineThickness : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'VERY_THIN'[source]

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

fillColor : --is-rst--:py:class:`str` = ''[source]

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

renderStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'WIREFRAME'[source]

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

translucency : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

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

translucencyFactor : --is-rst--:py:class:`float` = 0[source]

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

visibleEdges : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'FEATURE'[source]

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.

class StreamOptions[source]

Bases: _OptionsBase

The StreamOptions object stores values and attributes associated with a stream plot. The StreamOptions object has no constructor command. Abaqus creates a defaultOdbDisplay.streamOptions member when you import the Visualization module. Abaqus creates a StreamOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.streamOptions. Abaqus creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay. StreamOptions objects are accessed in one of two ways:

  • The default stream options. These settings are used as defaults when other streamOptions members are created. These settings can be set to customize user preferences.

  • The stream options associated with a particular viewport.

Note

This object can be accessed by:

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

Note

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

Member Details:

setValues(
*,
colorMethod=UNIFORM,
uniformColor='',
lineThickness=6,
showArrow=0,
numArrows=10,
)[source]

This method modifies the StreamOptions object.

Note

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

Parameters:
colorMethod=UNIFORM

A SymbolicConstant specifying the method for coloring stream lines. Possible values are UNIFORM, SPECTRUM, and CONTINUOUS. The default value is UNIFORM.

uniformColor=''

A String specifying uniform color of the stream lines. The default value is “#FFFF00”.

lineThickness=6

A Float specifying the stream line thickness. The default value is 6.0.

showArrow=0

A Boolean specifying whether to show arrows. The default value is OFF.

numArrows=10

An Int specifying the number of arrows on each stream line. The default value is 10.

class ViewCutOptions[source]

Bases: _CopyOptionsBase

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

Note

This object can be accessed by:

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

Note

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

Member Details:

aboveOptions : --is-rst--:py:class:`str` | :py:obj:`None` = None[source]

None or an OptionArg object specifying values to be used for defining the options applicable on the model above the cut. The default value is None.

belowOptions : --is-rst--:py:class:`str` | :py:obj:`None` = None[source]

None or an OptionArg object specifying values to be used for defining the options applicable on the model below the cut. The default value is None.

componentResolution : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NORMAL_TANGENTIAL'[source]

A SymbolicConstant specifying the component resolution choice for the free body cut. Possible values are NORMAL_TANGENTIAL and CSYS. The default value is NORMAL_TANGENTIAL.

csysName : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'GLOBAL'[source]

The SymbolicConstant GLOBAL or a String specifying the coordinate system name for the free body cut’s component resolution. The default value is GLOBAL.

cutFreeBodyMax : --is-rst--:py:class:`float` = 0[source]

A Float specifying free body maximum value. The default value is 0.0.

cutFreeBodyMin : --is-rst--:py:class:`float` = 0[source]

A Float specifying free body minimum value. The default value is 0.0.

displaySlicing : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to display slicing. The default value is OFF.

freeBodyCutThru : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'CURRENT_DISPLAY_GROUP'[source]

A SymbolicConstant specifying the domain through which the free body cuts. Possible values are CURRENT_DISPLAY_GROUP and WHOLE_MODEL. The default value is CURRENT_DISPLAY_GROUP.

freeBodyStepThru : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ACTIVE_CUT_RANGE'[source]

A SymbolicConstant specifying the domain through which the free body steps. Possible values are ACTIVE_CUT_RANGE and PREDEFINED_PATH. The default value is ACTIVE_CUT_RANGE.

freeBodySumOnPath : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether to put the summation point at the path. The default value is ON.

numCutFreeBody : --is-rst--:py:class:`int` = 1[source]

An Int specifying number of free bodies per view cut. The default value is 1.

onOptions : --is-rst--:py:class:`str` | :py:obj:`None` = None[source]

None or an OptionArg object specifying values to be used for defining the options applicable on the model on the cut. The default value is None.

pathName : --is-rst--:py:class:`str` = ''[source]

A String specifying the name of the path along which slicing occurs. The default value is an empty string.

setValues(
options=None,
*,
belowOptions=None,
useBelowOptions=0,
onOptions=None,
useOnOptions=0,
aboveOptions=None,
useAboveOptions=0,
freeBodyCutThru=CURRENT_DISPLAY_GROUP,
freeBodyStepThru=ACTIVE_CUT_RANGE,
numCutFreeBody=1,
displaySlicing=0,
slicingAtPathNodes=0,
freeBodySumOnPath=1,
cutFreeBodyMin=0,
cutFreeBodyMax=0,
showHeatFlowRate=1,
summationLoc=CENTROID,
componentResolution=NORMAL_TANGENTIAL,
csysName=GLOBAL,
pathName='',
summationPoint=(),
yAxis=(),
)[source]

This method modifies the ViewCutOptions object.

Note

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

Parameters:
options=None

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

belowOptions=None

None or an OptionArg object specifying values to be used for defining the options applicable on the model below the cut. The default value is None.

useBelowOptions=0

A Boolean specifying whether to use the options defined for displaying the model below the cut. The default value is OFF.

onOptions=None

None or an OptionArg object specifying values to be used for defining the options applicable on the model on the cut. The default value is None.

useOnOptions=0

A Boolean specifying whether to use the options defined for displaying the model on the cut. The default value is OFF.

aboveOptions=None

None or an OptionArg object specifying values to be used for defining the options applicable on the model above the cut. The default value is None.

useAboveOptions=0

A Boolean specifying whether to use the options defined for displaying the model above the cut. The default value is OFF.

freeBodyCutThru=CURRENT_DISPLAY_GROUP

A SymbolicConstant specifying the domain through which the free body cuts. Possible values are CURRENT_DISPLAY_GROUP and WHOLE_MODEL. The default value is CURRENT_DISPLAY_GROUP.

freeBodyStepThru=ACTIVE_CUT_RANGE

A SymbolicConstant specifying the domain through which the free body steps. Possible values are ACTIVE_CUT_RANGE and PREDEFINED_PATH. The default value is ACTIVE_CUT_RANGE.

numCutFreeBody=1

An Int specifying number of free bodies per view cut. The default value is 1.

displaySlicing=0

A Boolean specifying whether to display slicing. The default value is OFF.

slicingAtPathNodes=0

A Boolean specifying whether to slice at path nodes. The default value is OFF.

freeBodySumOnPath=1

A Boolean specifying whether to put the summation point at the path. The default value is ON.

cutFreeBodyMin=0

A Float specifying free body minimum value. The default value is 0.0.

cutFreeBodyMax=0

A Float specifying free body maximum value. The default value is 0.0.

showHeatFlowRate=1

A SymbolicConstant specifying whether to show the heat flow rate when available. Possible values are ON and OFF. The default value is ON.

summationLoc=CENTROID

A SymbolicConstant specifying the summation location for the free body cut. Possible values are CENTROID and SPECIFY. The default value is CENTROID.

componentResolution=NORMAL_TANGENTIAL

A SymbolicConstant specifying the component resolution choice for the free body cut. Possible values are NORMAL_TANGENTIAL and CSYS. The default value is NORMAL_TANGENTIAL.

csysName=GLOBAL

The SymbolicConstant GLOBAL or a String specifying the coordinate system name for the free body cut’s component resolution. The default value is GLOBAL.

pathName=''

A String specifying the name of the path along which slicing occurs. The default value is an empty string.

summationPoint=()

A sequence of three Floats specifying the summation point for the free body cut. The default value is (0, 0, 0).

yAxis=()

A sequence of three Floats specifying the Y axis for free body component resolution. The default value is (0, 1, 0).

Raises:

RangeError –

showHeatFlowRate : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A SymbolicConstant specifying whether to show the heat flow rate when available. Possible values are ON and OFF. The default value is ON.

slicingAtPathNodes : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to slice at path nodes. The default value is OFF.

summationLoc : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'CENTROID'[source]

A SymbolicConstant specifying the summation location for the free body cut. Possible values are CENTROID and SPECIFY. The default value is CENTROID.

summationPoint : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]

A tuple of three Floats specifying the summation point for the free body cut. The default value is (0, 0, 0).

useAboveOptions : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to use the options defined for displaying the model above the cut. The default value is OFF.

useBelowOptions : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to use the options defined for displaying the model below the cut. The default value is OFF.

useOnOptions : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether to use the options defined for displaying the model on the cut. The default value is OFF.

yAxis : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]

A tuple of three Floats specifying the Y axis for free body component resolution. The default value is (0, 1, 0).