XY¶

XY commands are used to plot X-Y data and store its display attributes and to write X-Y data to an ASCII file.

Create XY Objects in Session¶

class XYSession[source]¶

Bases: XYSessionBase

Public Data Attributes:

Inherited from SessionBase

`attachedToGui`	A Boolean specifying whether an Abaqus interactive session is running.
`replayInProgress`	A Boolean specifying whether Abaqus is executing a replay file.
`kernelMemoryFootprint`	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
`kernelMemoryMaxFootprint`	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
`kernelMemoryLimit`	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
`colors`	A repository of Color objects.
`journalOptions`	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
`memoryReductionOptions`	A MemoryReductionOptions object specifying options for running in reduced memory mode.
`nodeQuery`	A NodeQuery object specifying nodes and their coordinates in a path.
`sketcherOptions`	A ConstrainedSketcherOptions object specifying common options for all sketches.
`viewerOptions`	A ViewerOptions object.
`animationOptions`	An AnimationOptions object.
`aviOptions`	An AVIOptions object.
`imageAnimationOptions`	An ImageAnimationOptions object.
`imageAnimation`	An ImageAnimation object.
`quickTimeOptions`	A QuickTimeOptions object.
`viewports`	A repository of Viewport objects.
`customData`	A RepositorySupport object.
`defaultFieldReportOptions`	A FieldReportOptions object.
`defaultFreeBodyReportOptions`	A FreeBodyReportOptions object.
`fieldReportOptions`	A FieldReportOptions object.
`freeBodyReportOptions`	A FreeBodyReportOptions object.
`odbs`	A repository of Odb objects.
`scratchOdbs`	A repository of ScratchOdb objects.
`defaultOdbDisplay`	A DefaultOdbDisplay object.
`defaultPlot`	A DefaultPlot object.
`defaultChartOptions`	A DefaultChartOptions object.
`odbData`	A repository of OdbData objects.
`mdbData`	A repository of MdbData objects.
`paths`	A repository of Path objects.
`freeBodies`	A repository of FreeBody objects.
`streams`	A repository of Stream objects.
`spectrums`	A repository of Spectrum objects.
`currentProbeValues`	A CurrentProbeValues object.
`defaultProbeOptions`	A ProbeOptions object.
`probeOptions`	A ProbeOptions object.
`probeReport`	A ProbeReport object.
`defaultProbeReport`	A ProbeReport object.
`selectedProbeValues`	A SelectedProbeValues object.
`printOptions`	A PrintOptions object.
`epsOptions`	An EpsOptions object.
`pageSetupOptions`	A PageSetupOptions object.
`pngOptions`	A PngOptions object.
`psOptions`	A PsOptions object.
`svgOptions`	A SvgOptions object.
`tiffOptions`	A TiffOptions object.
`autoColors`	An AutoColors object specifying the color palette to be used for color coding.
`xyColors`	An AutoColors object specifying the color palette to be used forXYCurve objects.
`xyDataObjects`	A repository of XYData objects.
`curves`	A repository of XYCurve objects.
`xyPlots`	A repository of XYPlot objects.
`charts`	A repository of Chart objects.
`defaultXYReportOptions`	An XYReportOptions object.
`xyReportOptions`	An XYReportOptions object.
`views`	A repository of View objects.
`networkDatabaseConnectors`	A repository of NetworkDatabaseConnector objects.
`displayGroups`	A repository of DisplayGroup objects.
`graphicsInfo`	A GraphicsInfo object.
`defaultGraphicsOptions`	A GraphicsOptions object.
`graphicsOptions`	A GraphicsOptions object.
`defaultViewportAnnotationOptions`	A ViewportAnnotationOptions object.
`queues`	A repository of Queue objects.
`currentViewportName`	A String specifying the name of the current viewport.
`sessionState`	A Dictionary object specifying the viewports and their associated models.
`images`	A repository of Image objects.
`movies`	A repository of Movie objects.
`defaultLightOptions`	A LightOptions object.
`drawingArea`	A DrawingArea object.
`defaultMesherOptions`	A MesherOptions object specifying how to control default settings in the Mesh module.
`drawings`	A repository of Drawing objects.

Public Methods:

`AreaStyle`([color, fill, style])	This method creates an AreaStyle.
`LineStyle`([color, show, style, thickness])	This method creates a LineStyle.
`QuantityType`([label, type])	This method creates a QuantityType object.
`SymbolStyle`([color, show, marker, size])	This method creates a SymbolStyle object.
`TextStyle`([color, show, font, rotationAngle])	This method creates a TextStyle.
`XYData`()
`XYDataFromFile`(fileName[, name, ...])	This method creates an XYData object from data in an ASCII file.
`XYDataFromHistory`(odb, outputVariableName, steps)	This method creates an XYData object by reading history data from an Odb object.
`xyDataListFromField`(odb, outputPosition, ...)	This method creates a list of XYData objects by reading field data from an Odb object.
`XYDataFromFreeBody`(odb[, force, moment, ...])	This method creates a list of XYData objects by computing free body data from an Odb object.
`XYDataFromShellThickness`(odb, ...[, ...])	This method creates a list of XYData objects by reading through the thickness field data from an Odb object.
`XYDataFromPath`(path, name[, ...])	This method creates an XYData object from path information.

Inherited from XYSessionBase

`linearizeStress`(name, path, startPoint, ...)	This method is used to perform stress linearization along a defined stress line.
`setPathTolerance`([tolerance])	This method is used to set the tolerance to be used when creating XYData objects by extracting results along Path objects.
`getPathTolerance`()	This method is used to get the tolerance used when creating XYData objects by extracting results along Path objects.
`setLimitForXYDataPlots`([limit])	This method is used to set the limit for number of XY data objects while creating XYData from field output.
`getLimitForXYDataPlots`()	This method is used to get the limit for number of XY data objects while creating XYData from field output.

Inherited from SessionBase

`setValues`([kernelMemoryLimit])	This method modifies the Session object.
`enableCADConnection`(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
`isCADConnectionEnabled`()	This method checks the status of CAD Connection.
`disableCADConnection`(CADName)	This method disables an associative import CAD connection that was enabled.
`enableParameterUpdate`(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
`setCADPortNumber`(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
`updateCADParameters`(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
`disableParameterUpdate`(CADName)	This method disables an associative CAD connection using parameters.
`printToFile`(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
`printToPrinter`([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
`saveOptions`(directory)	This method saves your customized display settings.
`writeVrmlFile`(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
`write3DXMLFile`(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
`writeOBJFile`(fileName[, canvasObjects])	This method exports the current viewport objects to a file.

Member Details:

static AreaStyle(color='', fill=1, style=SOLID)[source]¶

This method creates an AreaStyle.

Note

This function can be accessed by:

session.AreaStyle
xyPlot.AreaStyle

Note

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

Parameters:¶

color=''¶: A String specifying the color to be used when filling an area with this AreaStyle object. The default value is “White”.
fill=1¶: A Boolean specifying whether to fill the area when using this AreaStyle. The default value is ON.
style=SOLID¶: A SymbolicConstant specifying the area pattern style to be used when filling an area using this AreaStyle. The default value is SOLID.

Returns:¶

An AreaStyle object.

Return type:¶

AreaStyle

Raises:¶

ColorError –

static LineStyle(color='', show=1, style=SOLID, thickness=0)[source]¶

This method creates a LineStyle.

Note

This function can be accessed by:

session.LineStyle
xyPlot.LineStyle

Note

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

Parameters:¶

color=''¶: A String specifying the color to be used when drawing a line with this LineStyle object. The default value is “White”.
show=1¶: A Boolean specifying whether to draw the line when using this LineStyle. The default value is ON.
style=SOLID¶: A SymbolicConstant specifying the line style to be used when drawing lines using this LineStyle. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
thickness=0¶: A Float specifying the line thickness in mm to be used when drawing lines using this LineStyle. The default value is 0.2.

Returns:¶

A LineStyle object.

Return type:¶

LineStyle

Raises:¶

ColorError –

static QuantityType(label='', type=NONE)[source]¶

This method creates a QuantityType object.

Note

This function can be accessed by:

session.QuantityType
xyPlot.QuantityType

Note

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

Parameters:¶

label=''¶

A String specifying the label for this quantity type.

type=NONE¶

A SymbolicConstant specifying the physical dimension of the axis. Possible values are:

NONE.
ACCELERATION.
ACOUSTIC_INTENSITY.
ANGLE.
ANGULAR_MOMENTUM.
ARC_LENGTH.
AREA.
AREA_VELOCITY_SQUARED, specifying “Velocity squared per area”.
BIMOMENT.
CURVATURE.
CORIOLIS_LOAD.
DAMAGE.
DAMAGE_CRITERION.
DENSITY.
DENSITY_ROTATIONAL_ACCELERATION, specifying “Density * Angular acceleration”.
DISPLACEMENT.
ECURRENT_AREA_TIME, specifying “Time integrated electric current per area”.
ELECTRIC_CHARGE.
ELECTRIC_CURRENT.
ELECTRIC_CURRENT_AREA, specifying “Electric current per unit area”.
ELECTRIC_POTENTIAL.
ENERGY.
ENERGY_DENSITY.
ENERGY_RELEASE_RATE.
EPOTENTIAL_GRADIENT, specifying “Electric potential gradient”.
FREQUENCY.
FORCE.
FORCE_VOLUME, specifying “Force per volume”.
HEAT_FLUX.
HEAT_FLUX_AREA, specifying “Heat flux per area”.
HEAT_FLUX_RATE.
HEAT_FLUX_VOLUME, specifying “Heat flux per volume”.
LENGTH.
LINEAR_PRESSURE.
LUMIN, specifying “Luminous intensity”.
MASS.
MASS_FLOW_AREA, specifying “Mass flow per area”.
MASS_FLOW_AREA_RATE, specifying “Mass flow rate per area”.
MASS_FLOW_RATE.
MODE_NUMBER.
MOMENT.
NUMBER.
PATH.
PHASE.
POSITION.
PRESSURE.
PRESSURE_GRADIENT.
RATE.
ROTARY_INERTIA.
ROTATIONAL_ACCELERATION.
ROTATIONAL_VELOCITY.
STATUS.
STRAIN.
STRAIN_RATE.
STRESS.
STRESS_INTENS_FACTOR, specifying “Stress intensity factor”.
SUBSTANCE, specifying “Amount of substance”.
TEMPERATURE.
THICKNESS.
TIME.
TIME_INCREMENT.
TIME_HEAT_FLUX, specifying “Time integrated heat flux”.
TIME_HEAT_FLUX_AREA, specifying “Time integrated heat flux per area”.
TIME_VOLUME, specifying “Time integrated volume”.
TIME_VOLUME_FLUX, specifying “Time integrated volume flux per area”.
TWIST.
VELOCITY.
VELOCITY_SQUARED.
VOLUME.
VOLUME_FLUX.
VOLUME_FLUX_AREA, specifying “Volume flux per area”.
VOLUME_FRACTION.

The default value is NONE

Returns:¶

A QuantityType object.

Return type:¶

QuantityType

static SymbolStyle(color='', show=1, marker=FILLED_CIRCLE, size=2)[source]¶

This method creates a SymbolStyle object.

Note

This function can be accessed by:

session.SymbolStyle
xyPlot.SymbolStyle

Note

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

Parameters:¶

color=''¶

A String specifying the color to be used when drawing a marker with this SymbolStyle object. The default value is “White”.

show=1¶

A Boolean specifying whether to draw the marker when using this SymbolStyle object. The default value is ON.

marker=FILLED_CIRCLE¶

A SymbolicConstant specifying the marker type be used when drawing symbols using this SymbolStyle object. Possible values are:

FILLED_CIRCLE
FILLED_SQUARE
FILLED_DIAMOND
FILLED_TRI
HOLLOW_CIRCLE
HOLLOW_SQUARE
HOLLOW_DIAMOND
HOLLOW_TRI
CROSS
XMARKER
POINT

The default value is FILLED_CIRCLE.

size=2¶

A Float specifying the marker size to be used when drawing markers using this SymbolStyle object. The default value is 2.0.

Returns:¶

A SymbolStyle object.

Return type:¶

SymbolStyle

Raises:¶

ColorError –

static TextStyle(color='', show=1, font='', rotationAngle=0)[source]¶

This method creates a TextStyle.

Note

This function can be accessed by:

session.TextStyle
xyPlot.TextStyle

Note

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

Parameters:¶

color=''¶: A String specifying the color to be used when drawing text with this TextStyle object. The default value is “White”.
show=1¶: A Boolean specifying whether to draw the text when using this TextStyle object. The default value is ON.
font=''¶: A String specifying the name of the font to be used when drawing text with this TextStyle object. The default value is “--verdana-medium-r-normal---120---p---“.
rotationAngle=0¶: A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

Returns:¶

A TextStyle object.

Return type:¶

TextStyle

Raises:¶

ColorError –

static XYData(data: tuple, name: str = '')[source]¶
static XYData(objectToCopy: XYData)
static XYData(*args, **kwargs)

XYDataFromFile( fileName, name='', sourceDescription='', contentDescription='', positionDescription='', legendLabel='', xValuesLabel='', yValuesLabel='', axis1QuantityType=Ellipsis, axis2QuantityType=Ellipsis, xField=1, yField=2, skipFrequency=0, )[source]¶

This method creates an XYData object from data in an ASCII file.

Note

This function can be accessed by:

session.XYDataFromFile
xyPlot.XYDataFromFile

Parameters:¶

fileName¶: A String specifying the name of the file from which the X - Y data will be read.
name=''¶: The repository key. If the name is not supplied, a default name in the form _temp#_ is generated and the XYData object is temporary.
sourceDescription=''¶: A String specifying the source of the X - Y data (e.g., “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.
contentDescription=''¶: A String specifying the content of the X - Y data (e.g., “field 1 vs. field 2”). The default value is an empty string.
positionDescription=''¶: A String specifying additional information about the X - Y data (e.g., “for whole model”). The default value is an empty string.
legendLabel=''¶: A String specifying the label to be used in the legend. The default value is the name of the XYData object.
xValuesLabel=''¶: A String specifying the label for the X-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.
yValuesLabel=''¶: A String specifying the label for the Y-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.
axis1QuantityType=Ellipsis¶: A QuantityType object specifying the QuantityType object associated to the X -axis1- values.
axis2QuantityType=Ellipsis¶: A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.
xField=1¶: An Int specifying the field from which the X data will be read. Fields are delimited by spaces, tabs, or commas. The default value is 1.
yField=2¶: An Int specifying the field from which the Y data will be read. Fields are delimited by spaces, tabs, or commas. The default value is 2.
skipFrequency=0¶: An Int specifying how often data rows will be skipped. A skipFrequency of 1 means skip every other row. The first row is always read. Possible values are skipFrequency ≥ 0. The default value is 0 (data are read from every row).

Returns:¶

An XYData object.

Return type:¶

XYData

Raises:¶

InvalidNameError –
RangeError –

XYDataFromFreeBody( odb, force=1, moment=0, heatFlowRate=0, resultant=1, comp1=0, comp2=0, comp3=0, )[source]¶

This method creates a list of XYData objects by computing free body data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromFreeBody
xyPlot.XYDataFromFreeBody

Note

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

Parameters:¶

odb¶: An Odb object specifying the output database from which data will be read.
force=1¶: A boolean indicating whether to compute the force. The default is ON.
moment=0¶: A boolean indicating whether to compute the moment. The default is OFF.
heatFlowRate=0¶: A boolean indicating whether to compute the heat flow rate resultant magnitude. It is extracted only for viewcut based freebodies. The default is OFF.
resultant=1¶: A boolean indicating whether to compute the resultant. It applies only to force and moment. The default is ON.
comp1=0¶: A boolean indicating whether to compute the first component. It applies only to force and moment. The default is OFF.
comp2=0¶: A boolean indicating whether to compute the second component. It applies only to force and moment. The default is OFF.
comp3=0¶: A boolean indicating whether to compute the third component. It applies only to force and moment. The default is OFF.

Returns:¶

A list of XYData objects.

Return type:¶

list[XYData]

Raises:¶

InvalidNameError –
RangeError –

XYDataFromHistory( odb, outputVariableName, steps, name='', sourceDescription='', contentDescription='', positionDescription='', legendLabel='', skipFrequency=0, numericForm=REAL, complexAngle=0, stepTuple=(), )[source]¶

This method creates an XYData object by reading history data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromHistory
xyPlot.XYDataFromHistory

Note

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

Parameters:¶

odb¶: An Odb object specifying the output database from which data will be read.
outputVariableName¶: A String specifying the output variable from which the X - Y data will be read.
steps¶: A sequence of Strings specifying the names of the steps from which data will be extracted.
name=''¶: The repository key. If the name is not supplied, a default name in the form _temp#_ is generated and the XYData object is temporary (this argument is required if the method is accessed from the session object).
sourceDescription=''¶: A String specifying the source of the X - Y data (for example, “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.
contentDescription=''¶: A String specifying the content of the X - Y data (for example, “field 1 vs. field 2”). The default value is an empty string.
positionDescription=''¶: A String specifying additional information about the X - Y data (for example, “for whole model”). The default value is an empty string.
legendLabel=''¶: A String specifying the label to be used in the legend. The default value is the name of the XYData object.
skipFrequency=0¶: An Int specifying how often data frames will be skipped. If skipFrequency = 1, Abaqus will skip every other frame. The first frame is always read. Possible values are skipFrequency ≥ 0. The default value is 0 (data are read from every frame).
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, and COMPLEX_VAL_AT_ANGLE. The default value is REAL.
complexAngle=0¶: A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.
stepTuple=()¶: A tuple of Integers specifying the steps to include when extracting data.

Returns:¶

An XYData object.

Return type:¶

XYData

Raises:¶

InvalidNameError –
RangeError –

XYDataFromPath( path, name, includeIntersections=False, shape=UNDEFORMED, pathStyle=PATH_POINTS, numIntervals=10, labelType=NORM_DISTANCE, viewport='', removeDuplicateXYPairs=True, includeAllElements=False, step=0, frame=0, variable=(), deformedMag=(1, 1, 1), numericForm=REAL, complexAngle=0, projectOntoMesh=False, projectionTolerance=0, )[source]¶

This method creates an XYData object from path information.

Note

This function can be accessed by:

session.XYDataFromPath
xyPlot.XYDataFromPath

Note

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

Parameters:¶

path¶

A Path object to use in X - Y data generation.

name¶

A String specifying the repository key:for session ‘name’ is required argument and for xyPlot ‘name’ is optional argument.

includeIntersections=False¶

A Boolean specifying whether to include X - Y data for the intersections between the path and element faces or edges. The default value is False.

shape=UNDEFORMED¶

A SymbolicConstant specifying the model shape to use. Possible values are UNDEFORMED and DEFORMED.

pathStyle=PATH_POINTS¶

A SymbolicConstant specifying the path style. Possible values are PATH_POINTS and UNIFORM_SPACING.

numIntervals=10¶

An Int specifying the number of uniform-spacing intervals. The default value is 10.

labelType=NORM_DISTANCE¶

A SymbolicConstant specifying the X label type to use. Possible values are NORM_DISTANCE, SEQ_ID, TRUE_DISTANCE, TRUE_DISTANCE_X, TRUE_DISTANCE_Y, TRUE_DISTANCE_Z, X_COORDINATE, Y_COORDINATE and Z_COORDINATE.

viewport=''¶

A String specifying the viewport name or an Int specifying the viewport id from which to obtain values. The default is the current viewport.

removeDuplicateXYPairs=True¶

A Boolean specifying whether to remove duplicate XY values from the final result. The default value is True.

Added in version 2018: The removeDuplicateXYPairs argument was added.

includeAllElements=False¶

A Boolean specifying whether to include elements which do not lie in the direction of the path. The default value is False.

Added in version 2018: The includeAllElements argument was added.

step=0¶

An Int identifying the step from which to obtain values. The default value is the current step.

frame=0¶

An Int identifying the frame from which to obtain values. The default value is the current frame.

variable=()¶

A tuple of tuples containing the descriptions of variables for which to extract data along the path. The default value is the current variable. Each tuple specifies the following:

Variable label: A String specifying the variable; for example, ‘U’.
Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.
Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:
- Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.
- Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.
Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:
- A String specifying the category selection label.
- A String specifying the section point label.

For example:

variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
            ('U', NODAL,((COMPONENT, 'U1'), )), )
variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
             {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )

deformedMag=(1, 1, 1)¶

A tuple of three Floats specifying the deformation magnitude in the X-, Y-, and Z- planes. The default value is (1, 1, 1).

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, and COMPLEX_VAL_AT_ANGLE. The default value is REAL.

complexAngle=0¶

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

projectOntoMesh=False¶

A Boolean to specify whether to consider the data points that do not lie on or inside the mesh. The default value is False.

projectionTolerance=0¶

A Float specifying the tolerance value for the projected distance considered for the data extraction when projectOntoMesh = True. The default value is 0.

Returns:¶

If **variable specified has one fieldoutput** (Returns an XYData object.)
If **variable specified has more than one fieldoutputs** (Returns list of XYData objects.)

Raises:¶

ErrorPathNotFound – Path not found, If path is invalid.
ErrorCurrentVPNotFound – If viewport is invalid.
ErrorInvalidUserStepAndFrame – If step and/or frame are invalid.
ErrorNoVarInPathExtract – If the variable argument is empty.
ErrorUnavailableSelectedVariable – If the specified output variable is not available in the output database.
ErrorUnusableVarInPathExtract – If the specified output variable cannot be used to obtain X - Y data from path.
ErrorUnsupportedRefinementType – If the SymbolicConstant specifying the refinement type is invalid.
ErrorInvalidRefinementSpecification – If the label specifying the refinement invariant or component is invalid.
ErrorDeformedMagTupleInPathExtract – If deformedMag does not contain three Floats.

XYDataFromShellThickness( odb, outputPosition, variable, elementSets=(), elementLabels=(), nodeSets=(), nodeLabels=(), numericForm=REAL, complexAngle=0, )[source]¶

This method creates a list of XYData objects by reading through the thickness field data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromShellThickness
xyPlot.XYDataFromShellThickness

Note

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

Parameters:¶

odb¶

An Odb object specifying the output database from which data will be read.

outputPosition¶

A SymbolicConstant specifying the position from which output will be read. Possible values are ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, and NODAL.

variable¶

A tuple of tuples containing the descriptions of variables for which to extract data from the field. Each tuple specifies the following:

Variable label: A String specifying the variable; for example, ‘U’.
Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.
Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:
- Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.
- Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.
Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:
- A String specifying the category selection label.
- A String specifying the section point label.

For example:

variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
            ('U', NODAL,((COMPONENT, 'U1'), )), )
variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
             {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )

elementSets=()¶

A sequence of Strings specifying element sets or a String specifying a single element set.

elementLabels=()¶

An Int specifying a single element label; for example, 1.
A String specifying a single element label; for example, ‘7’.
A String specifying a sequence of element labels; for example, ‘3:5’ and ‘3:15:3’.

nodeSets=()¶

A sequence of Strings specifying node sets or a String specifying a single node set.

nodeLabels=()¶

An Int specifying a single node label; for example, 1.
A String specifying a single node label; for example, ‘7’.
A String specifying a sequence of node labels; for example, ‘3:5’ and ‘3:15:3’.

numericForm=REAL¶

complexAngle=0¶

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

Returns:¶

A list of XYData objects.

Return type:¶

list[XYData]

Raises:¶

InvalidNameError –
RangeError –

xyDataListFromField( odb, outputPosition, variable, elementSets=(), elementLabels=(), nodeSets=(), nodeLabels=(), numericForm=REAL, complexAngle=0, operator=None, )[source]¶

This method creates a list of XYData objects by reading field data from an Odb object.

Note

This function can be accessed by:

session.xyDataListFromField
xyPlot.xyDataListFromField

Note

Check XYSession.xyDataListFromField on help.3ds.com/2024.

Parameters:¶

odb¶

An Odb object specifying the output database from which data will be read.

outputPosition¶

A SymbolicConstant specifying the position from which output will be read. Possible values are ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, and NODAL.

variable¶

A tuple of tuples containing the descriptions of variables for which to extract data from the field. Each tuple specifies the following:

Variable label: A String specifying the variable; for example, ‘U’.
Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.
Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:
- Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.
- Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.
Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:
- A String specifying the category selection label.
- A String specifying the section point label.

For example:

variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
            ('U', NODAL,((COMPONENT, 'U1'), )), )
variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
             {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )

elementSets=()¶

A sequence of Strings specifying element sets or a String specifying a single element set.

elementLabels=()¶

An Int specifying a single element label; for example, 1.
A String specifying a single element label; for example, ‘7’.
A String specifying a sequence of element labels; for example, ‘3:5’ and ‘3:15:3’.

nodeSets=()¶

A sequence of Strings specifying node sets or a String specifying a single node set.

nodeLabels=()¶

An Int specifying a single node label; for example, 1.A
String specifying a single node label; for example, ‘7’.
A String specifying a sequence of node labels; for example, ‘3:5’ and ‘3:15:3’.

numericForm=REAL¶

complexAngle=0¶

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

operator=None¶

A SymbolicConstant specifying the mathematical, trigonometric, logarithmic, exponential, or other operations. Possible values are ADD, SUBTRACT, MULTIPLY, DIVIDE, POWER, MINIMUM, MAXIMUM, AVERAGE, RANGE, SRSS, ABSOLUTE, UNARY_NEGATIVE, COSINE, HYPERBOLIC_COSINE, INVERSE_COSINE, SINE, HYPERBOLIC_SINE, INVERSE_SINE, TANGENT, HYPERBOLIC_TANGENT, INVERSE_TANGENT, EXPONENTIAL, NATURAL_LOG, LOG, SQUARE_ROOT, NORMALIZE, DEG2RAD, RAD2DEG, SMOOTH, SWAP, AVERAGE_ALL, MAXIMUM_ENVELOPE, MINIMUM_ENVELOPE, and RANGE_ALL. If no value is defined, no operation will be performed on the data, and the data will be saved as is.

Returns:¶

A list of XYData objects.

Return type:¶

list[XYData]

Raises:¶

InvalidNameError –
RangeError –

Other Classes¶

class Area[source]¶

Bases: object

The Area object is used to display a rectangular area in an XYPlot. The Area object has no constructor. Area objects are automatically created whenever a XYPlot, Chart, PlotTitle, or Legend objects are created.

Note

This object can be accessed by:

import visualization
session.charts[name].area
session.charts[name].gridArea
session.charts[name].legend.area
session.defaultChartOptions.gridArea
session.defaultChartOptions.legend.area
session.defaultPlot.area
session.defaultPlot.title.area
session.xyPlots[name].area
session.xyPlots[name].charts[name].area
session.xyPlots[name].charts[name].gridArea
session.xyPlots[name].charts[name].legend.area
session.xyPlots[name].title.area

Note

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

Member Details:

alignment : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'BOTTOM_LEFT'[source]¶

A SymbolicConstant specifying the relative position of the area in its parent when positionMethod = AUTO_ALIGN. Possible values are:

BOTTOM_LEFT
BOTTOM_CENTER
BOTTOM_RIGHT
CENTER_LEFT
CENTER
CENTER_RIGHT
TOP_LEFT
TOP_CENTER
TOP_RIGHT

The default value is BOTTOM_LEFT.

border : --is-rst--:py:class:`~abaqus.XY.LineStyle.LineStyle` = <abaqus.XY.LineStyle.LineStyle object>[source]¶: A LineStyle object specifying whether and how to draw the border of the area.

height : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the height of the area in mm. The default value is 1.0.

heightScale : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the scale as a fraction of the height of the available area when the sizeMethod = MANUAL. The valid range is (0, 1). The default value is 1.0.

inset : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether the area is inset or occupies a reserved area. The default value is OFF.

origin : --is-rst--:py:class:`~typing.Sequence`\ \[:py:class:`float`] = ()[source]¶: A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the XYPlot.

originOffset : --is-rst--:py:class:`~typing.Sequence`\ \[:py:class:`float`] = ()[source]¶: A pair of Floats specifying the X- and Y-offsets of the origin as a fraction of the available area. The originOffset argument is ignored unless positionMethod = MANUAL. The default value is (-1, 0). The valid range for each float is (0, 1).

pb : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the bottom padding of the area in mm. The default value is 1.0.

pl : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the left padding of the area in mm. The default value is 1.0.

positionMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'AUTO_ALIGN'[source]¶: A SymbolicConstant specifying how the area is positioned. Possible values are AUTO_ALIGN and MANUAL. The default value is AUTO_ALIGN.

pr : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the right padding of the area in mm. The default value is 1.0.

pt : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the top padding of the area in mm. The default value is 1.0.

setValues( area, style, border, positionMethod=AUTO_ALIGN, alignment=BOTTOM_LEFT, sizeMethod=AUTOMATIC, originOffset=(), widthScale=1, heightScale=1, inset=0, pl=1, pr=1, pt=1, pb=1, )[source]¶

This method modifies the Area object.

Note

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

Parameters:¶

area¶

An Area object from which attributes are to be copied.

style¶

An AreaStyle object.

border¶

A LineStyle object.

positionMethod=AUTO_ALIGN¶

A SymbolicConstant specifying how the area is positioned. Possible values are AUTO_ALIGN and MANUAL. The default value is AUTO_ALIGN.

alignment=BOTTOM_LEFT¶

A SymbolicConstant specifying the relative position of the area in its parent when positionMethod = AUTO_ALIGN. Possible values are:

BOTTOM_LEFT
BOTTOM_CENTER
BOTTOM_RIGHT
CENTER_LEFT
CENTER
CENTER_RIGHT
TOP_LEFT
TOP_CENTER
TOP_RIGHT

The default value is BOTTOM_LEFT.

sizeMethod=AUTOMATIC¶

A SymbolicConstant specifying how the area size is defined. Possible values are AUTOMATIC and MANUAL. The default value is AUTOMATIC.

originOffset=()¶

A pair of Floats specifying the X- and Y-offsets of the origin as a fraction of the available area. The originOffset argument is ignored unless positionMethod = MANUAL. The default value is (-1, 0). The valid range for each float is (0, 1).

widthScale=1¶

A Float specifying the scale as a fraction of the width of the available area when the sizeMethod=MANUAL. The valid range is (0, 1). The default value is 1.0.

heightScale=1¶

A Float specifying the scale as a fraction of the height of the available area when the sizeMethod = MANUAL. The valid range is (0, 1). The default value is 1.0.

inset=0¶

A Boolean specifying whether the area is inset or occupies a reserved area. The default value is OFF.

pl=1¶

A Float specifying the left padding of the area in mm. The default value is 1.0.

pr=1¶

A Float specifying the right padding of the area in mm. The default value is 1.0.

pt=1¶

A Float specifying the top padding of the area in mm. The default value is 1.0.

pb=1¶

A Float specifying the bottom padding of the area in mm. The default value is 1.0.

Raises:¶

RangeError –

sizeMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'AUTOMATIC'[source]¶: A SymbolicConstant specifying how the area size is defined. Possible values are AUTOMATIC and MANUAL. The default value is AUTOMATIC.

style : --is-rst--:py:class:`~abaqus.XY.AreaStyle.AreaStyle` = <abaqus.XY.AreaStyle.AreaStyle object>[source]¶: An AreaStyle object specifying whether and how to fill the area.

width : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the width of the area in mm. The default value is 1.0.

widthScale : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the scale as a fraction of the width of the available area when the sizeMethod=MANUAL. The valid range is (0, 1). The default value is 1.0.

class AreaStyle(color='', fill=1, style=SOLID)[source]¶

Bases: object

The AreaStyle object is used to define how areas are to be filled when drawing XY-plot objects. AreaStyle objects are automatically created whenever an Area object is created. AreaStyle objects can be created using the methods described below.

Note

This object can be accessed by:

import visualization
session.charts[name].area.style
session.charts[name].gridArea.style
session.charts[name].legend.area.style
session.charts[name].tagAreaStyle
session.defaultChartOptions.areaStyle
session.defaultChartOptions.gridArea.style
session.defaultChartOptions.legend.area.style
session.defaultChartOptions.tagAreaStyle
session.defaultPlot.area.style
session.defaultPlot.title.area.style
session.xyPlots[name].area.style
session.xyPlots[name].charts[name].area.style
session.xyPlots[name].charts[name].gridArea.style
session.xyPlots[name].charts[name].legend.area.style
session.xyPlots[name].charts[name].tagAreaStyle
session.xyPlots[name].title.area.style

Note

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

Member Details:

color : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the color to be used when filling an area with this AreaStyle object. The default value is “White”.

fill : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to fill the area when using this AreaStyle. The default value is ON.

setValues(color='', fill=1, style=SOLID)[source]¶

This method modifies the AreaStyle object.

Note

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

Parameters:¶

color=''¶: A String specifying the color to be used when filling an area with this AreaStyle object. The default value is “White”.
fill=1¶: A Boolean specifying whether to fill the area when using this AreaStyle. The default value is ON.
style=SOLID¶: A SymbolicConstant specifying the area pattern style to be used when filling an area using this AreaStyle. The default value is SOLID.

style : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLID'[source]¶: A SymbolicConstant specifying the area pattern style to be used when filling an area using this AreaStyle. The default value is SOLID.

class LineStyle(color='', show=1, style=SOLID, thickness=0)[source]¶

Bases: object

The LineStyle object is used to define the line style to be used for drawing XY-Plot objects. LineStyle objects can be created using the methods described below.

Note

This object can be accessed by:

import visualization
session.charts[name].area.border
session.charts[name].axes1[i].axisData.curves[i].lineStyle
session.charts[name].axes1[i].lineStyle
session.charts[name].axes1[i].tickStyle
session.charts[name].axes2[i].axisData.curves[i].lineStyle
session.charts[name].axes2[i].lineStyle
session.charts[name].axes2[i].tickStyle
session.charts[name].curves[name].lineStyle
session.charts[name].gridArea.border
session.charts[name].legend.area.border
session.charts[name].majorAxis1GridStyle
session.charts[name].majorAxis2GridStyle
session.charts[name].minorAxis1GridStyle
session.charts[name].minorAxis2GridStyle
session.charts[name].tagBorder
session.curves[name].lineStyle
session.defaultChartOptions.defaultAxis1Options.axisData.curves[i].lineStyle
session.defaultChartOptions.defaultAxis1Options.lineStyle
session.defaultChartOptions.defaultAxis1Options.tickStyle
session.defaultChartOptions.defaultAxis2Options.axisData.curves[i].lineStyle
session.defaultChartOptions.defaultAxis2Options.lineStyle
session.defaultChartOptions.defaultAxis2Options.tickStyle
session.defaultChartOptions.gridArea.border
session.defaultChartOptions.legend.area.border
session.defaultChartOptions.majorAxis1GridStyle
session.defaultChartOptions.majorAxis2GridStyle
session.defaultChartOptions.minorAxis1GridStyle
session.defaultChartOptions.minorAxis2GridStyle
session.defaultChartOptions.tagBorder
session.defaultPlot.area.border
session.defaultPlot.title.area.border
session.xyPlots[name].area.border
session.xyPlots[name].charts[name].area.border
session.xyPlots[name].charts[name].axes1[i].axisData.curves[i].lineStyle
session.xyPlots[name].charts[name].axes1[i].lineStyle
session.xyPlots[name].charts[name].axes1[i].tickStyle
session.xyPlots[name].charts[name].axes2[i].axisData.curves[i].lineStyle
session.xyPlots[name].charts[name].axes2[i].lineStyle
session.xyPlots[name].charts[name].axes2[i].tickStyle
session.xyPlots[name].charts[name].curves[name].lineStyle
session.xyPlots[name].charts[name].gridArea.border
session.xyPlots[name].charts[name].legend.area.border
session.xyPlots[name].charts[name].majorAxis1GridStyle
session.xyPlots[name].charts[name].majorAxis2GridStyle
session.xyPlots[name].charts[name].minorAxis1GridStyle
session.xyPlots[name].charts[name].minorAxis2GridStyle
session.xyPlots[name].charts[name].tagBorder
session.xyPlots[name].curves[name].lineStyle
session.xyPlots[name].title.area.border

Note

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

Member Details:

color : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the color to be used when drawing a line with this LineStyle object. The default value is “White”.

setValues(color='', show=1, style=SOLID, thickness=0)[source]¶

This method modifies the LineStyle object.

Note

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

Parameters:¶

color=''¶: A String specifying the color to be used when drawing a line with this LineStyle object. The default value is “White”.
show=1¶: A Boolean specifying whether to draw the line when using this LineStyle. The default value is ON.
style=SOLID¶: A SymbolicConstant specifying the line style to be used when drawing lines using this LineStyle. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
thickness=0¶: A Float specifying the line thickness in mm to be used when drawing lines using this LineStyle. The default value is 0.2.

show : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to draw the line when using this LineStyle. The default value is ON.

style : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLID'[source]¶: A SymbolicConstant specifying the line style to be used when drawing lines using this LineStyle. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

thickness : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying the line thickness in mm to be used when drawing lines using this LineStyle. The default value is 0.2.

class Axis[source]¶

Bases: object

The Axis object is used to store the display attributes of axes. Axes objects are automatically created when adding XYCurve objects to a Chart object.

Note

This object can be accessed by:

import visualization
session.charts[name].axes1[i]
session.charts[name].axes2[i]
session.defaultChartOptions.defaultAxis1Options
session.defaultChartOptions.defaultAxis2Options
session.xyPlots[name].charts[name].axes1[i]
session.xyPlots[name].charts[name].axes2[i]

Note

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

Member Details:

axisData : --is-rst--:py:class:`~abaqus.XY.AxisData.AxisData` = <abaqus.XY.AxisData.AxisData object>[source]¶: An AxisData object specifying the numerical data of the axis.

labelFrequency : --is-rst--:py:class:`int` = 1[source]¶: An Int specifying the frequency of the labels with respect to the tick marks. The default value is 1.

labelPlacement : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'INSIDE'[source]¶: A SymbolicConstant specifying how labels are placed on the axis. Possible values are:NONE, specifying that no labels are displayed.INSIDE, specifying that the labels are placed on the inside of the axis.OUTSIDE, specifying that the labels are placed on the outside of the axis.The default value is INSIDE.

labelStyle : --is-rst--:py:class:`~abaqus.XY.TextStyle.TextStyle` = <abaqus.XY.TextStyle.TextStyle object>[source]¶: A TextStyle object specifying the text properties to be used when displaying axis labels.

lineStyle : --is-rst--:py:class:`~abaqus.XY.LineStyle.LineStyle` = <abaqus.XY.LineStyle.LineStyle object>[source]¶: A LineStyle object specifying the line properties used to display the axis.

placement : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'MIN_MAX_EDGE'[source]¶: A SymbolicConstant specifying the placement of the axis on the grid. Possible values are:MIN_EDGE, specifying that the axis is placed at the minimum edge - for an abscissa at the bottom, for an ordinate to the left.MAX_EDGE, specifying that the axis is placed at the maximum edge - for an abscissa at the top, for an ordinate at the right.MIN_MAX_EDGE, specifying that the axis is placed at the minimum edge - for an abscissa at the bottom, for an ordinate to the left - and repeated without labels and title at the maximum edge.CENTER, specifying that the axis is placed at the center of the grid.The default value is MIN_MAX_EDGE.

setValues( axis, labelFrequency=1, labelPlacement=INSIDE, labelStyle=None, lineStyle=None, placement=MIN_MAX_EDGE, tickLength=2, tickPlacement=INSIDE, tickStyle=None, titleStyle=None, )[source]¶

This method modifies the Axis object.

Note

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

Parameters:¶

axis¶: An Axis object from which attributes are to be copied.
labelFrequency=1¶: An Int specifying the frequency of the labels with respect to the tick marks. The default value is 1.
labelPlacement=INSIDE¶: A SymbolicConstant specifying how labels are placed on the axis. Possible values are:NONE, specifying that no labels are displayed.INSIDE, specifying that the labels are placed on the inside of the axis.OUTSIDE, specifying that the labels are placed on the outside of the axis.The default value is INSIDE.
labelStyle=None¶: A TextStyle object specifying the text properties to be used when displaying axis labels.
lineStyle=None¶: A LineStyle object specifying the line properties used to display the axis.
placement=MIN_MAX_EDGE¶: A SymbolicConstant specifying the placement of the axis on the grid. Possible values are:MIN_EDGE, specifying that the axis is placed at the minimum edge - for an abscissa at the bottom, for an ordinate to the left.MAX_EDGE, specifying that the axis is placed at the maximum edge - for an abscissa at the top, for an ordinate at the right.MIN_MAX_EDGE, specifying that the axis is placed at the minimum edge - for an abscissa at the bottom, for an ordinate to the left - and repeated without labels and title at the maximum edge.CENTER, specifying that the axis is placed at the center of the grid.The default value is MIN_MAX_EDGE.
tickLength=2¶: A Float specifying the length of the ticks in mm. The default value is 2.0.
tickPlacement=INSIDE¶: A SymbolicConstant specifying how tick marks are placed on the axis. Possible values are:NONE, specifying that no tick marks are displayed.INSIDE, specifying that the tick marcks are placed on the inside of the axis.OUTSIDE, specifying that the tick marcks are placed on the outside of the axis.ACROSS, specifying that the tick marcks are placed across the axis.The default value is INSIDE.
tickStyle=None¶: A LineStyle object specifying the line properties to be used when displaying axis ticks.
titleStyle=None¶: A TextStyle object specifying the text properties to be used when displaying the axis title.

tickLength : --is-rst--:py:class:`float` = 2[source]¶: A Float specifying the length of the ticks in mm. The default value is 2.0.

tickPlacement : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'INSIDE'[source]¶: A SymbolicConstant specifying how tick marks are placed on the axis. Possible values are:NONE, specifying that no tick marks are displayed.INSIDE, specifying that the tick marcks are placed on the inside of the axis.OUTSIDE, specifying that the tick marcks are placed on the outside of the axis.ACROSS, specifying that the tick marcks are placed across the axis.The default value is INSIDE.

tickStyle : --is-rst--:py:class:`~abaqus.XY.LineStyle.LineStyle` = <abaqus.XY.LineStyle.LineStyle object>[source]¶: A LineStyle object specifying the line properties to be used when displaying axis ticks.

titleStyle : --is-rst--:py:class:`~abaqus.XY.TextStyle.TextStyle` = <abaqus.XY.TextStyle.TextStyle object>[source]¶: A TextStyle object specifying the text properties to be used when displaying the axis title.

class AxisData[source]¶

Bases: object

The AxisData object is used to store the data attributes of axes. An AxisData object is automatically created when creating an Axis object.

Note

This object can be accessed by:

import visualization
session.charts[name].axes1[i].axisData
session.charts[name].axes2[i].axisData
session.defaultChartOptions.defaultAxis1Options.axisData
session.defaultChartOptions.defaultAxis2Options.axisData
session.xyPlots[name].charts[name].axes1[i].axisData
session.xyPlots[name].charts[name].axes2[i].axisData

Note

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

Member Details:

curves : --is-rst--:py:class:`~typing.List`\ \[:py:class:`~abaqus.XY.XYCurve.XYCurve`] = [][source]¶: An XYCurveArray object specifying a read-only sequence of Curve objects associated to this axis.

dbReference : --is-rst--:py:class:`float` = 1[source]¶: A Float specifying the reference value for decibel computation. The default value is 1.0.

direction : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]¶: A SymbolicConstant specifying the direction of the axis. Possible values are ABSCISSA and ORDINATE.

labelFormat : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'AUTOMATIC'[source]¶: A SymbolicConstant specifying how tick labels are formatted. Possible values are AUTOMATIC, DECIMAL, SCIENTIFIC, and ENGINEERING. The default value is AUTOMATIC.

labelNumDigits : --is-rst--:py:class:`int` = 2[source]¶: An Int specifying the number of significant digits displayed for the labels. Possible values are 1 to 7. The default value is 2.

maxAutoCompute : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether or not to use the automatically computed maximum value for the axis. The default value is ON.

maxAutoValue : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the maximum value when maxAutoCompute is true.

maxShownValue : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the current maximum value displayed for this axis. This value is different from maxAutoValue or maxValue when the axis is being transformed (zoom or pan).

maxValue : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the maximum value when maxAutoCompute is false. By default, maxValue is set to maxAutoValue.

minAutoCompute : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether or not to use the automatically computed minimum value for the axis. The default value is ON.

minAutoValue : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the minimum value when minAutoCompute is true.

minShownValue : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the current minimum value displayed for this axis. This value is different from minAutoValue or minValue when the axis is being transformed (zoom or pan).

minValue : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the minimum value when minAutoCompute is false. By default, minValue is set to minAutoValue.

minorTickCount : --is-rst--:py:class:`int` = 1[source]¶: An Int specifying the number the number of minor tick marks between major ticks. Possible values are 0 ≤ minorTickCount ≤ 20. When the scale is set to LOG, the minorTickCount is interpreted as the number of ticks per decade and limited to 0, 1, 4, 8, and 17. The default value is 1.

quantityType : --is-rst--:py:class:`~abaqus.XY.QuantityType.QuantityType` = <abaqus.XY.QuantityType.QuantityType object>[source]¶

i.e. the physical dimension and associated label of the data represented by this axis.

Type:¶: A QuantityType object specifying the quantity type

scale : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'LINEAR'[source]¶: A SymbolicConstant specifying the type of scale to use for the axis. Possible values are:LINEAR, specifying tickmarks and labels are linearly distributed.LOG, specifying tickmarks and labels are logarithmically distributed.DB, specifying tickmarks and labels are distributed on a decibel scale.DB2, specifying tickmarks and labels are distributed on a 2*decibel scale.The default value is LINEAR.

setValues( axisData=None, labelFormat=AUTOMATIC, labelNumDigits=2, scale=LINEAR, dbReference=1, minAutoCompute=1, minValue=None, maxAutoCompute=1, maxValue=None, tickMode=AUTOCOMPUTE, tickIncrement=None, tickCount=None, minorTickCount=1, title='', useSystemTitle=1, )[source]¶

This method modifies the AxisData object.

Note

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

Parameters:¶

axisData=None¶: An AxisData object from which attributes are to be copied.
labelFormat=AUTOMATIC¶: A SymbolicConstant specifying how tick labels are formatted. Possible values are AUTOMATIC, DECIMAL, SCIENTIFIC, and ENGINEERING. The default value is AUTOMATIC.
labelNumDigits=2¶: An Int specifying the number of significant digits displayed for the labels. Possible values are 1 to 7. The default value is 2.
scale=LINEAR¶: A SymbolicConstant specifying the type of scale to use for the axis. Possible values are:LINEAR, specifying tickmarks and labels are linearly distributed.LOG, specifying tickmarks and labels are logarithmically distributed.DB, specifying tickmarks and labels are distributed on a decibel scale.DB2, specifying tickmarks and labels are distributed on a 2*decibel scale.The default value is LINEAR.
dbReference=1¶: A Float specifying the reference value for decibel computation. The default value is 1.0.
minAutoCompute=1¶: A Boolean specifying whether or not to use the automatically computed minimum value for the axis. The default value is ON.
minValue=None¶: A Float specifying the minimum value when minAutoCompute is false. By default, minValue is set to minAutoValue.
maxAutoCompute=1¶: A Boolean specifying whether or not to use the automatically computed maximum value for the axis. The default value is ON.
maxValue=None¶: A Float specifying the maximum value when maxAutoCompute is false. By default, maxValue is set to maxAutoValue.
tickMode=AUTOCOMPUTE¶: A SymbolicConstant specifying the type of scale to use for the axis. Possible values are:AUTOCOMPUTE, specifying tickmarks and labels are automatically computed.INCREMENT, specifying tickmarks and labels are defined by a given increment.TOTAL_NUMBER, specifying tickmarks and labels are defined by the total number of ticks.The default value is AUTOCOMPUTE.
tickIncrement=None¶: A Float specifying the increment of the major tick marks on the axis when tickMode = INCREMENT. Valid values are 0 < tickIncrement. The default value is computed based on the results of the automatic method and the range being plotted. When the scale is set to LOG, the tickIncrement is interpreted as a value per decade and should be between 0.05 and 1.
tickCount=None¶: An Int specifying the number of major tick marks on the axis when tickMode =TOTAL_NUMBER. Possible values are 0 ≤ tickCount ≤ 30. The default value is computed based on the range of the axis. When the scale is set to LOG, the tickCount is interpreted as the number of ticks per decade and acceptable values are 1, 4, 8, and 17.
minorTickCount=1¶: An Int specifying the number the number of minor tick marks between major ticks. Possible values are 0 ≤ minorTickCount ≤ 20. When the scale is set to LOG, the minorTickCount is interpreted as the number of ticks per decade and limited to 0, 1, 4, 8, and 17. The default value is 1.
title=''¶: A String specifying the title of the axis. By default, the title is set to the systemTitle.
useSystemTitle=1¶: A Boolean specifying whether the title to use for the axis title is system defined or user defined. The default value is ON.

Raises:¶

RangeError –

systemTitle : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the system title. The system title is based on the quantityType of the axis and associated curves.

tickCount : --is-rst--:py:class:`int` | :py:obj:`None` = None[source]¶: An Int specifying the number of major tick marks on the axis when tickMode =TOTAL_NUMBER. Possible values are 0 ≤ tickCount ≤ 30. The default value is computed based on the range of the axis. When the scale is set to LOG, the tickCount is interpreted as the number of ticks per decade and acceptable values are 1, 4, 8, and 17.

tickCountShown : --is-rst--:py:class:`int` | :py:obj:`None` = None[source]¶: An Int specifying the number of major ticks effectively shown. This value takes zoom, pan and rounding into account.

tickIncrement : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the increment of the major tick marks on the axis when tickMode = INCREMENT. Valid values are 0 < tickIncrement. The default value is computed based on the results of the automatic method and the range being plotted. When the scale is set to LOG, the tickIncrement is interpreted as a value per decade and should be between 0.05 and 1.

tickIncrementShown : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the shown tick increment of the major ticks. This value takes zoom/pan into account.

tickLabels : --is-rst--:py:class:`tuple`\ \[:py:class:`str`, :py:data:`...<Ellipsis>`] = ()[source]¶: A tuple of Strings specifying the read-only major tick labels shown.

tickMode : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'AUTOCOMPUTE'[source]¶: A SymbolicConstant specifying the type of scale to use for the axis. Possible values are:AUTOCOMPUTE, specifying tickmarks and labels are automatically computed.INCREMENT, specifying tickmarks and labels are defined by a given increment.TOTAL_NUMBER, specifying tickmarks and labels are defined by the total number of ticks.The default value is AUTOCOMPUTE.

tickValues : --is-rst--:py:class:`tuple`\ \[:py:class:`float`, :py:data:`...<Ellipsis>`] = ()[source]¶: A tuple of Floats specifying the read-only major tick values shown.

title : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the title of the axis. By default, the title is set to the systemTitle.

useSystemTitle : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether the title to use for the axis title is system defined or user defined. The default value is ON.

class TextStyle(color='', show=1, font='', rotationAngle=0)[source]¶

Bases: object

The TextStyle object is used to store the text properties to be used for drawing XY-plot text objects. TextStyle objects are automatically created when creating a chart or can be created with methods described below.

Note

This object can be accessed by:

import visualization
session.charts[name].axes1[i].labelStyle
session.charts[name].axes1[i].titleStyle
session.charts[name].axes2[i].labelStyle
session.charts[name].axes2[i].titleStyle
session.charts[name].legend.textStyle
session.charts[name].legend.titleStyle
session.charts[name].tagTextStyle
session.defaultChartOptions.defaultAxis1Options.labelStyle
session.defaultChartOptions.defaultAxis1Options.titleStyle
session.defaultChartOptions.defaultAxis2Options.labelStyle
session.defaultChartOptions.defaultAxis2Options.titleStyle
session.defaultChartOptions.legend.textStyle
session.defaultChartOptions.legend.titleStyle
session.defaultChartOptions.tagTextStyle
session.defaultPlot.title.titleStyle
session.xyPlots[name].charts[name].axes1[i].labelStyle
session.xyPlots[name].charts[name].axes1[i].titleStyle
session.xyPlots[name].charts[name].axes2[i].labelStyle
session.xyPlots[name].charts[name].axes2[i].titleStyle
session.xyPlots[name].charts[name].legend.textStyle
session.xyPlots[name].charts[name].legend.titleStyle
session.xyPlots[name].charts[name].tagTextStyle
session.xyPlots[name].title.titleStyle

Note

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

Member Details:

color : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the color to be used when drawing text with this TextStyle object. The default value is “White”.

font : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the name of the font to be used when drawing text with this TextStyle object. The default value is “--verdana-medium-r-normal---120---p---“.

rotationAngle : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

setValues(color='', show=1, font='', rotationAngle=0)[source]¶

This method modifies the TextStyle object.

Note

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

Parameters:¶

color=''¶: A String specifying the color to be used when drawing text with this TextStyle object. The default value is “White”.
show=1¶: A Boolean specifying whether to draw the text when using this TextStyle object. The default value is ON.
font=''¶: A String specifying the name of the font to be used when drawing text with this TextStyle object. The default value is “--verdana-medium-r-normal---120---p---“.
rotationAngle=0¶: A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

show : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to draw the text when using this TextStyle object. The default value is ON.

class QuantityType(label='', type=NONE)[source]¶

Bases: object

The QuantityType object is used to store attributes defining the physical dimension and label of the quantity type to be associated with an XYData or an AxisData object. QuantityType objects are automatically created when creating XYData objects from the odb. QuantityType objects can be created using the methods described below.

Note

This object can be accessed by:

import visualization
session.charts[name].axes1[i].axisData.curves[i].data.axis1QuantityType
session.charts[name].axes1[i].axisData.curves[i].data.axis2QuantityType
session.charts[name].axes1[i].axisData.quantityType
session.charts[name].axes2[i].axisData.curves[i].data.axis1QuantityType
session.charts[name].axes2[i].axisData.curves[i].data.axis2QuantityType
session.charts[name].axes2[i].axisData.quantityType
session.charts[name].curves[name].data.axis1QuantityType
session.charts[name].curves[name].data.axis2QuantityType
session.curves[name].data.axis1QuantityType
session.curves[name].data.axis2QuantityType
session.defaultChartOptions.defaultAxis1Options.axisData.curves[i].data.axis1QuantityType
session.defaultChartOptions.defaultAxis1Options.axisData.curves[i].data.axis2QuantityType
session.defaultChartOptions.defaultAxis1Options.axisData.quantityType
session.defaultChartOptions.defaultAxis2Options.axisData.curves[i].data.axis1QuantityType
session.defaultChartOptions.defaultAxis2Options.axisData.curves[i].data.axis2QuantityType
session.defaultChartOptions.defaultAxis2Options.axisData.quantityType
import odbAccess
session.odbs[name].userData.axis1QuantityType
session.odbs[name].userData.axis2QuantityType
import visualization
import xyPlot
session.odbs[name].userData.xyDataObjects[name].axis1QuantityType
session.odbs[name].userData.xyDataObjects[name].axis2QuantityType
session.xyDataObjects[name].axis1QuantityType
session.xyDataObjects[name].axis2QuantityType
session.xyPlots[name].charts[name].axes1[i].axisData.curves[i].data.axis1QuantityType
session.xyPlots[name].charts[name].axes1[i].axisData.curves[i].data.axis2QuantityType
session.xyPlots[name].charts[name].axes1[i].axisData.quantityType
session.xyPlots[name].charts[name].axes2[i].axisData.curves[i].data.axis1QuantityType
session.xyPlots[name].charts[name].axes2[i].axisData.curves[i].data.axis2QuantityType
session.xyPlots[name].charts[name].axes2[i].axisData.quantityType
session.xyPlots[name].charts[name].curves[name].data.axis1QuantityType
session.xyPlots[name].charts[name].curves[name].data.axis2QuantityType
session.xyPlots[name].curves[name].data.axis1QuantityType
session.xyPlots[name].curves[name].data.axis2QuantityType

Note

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

Member Details:

label : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the label for this quantity type.

setValues(*args, **kwargs)[source]¶: This method modifies the QuantityType object.

type : --is-rst--:py:data:`~typing.Literal`\ \[``NONE``, ``ACCELERATION``, ``ACOUSTIC_INTENSITY``, ``ANGLE``, ``ANGULAR_MOMENTUM``, ``ARC_LENGTH``, ``AREA``, ``AREA_VELOCITY_SQUARED``, ``BIMOMENT``, ``CURVATURE``, ``CORIOLIS_LOAD``, ``DAMAGE``, ``DAMAGE_CRITERION``, ``DENSITY``, ``DENSITY_ROTATIONAL_ACCELERATION``, ``DISPLACEMENT``, ``ECURRENT_AREA_TIME``, ``ELECTRIC_CHARGE``, ``ELECTRIC_CURRENT``, ``ELECTRIC_CURRENT_AREA``, ``ELECTRIC_POTENTIAL``, ``ENERGY``, ``ENERGY_DENSITY``, ``ENERGY_RELEASE_RATE``, ``EPOTENTIAL_GRADIENT``, ``FREQUENCY``, ``FORCE``, ``FORCE_VOLUME``, ``HEAT_FLUX``, ``HEAT_FLUX_AREA``, ``HEAT_FLUX_RATE``, ``HEAT_FLUX_VOLUME``, ``LENGTH``, ``LINEAR_PRESSURE``, ``LUMIN``, ``MASS``, ``MASS_FLOW_AREA``, ``MASS_FLOW_AREA_RATE``, ``MASS_FLOW_RATE``, ``MODE_NUMBER``, ``MOMENT``, ``NUMBER``, ``PATH``, ``PHASE``, ``POSITION``, ``PRESSURE``, ``PRESSURE_GRADIENT``, ``RATE``, ``ROTARY_INERTIA``, ``ROTATIONAL_ACCELERATION``, ``ROTATIONAL_VELOCITY``, ``STATUS``, ``STRAIN``, ``STRAIN_RATE``, ``STRESS``, ``STRESS_INTENS_FACTOR``, ``SUBSTANCE``, ``TEMPERATURE``, ``THICKNESS``, ``TIME``, ``TIME_INCREMENT``, ``TIME_HEAT_FLUX``, ``TIME_HEAT_FLUX_AREA``, ``TIME_VOLUME``, ``TIME_VOLUME_FLUX``, ``TWIST``, ``VELOCITY``, ``VELOCITY_SQUARED``, ``VOLUME``, ``VOLUME_FLUX``, ``VOLUME_FLUX_AREA``, ``VOLUME_FRACTION``] = 'NONE'[source]¶

A SymbolicConstant specifying the physical dimension of the axis. Possible values are:

NONE.
ACCELERATION.
ACOUSTIC_INTENSITY.
ANGLE.
ANGULAR_MOMENTUM.
ARC_LENGTH.
AREA.
AREA_VELOCITY_SQUARED, specifying “Velocity squared per area”.
BIMOMENT.
CURVATURE.
CORIOLIS_LOAD.
DAMAGE.
DAMAGE_CRITERION.
DENSITY.
DENSITY_ROTATIONAL_ACCELERATION, specifying “Density * Angular acceleration”.
DISPLACEMENT.
ECURRENT_AREA_TIME, specifying “Time integrated electric current per area”.
ELECTRIC_CHARGE.
ELECTRIC_CURRENT.
ELECTRIC_CURRENT_AREA, specifying “Electric current per unit area”.
ELECTRIC_POTENTIAL.
ENERGY.
ENERGY_DENSITY.
ENERGY_RELEASE_RATE.
EPOTENTIAL_GRADIENT, specifying “Electric potential gradient”.
FREQUENCY.
FORCE.
FORCE_VOLUME, specifying “Force per volume”.
HEAT_FLUX.
HEAT_FLUX_AREA, specifying “Heat flux per area”.
HEAT_FLUX_RATE.
HEAT_FLUX_VOLUME, specifying “Heat flux per volume”.
LENGTH.
LINEAR_PRESSURE.
LUMIN, specifying “Luminous intensity”.
MASS.
MASS_FLOW_AREA, specifying “Mass flow per area”.
MASS_FLOW_AREA_RATE, specifying “Mass flow rate per area”.
MASS_FLOW_RATE.
MODE_NUMBER.
MOMENT.
NUMBER.
PATH.
PHASE.
POSITION.
PRESSURE.
PRESSURE_GRADIENT.
RATE.
ROTARY_INERTIA.
ROTATIONAL_ACCELERATION.
ROTATIONAL_VELOCITY.
STATUS.
STRAIN.
STRAIN_RATE.
STRESS.
STRESS_INTENS_FACTOR, specifying “Stress intensity factor”.
SUBSTANCE, specifying “Amount of substance”.
TEMPERATURE.
THICKNESS.
TIME.
TIME_INCREMENT.
TIME_HEAT_FLUX, specifying “Time integrated heat flux”.
TIME_HEAT_FLUX_AREA, specifying “Time integrated heat flux per area”.
TIME_VOLUME, specifying “Time integrated volume”.
TIME_VOLUME_FLUX, specifying “Time integrated volume flux per area”.
TWIST.
VELOCITY.
VELOCITY_SQUARED.
VOLUME.
VOLUME_FLUX.
VOLUME_FLUX_AREA, specifying “Volume flux per area”.
VOLUME_FRACTION.

The default value is NONE

class Chart[source]¶

Bases: object

The Chart object is used to display XYCurve objects. A Chart object is automatically created when creating an XYPlot object.

Note

This object can be accessed by:

import visualization
session.charts[name]
session.xyPlots[name].charts[name]

Note

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

Member Details:

area : --is-rst--:py:class:`~abaqus.XY.Area.Area` = <abaqus.XY.Area.Area object>[source]¶: An Area object specifying position, padding, background and borders of the chart.

aspectRatio : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]¶: A Float specifying the aspect ratio of the grid area. A value of -1 specifies that the gridArea will take up all available space. The default value is −1.

autoColor(lines=0, symbols=0)[source]¶

This method distributes the colors on all curves displayed in the chart using the color palette defined by the xyColors object.

Note

Check Chart.autoColor on help.3ds.com/2024.

Parameters:¶

lines=0¶: A Boolean defining whether color distribution affects curve lines.
symbols=0¶: A Boolean defining whether color distribution affects curve symbols.

autoSymbol()[source]¶: This method distributes the symbols on all curves displayed in the chart.

axes1 : --is-rst--:py:class:`~typing.List`\ \[:py:class:`~abaqus.XY.Axis.Axis`] = [][source]¶: An AxisArray object specifying a read-only sequence of axis objects displayed as axes1 - the abscissa for a Cartesian chart.

axes2 : --is-rst--:py:class:`~typing.List`\ \[:py:class:`~abaqus.XY.Axis.Axis`] = [][source]¶: An AxisArray object specifying a read-only sequence of axis objects displayed as axes2 - the ordinate for a Cartesian chart.

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

fitCurves()[source]¶

This method resets the transform of the chart.

It cancels any zoom or pan action.

getAxis1(curve, quantityType)[source]¶

This method returns the Axis object used for displaying the Axis1 of the XYCurve specified by name or object or used for the given QuantityType object.

Note

Check Chart.getAxis1 on help.3ds.com/2024.

Parameters:¶

curve¶: The name or the XYCurve object associated to the Axis object.
quantityType¶: The QuantityType object associated to the Axis object.

Returns:¶

An Axis object.

Return type:¶

Axis

Raises:¶

XypError – Curve not found, If the given XYCurve is not used in the Chart.
TypeError – If both arguments are specified.
ValueError – QuantityType not found, If the given QuantityType is not used in the Chart.

getAxis2(curve, quantityType)[source]¶

This method returns the Axis object used for displaying the Axis2 of the XYCurve specified by name or object or used for the given QuantityType object.

Note

Check Chart.getAxis2 on help.3ds.com/2024.

Parameters:¶

curve¶: The name or the XYCurve object associated to the Axis object.
quantityType¶: The QuantityType object associated to the Axis object.

Returns:¶

An Axis object.

Return type:¶

Axis

Raises:¶

XypError – Curve not found, If the given XYCurve is not used in the Chart.
TypeError –
- If both arguments are specified.
ValueError – QuantityType not found, - If the given QuantityType is not used in the Chart.

gridArea : --is-rst--:py:class:`~abaqus.XY.Area.Area` = <abaqus.XY.Area.Area object>[source]¶: An Area object specifying how to display the grid area.

legend : --is-rst--:py:class:`~abaqus.XY.Legend.Legend` = <abaqus.XY.Legend.Legend object>[source]¶: A Legend object specifying the attributes for the legend of the chart.

majorAxis1GridStyle : --is-rst--:py:class:`~abaqus.XY.LineStyle.LineStyle` = <abaqus.XY.LineStyle.LineStyle object>[source]¶: A LineStyle object specifying the line properties to be used when drawing major gridlines along axis 1.

majorAxis2GridStyle : --is-rst--:py:class:`~abaqus.XY.LineStyle.LineStyle` = <abaqus.XY.LineStyle.LineStyle object>[source]¶: A LineStyle object specifying the line properties to be used when drawing major gridlines along axis 2.

minorAxis1GridStyle : --is-rst--:py:class:`~abaqus.XY.LineStyle.LineStyle` = <abaqus.XY.LineStyle.LineStyle object>[source]¶: A LineStyle object specifying the line properties to be used when drawing minor gridlines along axis 1.

minorAxis2GridStyle : --is-rst--:py:class:`~abaqus.XY.LineStyle.LineStyle` = <abaqus.XY.LineStyle.LineStyle object>[source]¶: A LineStyle object specifying the line properties to be used when drawing minor gridlines along axis 2.

moveAxisDown(axis)[source]¶

This method moves the relative position of the given Axis object down in the axis sequence of the Chart.

Note

Check Chart.moveAxisDown on help.3ds.com/2024.

Parameters:¶

axis¶: The Axis object to be moved.

moveAxisUp(axis)[source]¶

This method moves the relative position of the given Axis object up in the axis sequence of the Chart.

Note

Check Chart.moveAxisUp on help.3ds.com/2024.

Parameters:¶

axis¶: The Axis object to be moved.

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

removeCurve(curve)[source]¶

This method removes the given XYCurve from the Chart.

Note

Check Chart.removeCurve on help.3ds.com/2024.

Parameters:¶

curve¶: The XYCurve name or the XYCurve object or a sequence of XYCurve names or XYCurve objects to be removed from the Chart.

setValues( chart=None, curvesToPlot=(), aspectRatio=None, transform=(), view=None, useQuantityType=1, )[source]¶

This method modifies the Chart object.

Note

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

Parameters:¶

chart=None¶: A Chart object from which attributes are to be copied.
curvesToPlot=()¶: A sequence of Strings specifying the names of the curves to plot. In addition to this type, the argument can also be one of the following:A String specifying the name of the curve to plot.An XYCurve object specifying the curve to plot.A sequence of XYCurve objects specifying the curves to plot (as returned by the curveSet method).
aspectRatio=None¶: A Float specifying the aspect ratio of the grid area. A value of -1 specifies that the gridArea will take up all available space. The default value is −1.
transform=()¶: A sequence of Floats specifying a transformation matrix used to scale or pan along the axes of the Chart.
view=None¶: A View object.
useQuantityType=1¶: A Boolean specifying whether to use the QuantityType to associate curves with axes. The default value is ON.

Raises:¶

RangeError –

tagAreaStyle : --is-rst--:py:class:`~abaqus.XY.AreaStyle.AreaStyle` = <abaqus.XY.AreaStyle.AreaStyle object>[source]¶: An AreaStyle object specifying the area properties to be used when creating tags.

tagBorder : --is-rst--:py:class:`~abaqus.XY.LineStyle.LineStyle` = <abaqus.XY.LineStyle.LineStyle object>[source]¶: A LineStyle object specifying the tag area border properties to be used when creating tags.

tagTextStyle : --is-rst--:py:class:`~abaqus.XY.TextStyle.TextStyle` = <abaqus.XY.TextStyle.TextStyle object>[source]¶: A TextStyle object specifying the text properties to be used when creating tags.

transform : --is-rst--:py:class:`tuple`\ \[:py:class:`float`, :py:data:`...<Ellipsis>`] = ()[source]¶: A tuple of Floats specifying a transformation matrix used to scale or pan along the axes of the Chart.

useQuantityType : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to use the QuantityType to associate curves with axes. The default value is ON.

class Legend[source]¶

Bases: object

The Legend object is used to store the display attributes of the chart legend. A legend object is automatically created when creating a Chart object.

Note

This object can be accessed by:

import visualization
session.charts[name].legend
session.defaultChartOptions.legend
session.xyPlots[name].charts[name].legend

Note

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

Member Details:

area : --is-rst--:py:class:`~abaqus.XY.Area.Area` = <abaqus.XY.Area.Area object>[source]¶: An Area object specifying the area of the legend.

numDigits : --is-rst--:py:class:`int` = 2[source]¶: An Int specifying the number of significant digits displayed for the minimum and maximum values. Possible values are 1 to 7. The default value is 2.

numberFormat : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'AUTOMATIC'[source]¶: A SymbolicConstant specifying how the minimum and maximum values are formatted. Possible values are AUTOMATIC, DECIMAL, SCIENTIFIC, and ENGINEERING. The default value is AUTOMATIC.

setValues( legend, show=1, showMinMax=0, title='', numberFormat=AUTOMATIC, numDigits=2, textStyle=None, titleStyle=None, )[source]¶

This method modifies the Legend object.

Note

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

Parameters:¶

legend¶: A Legend object from which attributes are to be copied.
show=1¶: A Boolean specifying whether to show the legend. The default value is ON.
showMinMax=0¶: A Boolean specifying whether to display the minimum and maximum values. The default value is OFF.
title=''¶: A String specifying the title to appear on the legend. The default value is an empty string.
numberFormat=AUTOMATIC¶: A SymbolicConstant specifying how the minimum and maximum values are formatted. Possible values are AUTOMATIC, DECIMAL, SCIENTIFIC, and ENGINEERING. The default value is AUTOMATIC.
numDigits=2¶: An Int specifying the number of significant digits displayed for the minimum and maximum values. Possible values are 1 to 7. The default value is 2.
textStyle=None¶: A TextStyle object specifying the text properties used to display the legend text.
titleStyle=None¶: A TextStyle object specifying the text properties used to display the legend title.

show : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to show the legend. The default value is ON.

showMinMax : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to display the minimum and maximum values. The default value is OFF.

textStyle : --is-rst--:py:class:`~abaqus.XY.TextStyle.TextStyle` = <abaqus.XY.TextStyle.TextStyle object>[source]¶: A TextStyle object specifying the text properties used to display the legend text.

title : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the title to appear on the legend. The default value is an empty string.

titleStyle : --is-rst--:py:class:`~abaqus.XY.TextStyle.TextStyle` = <abaqus.XY.TextStyle.TextStyle object>[source]¶: A TextStyle object specifying the text properties used to display the legend title.

class XYCurve[source]¶

Bases: object

The XYCurve object is used to plot X - Y data and to store its display attributes.

Note

This object can be accessed by:

import visualization
session.charts[name].axes1[i].axisData.curves[i]
session.charts[name].axes2[i].axisData.curves[i]
session.charts[name].curves[name]
session.curves[name]
session.defaultChartOptions.defaultAxis1Options.axisData.curves[i]
session.defaultChartOptions.defaultAxis2Options.axisData.curves[i]
session.xyPlots[name].charts[name].axes1[i].axisData.curves[i]
session.xyPlots[name].charts[name].axes2[i].axisData.curves[i]
session.xyPlots[name].charts[name].curves[name]
session.xyPlots[name].curves[name]

Note

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

Member Details:

Curve(name, data)[source]¶

This method creates an XYCurve object from an XYData object.

Note

This function can be accessed by:

session.Curve

Note

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

Parameters:¶

name¶: A String specifying the repository key.
data¶: An XYData object specifying the data for the curve.

Returns:¶

An XYCurve object.

Return type:¶

XYCurve

data : --is-rst--:py:class:`~abaqus.XY.XYData.XYData` | :py:obj:`None` = None[source]¶: An XYData object specifying the data for the curve.

displayTypes : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]¶: A tuple of SymbolicConstants specifying that describe how curves are to be displayed. Possible values are LINE and SYMBOL. The default value is (LINE).

legendLabel : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the label to be displayed in the legend. By default, the label is system defined.

legendSource : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'CURVE_LEGEND'[source]¶: A SymbolicConstant specifying how the system supplied, default legend label is to be generated. Possible values are CURVE_LEGEND, CURVE_NAME, and CURVE_NAME_LEGEND. The default value is CURVE_LEGEND.

lineStyle : --is-rst--:py:class:`~abaqus.XY.LineStyle.LineStyle` = <abaqus.XY.LineStyle.LineStyle object>[source]¶: A LineStyle object specifying the line properties used to display the curve.

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

setValues(displayTypes=None, legendLabel='', symbolFrequency=1, useDefault=1)[source]¶

This method modifies the XYCurve object.

Note

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

Parameters:¶

displayTypes=None¶: A sequence of SymbolicConstants specifying that describe how curves are to be displayed. Possible values are LINE and SYMBOL. The default value is (LINE).
legendLabel=''¶: A String specifying the label to be displayed in the legend. By default, the label is system defined.
symbolFrequency=1¶: An Int specifying the frequency of plotting the markers. Possible values are symbolFrequency > 0. If symbolFrequency = 1, then markers are plotted at every point. The default value is 1.
useDefault=1¶: A Boolean specifying whether to use the system supplied legend label. The default value is ON.

symbolFrequency : --is-rst--:py:class:`int` = 1[source]¶: An Int specifying the frequency of plotting the markers. Possible values are symbolFrequency > 0. If symbolFrequency = 1, then markers are plotted at every point. The default value is 1.

symbolStyle : --is-rst--:py:class:`~abaqus.XY.SymbolStyle.SymbolStyle` = <abaqus.XY.SymbolStyle.SymbolStyle object>[source]¶: A SymbolStyle object specifying the symbol properties used to display the curve.

useDefault : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to use the system supplied legend label. The default value is ON.

class DefaultChartOptions[source]¶

Bases: object

The DefaultChartOptions object is used to hold on default chart and axis attributes. The DefaultChartOptions object attributes are used whenever Chart or Axis are created. A DefaultChartOptions object is automatically created when opening a session.

Note

This object can be accessed by:

import visualization
session.defaultChartOptions

Note

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

Member Details:

areaStyle : --is-rst--:py:class:`~abaqus.XY.AreaStyle.AreaStyle` = <abaqus.XY.AreaStyle.AreaStyle object>[source]¶

setValues( areaStyle, aspectRatio=None, defaultAxis1Options=None, defaultAxis2Options=None, gridArea=None, legend=None, majorAxis1GridStyle=None, majorAxis2GridStyle=None, minorAxis1GridStyle=None, minorAxis2GridStyle=None, tagAreaStyle=None, tagBorder=None, tagTextStyle=None, useQuantityType=1, )[source]¶

This method modifies the DefaultChartOptions object.

Note

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

Parameters:¶

areaStyle¶: An AreaStyle object specifying an AreaStyle used to hold on to the default display properties for the chart area.
aspectRatio=None¶: A Float specifying the default aspect ratio of the grid area. A value of -1 specifies that the gridArea will take up all available space. The default value is −1.
defaultAxis1Options=None¶: An Axis object specifying an Axis object used to hold on to the default properties for direction 1 axes—the abscissa for a Cartesian chart.
defaultAxis2Options=None¶: An Axis object specifying an Axis object used to hold on to the default properties for direction 2 axes—the ordinate for a Cartesian chart.
gridArea=None¶: An Area object specifying how to display the grid area by default.
legend=None¶: A Legend object specifying the default attributes for the legend of the chart.
majorAxis1GridStyle=None¶: A LineStyle object specifying the default line properties to be used when drawing major gridlines along axis 1.
majorAxis2GridStyle=None¶: A LineStyle object specifying the default line properties to be used when drawing major gridlines along axis 2.
minorAxis1GridStyle=None¶: A LineStyle object specifying the default line properties to be used when drawing minor gridlines along axis 1.
minorAxis2GridStyle=None¶: A LineStyle object specifying the default line properties to be used when drawing minor gridlines along axis 2.
tagAreaStyle=None¶: An AreaStyle object specifying the default area properties to be used when creating tags.
tagBorder=None¶: A LineStyle object specifying the default tag area border properties to be used when creating tags.
tagTextStyle=None¶: A TextStyle object specifying the default text properties to be used when creating tags.
useQuantityType=1¶: A Boolean specifying whether to use the QuantityType to associate curves with axes. The default value is ON.

class DefaultPlot[source]¶

Bases: object

The DefaultPlot object is used to hold on default plot attributes. The DefaultPlot object attributes are used whenever an XYPlot object is created. A DefaultPlot object is automatically created when opening a session.

Note

This object can be accessed by:

import visualization
session.defaultPlot

Note

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

Member Details:

area : --is-rst--:py:class:`~abaqus.XY.Area.Area` = <abaqus.XY.Area.Area object>[source]¶: An Area object specifying an Area used to hold on to the default display properties for the plot area.

title : --is-rst--:py:class:`~abaqus.XY.Title.Title` = <abaqus.XY.Title.Title object>[source]¶: A Title object specifying a Title object used to hold on to the default properties of the XY-Plot title.

class Title[source]¶

Bases: object

The Title object is used to store the display attributes of the XYPlot title. An Title object is automatically created when creating a XYPlot object.

Note

This object can be accessed by:

import visualization
session.defaultPlot.title
session.xyPlots[name].title

Note

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

Member Details:

area : --is-rst--:py:class:`~abaqus.XY.Area.Area` = <abaqus.XY.Area.Area object>[source]¶: An Area object specifying the area of the title.

setValues(title, text='', area=None, useDefault=0, titleStyle=None)[source]¶

This method modifies the Title object.

Note

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

Parameters:¶

title¶: A Title object from which attributes are to be copied.
text=''¶: A String specifying the text to appear as a title. By default the title is set to the XYPlot object name. The default value is an empty string.
area=None¶: An Area object specifying the area of the title.
useDefault=0¶: A Boolean specifying whether to show the default title. The default value is OFF.
titleStyle=None¶: A TextStyle object specifying the text properties used to display the legend title.

text : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the text to appear as a title. By default the title is set to the XYPlot object name. The default value is an empty string.

titleStyle : --is-rst--:py:class:`~abaqus.XY.TextStyle.TextStyle` = <abaqus.XY.TextStyle.TextStyle object>[source]¶: A TextStyle object specifying the text properties used to display the legend title.

useDefault : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to show the default title. The default value is OFF.

class SymbolStyle(color='', show=1, marker=FILLED_CIRCLE, size=2)[source]¶

Bases: object

The SymbolStyle object is used to define the marker properties to be used when drawing curves. SymbolStyle objects can be created using the methods described below.

Note

This object can be accessed by:

import visualization
session.charts[name].axes1[i].axisData.curves[i].symbolStyle
session.charts[name].axes2[i].axisData.curves[i].symbolStyle
session.charts[name].curves[name].symbolStyle
session.curves[name].symbolStyle
session.defaultChartOptions.defaultAxis1Options.axisData.curves[i].symbolStyle
session.defaultChartOptions.defaultAxis2Options.axisData.curves[i].symbolStyle
session.xyPlots[name].charts[name].axes1[i].axisData.curves[i].symbolStyle
session.xyPlots[name].charts[name].axes2[i].axisData.curves[i].symbolStyle
session.xyPlots[name].charts[name].curves[name].symbolStyle
session.xyPlots[name].curves[name].symbolStyle

Note

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

Member Details:

color : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the color to be used when drawing a marker with this SymbolStyle object. The default value is “White”.

marker : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'FILLED_CIRCLE'[source]¶

FILLED_CIRCLE
FILLED_SQUARE
FILLED_DIAMOND
FILLED_TRI
HOLLOW_CIRCLE
HOLLOW_SQUARE
HOLLOW_DIAMOND
HOLLOW_TRI
CROSS
XMARKER
POINT

The default value is FILLED_CIRCLE.

setValues(color='', show=1, marker=FILLED_CIRCLE, size=2)[source]¶

This method modifies the SymbolStyle object.

Note

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

Parameters:¶

color=''¶

A String specifying the color to be used when drawing a marker with this SymbolStyle object. The default value is “White”.

show=1¶

A Boolean specifying whether to draw the marker when using this SymbolStyle object. The default value is ON.

marker=FILLED_CIRCLE¶

A SymbolicConstant specifying the marker type be used when drawing symbols using this SymbolStyle object. Possible values are:

FILLED_CIRCLE
FILLED_SQUARE
FILLED_DIAMOND
FILLED_TRI
HOLLOW_CIRCLE
HOLLOW_SQUARE
HOLLOW_DIAMOND
HOLLOW_TRI
CROSS
XMARKER
POINT

The default value is FILLED_CIRCLE.

size=2¶

A Float specifying the marker size to be used when drawing markers using this SymbolStyle object. The default value is 2.0.

show : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to draw the marker when using this SymbolStyle object. The default value is ON.

size : --is-rst--:py:class:`float` = 2[source]¶: A Float specifying the marker size to be used when drawing markers using this SymbolStyle object. The default value is 2.0.

class XYData( data: tuple = (), name: str = '', sourceDescription: str = '', contentDescription: str = '', positionDescription: str = '', legendLabel: str = '', xValuesLabel: str = '', yValuesLabel: str = '', axis1QuantityType: QuantityType | None = None, axis2QuantityType: QuantityType | None = None, )[source]¶

class XYData(objectToCopy: XYData)

Bases: tuple

The XYData object is used to store values and attributes associated with XYData type objects. XYData objects can be created using the methods described below. The methods accessed via the Session object cause the XYData object to be added to the session.xyData repository. Temporary XYData objects will be created if no name is supplied. Temporary XYData objects will be added to the session.xyData repository but automatically deleted when they are not used anymore. Temporary XYData objects are also created as a result of math operations found in the abaqusMath module.

Note

This object can be accessed by:

import visualization
session.charts[name].axes1[i].axisData.curves[i].data
session.charts[name].axes2[i].axisData.curves[i].data
session.charts[name].curves[name].data
session.curves[name].data
session.defaultChartOptions.defaultAxis1Options.axisData.curves[i].data
session.defaultChartOptions.defaultAxis2Options.axisData.curves[i].data
import odbAccess
session.odbs[name].userData.xyDataObjects[name]
session.xyDataObjects[name]
session.xyPlots[name].charts[name].axes1[i].axisData.curves[i].data
session.xyPlots[name].charts[name].axes2[i].axisData.curves[i].data
session.xyPlots[name].charts[name].curves[name].data
session.xyPlots[name].curves[name].data

Note

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

Member Details:

XYDataFromFile( fileName, name='', sourceDescription='', contentDescription='', positionDescription='', legendLabel='', xValuesLabel='', yValuesLabel='', axis1QuantityType=None, axis2QuantityType=None, xField=1, yField=2, skipFrequency=None, )[source]¶

This method creates an XYData object from data in an ASCII file.

Note

This function can be accessed by:

session.XYDataFromFile
xyPlot.XYDataFromFile

Parameters:¶

fileName¶: A String specifying the name of the file from which the X - Y data will be read.
name=''¶: The repository key. If the name is not supplied, a default name in the form _temp#_ is generated and the XYData object is temporary.
sourceDescription=''¶: A String specifying the source of the X - Y data (e.g., “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.
contentDescription=''¶: A String specifying the content of the X - Y data (e.g., “field 1 vs. field 2”). The default value is an empty string.
positionDescription=''¶: A String specifying additional information about the X - Y data (e.g., “for whole model”). The default value is an empty string.
legendLabel=''¶: A String specifying the label to be used in the legend. The default value is the name of the XYData object.
xValuesLabel=''¶: A String specifying the label for the X-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.
yValuesLabel=''¶: A String specifying the label for the Y-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.
axis1QuantityType=None¶: A QuantityType object specifying the QuantityType object associated to the X -axis1- values.
axis2QuantityType=None¶: A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.
xField=1¶: An Int specifying the field from which the X data will be read. Fields are delimited by spaces, tabs, or commas. The default value is 1.
yField=2¶: An Int specifying the field from which the Y data will be read. Fields are delimited by spaces, tabs, or commas. The default value is 2.
skipFrequency=None¶: An Int specifying how often data rows will be skipped. A skipFrequency of 1 means skip every other row. The first row is always read. Possible values are skipFrequency ≥ 0. The default value is 0 (data are read from every row).

Returns:¶

An XYData object.

Return type:¶

XYData

Raises:¶

InvalidNameError –
RangeError –

XYDataFromFreeBody( odb, force=1, moment=0, heatFlowRate=0, resultant=1, comp1=0, comp2=0, comp3=0, )[source]¶

This method creates a list of XYData objects by computing free body data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromFreeBody
xyPlot.XYDataFromFreeBody

Note

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

Parameters:¶

odb¶: An Odb object specifying the output database from which data will be read.
force=1¶: A boolean indicating whether to compute the force. The default is ON.
moment=0¶: A boolean indicating whether to compute the moment. The default is OFF.
heatFlowRate=0¶: A boolean indicating whether to compute the heat flow rate resultant magnitude. It is extracted only for viewcut based freebodies. The default is OFF.
resultant=1¶: A boolean indicating whether to compute the resultant. It applies only to force and moment. The default is ON.
comp1=0¶: A boolean indicating whether to compute the first component. It applies only to force and moment. The default is OFF.
comp2=0¶: A boolean indicating whether to compute the second component. It applies only to force and moment. The default is OFF.
comp3=0¶: A boolean indicating whether to compute the third component. It applies only to force and moment. The default is OFF.

Returns:¶

A list of XYData objects.

Return type:¶

list[XYData]

Raises:¶

InvalidNameError –
RangeError –

XYDataFromHistory( odb, outputVariableName, steps, name='', sourceDescription='', contentDescription='', positionDescription='', legendLabel='', skipFrequency=None, numericForm=REAL, complexAngle=0, stepTuple=None, )[source]¶

This method creates an XYData object by reading history data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromHistory
xyPlot.XYDataFromHistory

Note

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

Parameters:¶

odb¶: An Odb object specifying the output database from which data will be read.
outputVariableName¶: A String specifying the output variable from which the X - Y data will be read.
steps¶: A sequence of Strings specifying the names of the steps from which data will be extracted.
name=''¶: The repository key. If the name is not supplied, a default name in the form _temp#_ is generated and the XYData object is temporary (this argument is required if the method is accessed from the session object).
sourceDescription=''¶: A String specifying the source of the X - Y data (for example, “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.
contentDescription=''¶: A String specifying the content of the X - Y data (for example, “field 1 vs. field 2”). The default value is an empty string.
positionDescription=''¶: A String specifying additional information about the X - Y data (for example, “for whole model”). The default value is an empty string.
legendLabel=''¶: A String specifying the label to be used in the legend. The default value is the name of the XYData object.
skipFrequency=None¶: An Int specifying how often data frames will be skipped. If skipFrequency = 1, Abaqus will skip every other frame. The first frame is always read. Possible values are skipFrequency ≥ 0. The default value is 0 (data are read from every frame).
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, and COMPLEX_VAL_AT_ANGLE. The default value is REAL.
complexAngle=0¶: A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.
stepTuple=None¶: A tuple of Integers specifying the steps to include when extracting data.

Returns:¶

An XYData object.

Return type:¶

XYData

Raises:¶

InvalidNameError –
RangeError –

XYDataFromPath( path, name, includeIntersections, shape, pathStyle, numIntervals, labelType, viewport='', removeDuplicateXYPairs=True, includeAllElements=False, step=None, frame=None, variable=None, deformedMag=None, numericForm=REAL, complexAngle=0, projectOntoMesh=False, projectionTolerance=0, )[source]¶

This method creates an XYData object from path information.

Note

This function can be accessed by:

session.XYDataFromPath
xyPlot.XYDataFromPath

Note

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

Parameters:¶

path¶

A Path object to use in X - Y data generation.

name¶

A String specifying the repository key:for session ‘name’ is required argument and for xyPlot ‘name’ is optional argument.

includeIntersections¶

A Boolean specifying whether to include X - Y data for the intersections between the path and element faces or edges. The default value is False.

shape¶

A SymbolicConstant specifying the model shape to use. Possible values are UNDEFORMED and DEFORMED.

pathStyle¶

A SymbolicConstant specifying the path style. Possible values are PATH_POINTS and UNIFORM_SPACING.

numIntervals¶

An Int specifying the number of uniform-spacing intervals. The default value is 10.

labelType¶

viewport=''¶

A String specifying the viewport name or an Int specifying the viewport id from which to obtain values. The default is the current viewport.

removeDuplicateXYPairs=True¶

A Boolean specifying whether to remove duplicate XY values from the final result. The default value is True.

Added in version 2018: The removeDuplicateXYPairs argument was added.

includeAllElements=False¶

A Boolean specifying whether to include elements which do not lie in the direction of the path. The default value is False.

Added in version 2018: The includeAllElements argument was added.

step=None¶

An Int identifying the step from which to obtain values. The default value is the current step.

frame=None¶

An Int identifying the frame from which to obtain values. The default value is the current frame.

variable=None¶

A tuple of tuples containing the descriptions of variables for which to extract data along the path. The default value is the current variable. Each tuple specifies the following:Variable label: A String specifying the variable; for example, ‘U’.Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:A String specifying the category selection label.A String specifying the section point label.For example:

variable = ('S',INTEGRATION_POINT, ((COMPONENT, 'S22' ), ), )
variable = (('S',INTEGRATION_POINT, ((COMPONENT, 'S11' ), ), ),
            ('U',NODAL,((COMPONENT, 'U1'),)),)
variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises' ), ),
            {'shell < STEEL > < 3 section points >':'SNEG,
            (fraction = -1.0)', }), )

deformedMag=None¶

A tuple of three Floats specifying the deformation magnitude in the X-, Y-, and Z- planes. The default value is (1, 1, 1).

numericForm=REAL¶

complexAngle=0¶

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

projectOntoMesh=False¶

A Boolean to specify whether to consider the data points that do not lie on or inside the mesh. The default value is False.

projectionTolerance=0¶

A Float specifying the tolerance value for the projected distance considered for the data extraction when projectOntoMesh = True. The default value is 0.

Returns:¶

If **variable specified has one fieldoutput** (Returns an XYData object.)
If **variable specified has more than one fieldoutputs** (Returns list of XYData objects.)

Raises:¶

ErrorPathNotFound – Path not found, If path is invalid.
ErrorCurrentVPNotFound – If viewport is invalid.
ErrorInvalidUserStepAndFrame – If step and/or frame are invalid.
ErrorNoVarInPathExtract – If the variable argument is empty.
ErrorUnavailableSelectedVariable – If the specified output variable is not available in the output database.
ErrorUnusableVarInPathExtract – If the specified output variable cannot be used to obtain X - Y data from path.
ErrorUnsupportedRefinementType – If the SymbolicConstant specifying the refinement type is invalid.
ErrorInvalidRefinementSpecification – If the label specifying the refinement invariant or component is invalid.
ErrorDeformedMagTupleInPathExtract – If deformedMag does not contain three Floats.

XYDataFromShellThickness( odb, outputPosition, variable, elementSets=(), elementLabels=(), nodeSets=(), nodeLabels=(), numericForm=REAL, complexAngle=0, )[source]¶

This method creates a list of XYData objects by reading through the thickness field data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromShellThickness
xyPlot.XYDataFromShellThickness

Note

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

Parameters:¶

odb¶

An Odb object specifying the output database from which data will be read.

outputPosition¶

A SymbolicConstant specifying the position from which output will be read. Possible values are ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, and NODAL.

variable¶

A tuple of tuples containing the descriptions of variables for which to extract data from the field. Each tuple specifies the following:

Variable label: A String specifying the variable; for example, ‘U’.
Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.
Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:
- Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.
- Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.
Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:
- A String specifying the category selection label.
- A String specifying the section point label.

For example:

variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
            ('U', NODAL,((COMPONENT, 'U1'), )), )
variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
             {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )

elementSets=()¶

A sequence of Strings specifying element sets or a String specifying a single element set.

elementLabels=()¶

A sequence of expressions specifying element labels per part instance in the model. Each part instance element expression is a sequence of a String specifying the part instance name and a sequence of element expressions; for example, ((‘partInstance1’,(1,’7’,’3:15;3’),), (‘partInstance2’,’8’),)). The element expressions can be any of the following:An Int specifying a single element label; for example, 1.A String specifying a single element label; for example, ‘7’.A String specifying a sequence of element labels; for example, ‘3:5’ and ‘3:15:3’.

nodeSets=()¶

A sequence of Strings specifying node sets or a String specifying a single node set.

nodeLabels=()¶

A sequence of expressions specifying node labels per part instance in the model. Each part instance node expression is a sequence of a String specifying the part instance name and a sequence of node expressions; for example, ((‘partInstance1’,(1,’7’,’3:15;3’),), (‘partInstance2’,’8’),)). The node expressions can be any of the following:An Int specifying a single node label; for example, 1.A String specifying a single node label; for example, ‘7’.A String specifying a sequence of node labels; for example, ‘3:5’ and ‘3:15:3’.

numericForm=REAL¶

complexAngle=0¶

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

Returns:¶

A list of XYData objects.

Return type:¶

list[XYData]

Raises:¶

InvalidNameError –
RangeError –

axis1QuantityType : --is-rst--:py:class:`~abaqus.XY.QuantityType.QuantityType` | :py:obj:`None` = None[source]¶: A QuantityType object specifying the QuantityType object associated to the X -axis1- values.

axis2QuantityType : --is-rst--:py:class:`~abaqus.XY.QuantityType.QuantityType` | :py:obj:`None` = None[source]¶: A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.

contentDescription : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the content of the X - Y data (e.g., “field 1 vs. field 2”). The default value is an empty string.

data : --is-rst--:py:class:`tuple`[source]¶: A sequence of pairs of Floats specifying the X - Y data pairs.

description : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the complete description of the XYData object.

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

legendLabel : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the label to be used in the legend. The default value is the name of the XYData object.

name : --is-rst--:py:class:`str` = ''[source]¶: The repository key. If the name is not supplied while creating the XYData object using xyPlot.XYData, a default name in the form _temp#_ is generated and the XYData object is temporary. (This argument is required if the method is accessed from the session object.)

positionDescription : --is-rst--:py:class:`str` = ''[source]¶: A String specifying additional information about the X - Y data (e.g., “for whole model”). The default value is an empty string.

save()[source]¶

This method saves a temporary XYData.

The name of the XYData is changed to “XYData-#”. If the XYData is already saved, nothing is done.

setValues( sourceDescription='', contentDescription='', positionDescription='', legendLabel='', xValuesLabel='', yValuesLabel='', axis1QuantityType=None, axis2QuantityType=None, )[source]¶

This method modifies the XYData object.

Note

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

Parameters:¶

sourceDescription=''¶: A String specifying the source of the X - Y data (e.g., “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.
contentDescription=''¶: A String specifying the content of the X - Y data (e.g., “field 1 vs. field 2”). The default value is an empty string.
positionDescription=''¶: A String specifying additional information about the X - Y data (e.g., “for whole model”). The default value is an empty string.
legendLabel=''¶: A String specifying the label to be used in the legend. The default value is the name of the XYData object.
xValuesLabel=''¶: A String specifying the label for the X-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.
yValuesLabel=''¶: A String specifying the label for the Y-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.
axis1QuantityType=None¶: A QuantityType object specifying the QuantityType object associated to the X -axis1- values.
axis2QuantityType=None¶: A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.

sourceDescription : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the source of the X - Y data (e.g., “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.

sourceType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]¶: A SymbolicConstant specifying the source type of the XYData object. Possible values are FROM_ODB, FROM_KEYBOARD, FROM_ASCII_FILE, FROM_OPERATION, and FROM_USER_DEFINED.

xValuesLabel : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the label for the X-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.

This method creates a list of XYData objects by reading field data from an Odb object.

Note

This function can be accessed by:

session.xyDataListFromField
xyPlot.xyDataListFromField

Note

Check XYData.xyDataListFromField on help.3ds.com/2024.

Parameters:¶

odb¶

An Odb object specifying the output database from which data will be read.

outputPosition¶

A SymbolicConstant specifying the position from which output will be read. Possible values are ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, and NODAL.

variable¶

A tuple of tuples containing the descriptions of variables for which to extract data from the field. Each tuple specifies the following:

Variable label: A String specifying the variable; for example, ‘U’.
Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.
Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:
- Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.
- Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.
Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:
- A String specifying the category selection label.
- A String specifying the section point label.

For example:

variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
            ('U', NODAL,((COMPONENT, 'U1'), )), )
variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
             {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )

elementSets=()¶

A sequence of Strings specifying element sets or a String specifying a single element set.

elementLabels=()¶

An Int specifying a single element label; for example, 1.
A String specifying a single element label; for example, ‘7’.
A String specifying a sequence of element labels; for example, ‘3:5’ and ‘3:15:3’.

nodeSets=()¶

A sequence of Strings specifying node sets or a String specifying a single node set.

nodeLabels=()¶

An Int specifying a single node label; for example, 1.A
String specifying a single node label; for example, ‘7’.
A String specifying a sequence of node labels; for example, ‘3:5’ and ‘3:15:3’.

numericForm=REAL¶

complexAngle=0¶

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

operator=None¶

Returns:¶

A list of XYData objects.

Return type:¶

list[XYData]

Raises:¶

InvalidNameError –
RangeError –

yValuesLabel : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the label for the Y-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.

XYDataFromFile( fileName, name='', sourceDescription='', contentDescription='', positionDescription='', legendLabel='', xValuesLabel='', yValuesLabel='', axis1QuantityType=None, axis2QuantityType=None, xField=1, yField=2, skipFrequency=None, )[source]¶

This method creates an XYData object from data in an ASCII file.

Note

This function can be accessed by:

session.XYDataFromFile
xyPlot.XYDataFromFile

Note

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

Parameters:¶

fileName¶: A String specifying the name of the file from which the X - Y data will be read.
name=''¶: The repository key. If the name is not supplied, a default name in the form _temp#_ is generated and the XYData object is temporary.
sourceDescription=''¶: A String specifying the source of the X - Y data (e.g., “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.
contentDescription=''¶: A String specifying the content of the X - Y data (e.g., “field 1 vs. field 2”). The default value is an empty string.
positionDescription=''¶: A String specifying additional information about the X - Y data (e.g., “for whole model”). The default value is an empty string.
legendLabel=''¶: A String specifying the label to be used in the legend. The default value is the name of the XYData object.
xValuesLabel=''¶: A String specifying the label for the X-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.
yValuesLabel=''¶: A String specifying the label for the Y-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.
axis1QuantityType=None¶: A QuantityType object specifying the QuantityType object associated to the X -axis1- values.
axis2QuantityType=None¶: A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.
xField=1¶: An Int specifying the field from which the X data will be read. Fields are delimited by spaces, tabs, or commas. The default value is 1.
yField=2¶: An Int specifying the field from which the Y data will be read. Fields are delimited by spaces, tabs, or commas. The default value is 2.
skipFrequency=None¶: An Int specifying how often data rows will be skipped. A skipFrequency of 1 means skip every other row. The first row is always read. Possible values are skipFrequency ≥ 0. The default value is 0 (data are read from every row).

Returns:¶

An XYData object.

Return type:¶

XYData

Raises:¶

InvalidNameError –
RangeError –

XYDataFromFreeBody( odb, force=1, moment=0, heatFlowRate=0, resultant=1, comp1=0, comp2=0, comp3=0, )[source]¶

This method creates a list of XYData objects by computing free body data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromFreeBody
xyPlot.XYDataFromFreeBody

Note

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

Parameters:¶

odb¶: An Odb object specifying the output database from which data will be read.
force=1¶: A boolean indicating whether to compute the force. The default is ON.
moment=0¶: A boolean indicating whether to compute the moment. The default is OFF.
heatFlowRate=0¶: A boolean indicating whether to compute the heat flow rate resultant magnitude. It is extracted only for viewcut based freebodies. The default is OFF.
resultant=1¶: A boolean indicating whether to compute the resultant. It applies only to force and moment. The default is ON.
comp1=0¶: A boolean indicating whether to compute the first component. It applies only to force and moment. The default is OFF.
comp2=0¶: A boolean indicating whether to compute the second component. It applies only to force and moment. The default is OFF.
comp3=0¶: A boolean indicating whether to compute the third component. It applies only to force and moment. The default is OFF.

Returns:¶

A list of XYData objects.

Return type:¶

list[XYData]

Raises:¶

InvalidNameError –
RangeError –

XYDataFromHistory( odb, outputVariableName, steps, name='', sourceDescription='', contentDescription='', positionDescription='', legendLabel='', skipFrequency=None, numericForm=REAL, complexAngle=0, stepTuple=None, )[source]¶

This method creates an XYData object by reading history data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromHistory
xyPlot.XYDataFromHistory

Note

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

Parameters:¶

odb¶: An Odb object specifying the output database from which data will be read.
outputVariableName¶: A String specifying the output variable from which the X - Y data will be read.
steps¶: A sequence of Strings specifying the names of the steps from which data will be extracted.
name=''¶: The repository key. If the name is not supplied, a default name in the form _temp#_ is generated and the XYData object is temporary (this argument is required if the method is accessed from the session object).
sourceDescription=''¶: A String specifying the source of the X - Y data (for example, “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.
contentDescription=''¶: A String specifying the content of the X - Y data (for example, “field 1 vs. field 2”). The default value is an empty string.
positionDescription=''¶: A String specifying additional information about the X - Y data (for example, “for whole model”). The default value is an empty string.
legendLabel=''¶: A String specifying the label to be used in the legend. The default value is the name of the XYData object.
skipFrequency=None¶: An Int specifying how often data frames will be skipped. If skipFrequency = 1, Abaqus will skip every other frame. The first frame is always read. Possible values are skipFrequency ≥ 0. The default value is 0 (data are read from every frame).
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, and COMPLEX_VAL_AT_ANGLE. The default value is REAL.
complexAngle=0¶: A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_VAL_AT_ANGLE. The default value is 0.
stepTuple=None¶: A tuple of Integers specifying the steps to include when extracting data.

Returns:¶

An XYData object.

Return type:¶

XYData

Raises:¶

InvalidNameError –
RangeError –

This method creates an XYData object from path information.

Note

This function can be accessed by:

session.XYDataFromPath
xyPlot.XYDataFromPath

Note

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

Parameters:¶

path¶

A Path object to use in X - Y data generation.

name¶

A String specifying the repository key:for session ‘name’ is required argument and for xyPlot ‘name’ is optional argument.

includeIntersections¶

A Boolean specifying whether to include X - Y data for the intersections between the path and element faces or edges. The default value is False.

shape¶

A SymbolicConstant specifying the model shape to use. Possible values are UNDEFORMED and DEFORMED.

pathStyle¶

A SymbolicConstant specifying the path style. Possible values are PATH_POINTS and UNIFORM_SPACING.

numIntervals¶

An Int specifying the number of uniform-spacing intervals. The default value is 10.

labelType¶

viewport=''¶

A String specifying the viewport name or an Int specifying the viewport id from which to obtain values. The default is the current viewport.

removeDuplicateXYPairs=True¶

A Boolean specifying whether to remove duplicate XY values from the final result. The default value is True.

Added in version 2018: The removeDuplicateXYPairs argument was added.

includeAllElements=False¶

A Boolean specifying whether to include elements which do not lie in the direction of the path. The default value is False.

Added in version 2018: The includeAllElements argument was added.

step=None¶

An Int identifying the step from which to obtain values. The default value is the current step.

frame=None¶

An Int identifying the frame from which to obtain values. The default value is the current frame.

variable=None¶

variable = ('S',INTEGRATION_POINT, ((COMPONENT, 'S22' ), ), )
variable = (('S',INTEGRATION_POINT, ((COMPONENT, 'S11' ), ), ),
            ('U',NODAL,((COMPONENT, 'U1'),)),)
variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises' ), ),
            {'shell < STEEL > < 3 section points >':'SNEG,
            (fraction = -1.0)', }), )

deformedMag=None¶

A tuple of three Floats specifying the deformation magnitude in the X-, Y-, and Z- planes. The default value is (1, 1, 1).

numericForm=REAL¶

complexAngle=0¶

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

projectOntoMesh=False¶

A Boolean to specify whether to consider the data points that do not lie on or inside the mesh. The default value is False.

projectionTolerance=0¶

A Float specifying the tolerance value for the projected distance considered for the data extraction when projectOntoMesh = True. The default value is 0.

Returns:¶

If **variable specified has one fieldoutput** (Returns an XYData object.)
If **variable specified has more than one fieldoutputs** (Returns list of XYData objects.)

Raises:¶

ErrorPathNotFound – Path not found, If path is invalid.
ErrorCurrentVPNotFound – If viewport is invalid.
ErrorInvalidUserStepAndFrame – If step and/or frame are invalid.
ErrorNoVarInPathExtract – If the variable argument is empty.
ErrorUnavailableSelectedVariable – If the specified output variable is not available in the output database.
ErrorUnusableVarInPathExtract – If the specified output variable cannot be used to obtain X - Y data from path.
ErrorUnsupportedRefinementType – If the SymbolicConstant specifying the refinement type is invalid.
ErrorInvalidRefinementSpecification – If the label specifying the refinement invariant or component is invalid.
ErrorDeformedMagTupleInPathExtract – If deformedMag does not contain three Floats.

XYDataFromShellThickness( odb, outputPosition, variable, elementSets=(), elementLabels=(), nodeSets=(), nodeLabels=(), numericForm=REAL, complexAngle=0, )[source]¶

This method creates a list of XYData objects by reading through the thickness field data from an Odb object.

Note

This function can be accessed by:

session.XYDataFromShellThickness
xyPlot.XYDataFromShellThickness

Note

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

Parameters:¶

odb¶

An Odb object specifying the output database from which data will be read.

outputPosition¶

A SymbolicConstant specifying the position from which output will be read. Possible values are ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, and NODAL.

variable¶

A tuple of tuples containing the descriptions of variables for which to extract data from the field. Each tuple specifies the following:

Variable label: A String specifying the variable; for example, ‘U’.
Variable output position: A SymbolicConstant specifying
the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.
Refinement: A tuple specifying the refinement. If
the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:
- Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.
- Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.
Location: An optional Dictionary specifying the location. The
dictionary contains pairs of the following:
- A String specifying the category selection label.
- A String specifying the section point label.

For example:

variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
            ('U', NODAL,((COMPONENT, 'U1'), )), )
variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
                {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )

elementSets=()¶

A sequence of Strings specifying element sets or a String specifying a single element set.

elementLabels=()¶

nodeSets=()¶

A sequence of Strings specifying node sets or a String specifying a single node set.

nodeLabels=()¶

numericForm=REAL¶

complexAngle=0¶

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

Returns:¶

A list of XYData objects.

Return type:¶

list[XYData]

Raises:¶

InvalidNameError –
RangeError –

This method creates a list of XYData objects by reading field data from an Odb object.

Note

This function can be accessed by:

session.xyDataListFromField
xyPlot.xyDataListFromField

Note

Check XYDataCommands.xyDataListFromField on help.3ds.com/2024.

Parameters:¶

odb¶

An Odb object specifying the output database from which data will be read.

outputPosition¶

A SymbolicConstant specifying the position from which output will be read. Possible values are ELEMENT_CENTROID, ELEMENT_NODAL, INTEGRATION_POINT, and NODAL.

variable¶

A tuple of tuples containing the descriptions of variables for which to extract data from the field. Each tuple specifies the following:

Variable label: A String specifying the variable; for example, ‘U’.
Variable output position: A SymbolicConstant specifying the output position. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.
Refinement: A tuple specifying the refinement. If the refinement tuple is omitted, data are written for all components and invariants (if applicable). This element is required if the location dictionary (the following element in the tuple) is included. The refinement tuple contains the following:
- Type: A SymbolicConstant specifying the type of refinement. Possible values are INVARIANT and COMPONENT.
- Label: A String specifying the invariant or the component; for example, ‘Mises’ or ‘S22’.
Location: An optional Dictionary specifying the location. The dictionary contains pairs of the following:
- A String specifying the category selection label.
- A String specifying the section point label.

For example:

variable = ('S', INTEGRATION_POINT, ((COMPONENT, 'S22'), ), )
variable = (('S', INTEGRATION_POINT, ((COMPONENT, 'S11'), ), ),
            ('U', NODAL,((COMPONENT, 'U1'), )), )
variable = (('S', INTEGRATION_POINT, ((INVARIANT, 'Mises'), ),
             {'shell < STEEL > < 3 section points >': 'SNEG, (fraction = -1.0)', }), )

elementSets=()¶

A sequence of Strings specifying element sets or a String specifying a single element set.

elementLabels=()¶

An Int specifying a single element label; for example, 1.
A String specifying a single element label; for example, ‘7’.
A String specifying a sequence of element labels; for example, ‘3:5’ and ‘3:15:3’.

nodeSets=()¶

A sequence of Strings specifying node sets or a String specifying a single node set.

nodeLabels=()¶

An Int specifying a single node label; for example, 1.A
String specifying a single node label; for example, ‘7’.
A String specifying a sequence of node labels; for example, ‘3:5’ and ‘3:15:3’.

numericForm=REAL¶

complexAngle=0¶

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

operator=None¶

Returns:¶

A list of XYData objects.

Return type:¶

list[XYData]

Raises:¶

InvalidNameError –
RangeError –

class XYPlot(name)[source]¶

Bases: XYPlotBase

Member Details:

static AreaStyle(color='', fill=1, style=SOLID)[source]¶

This method creates an AreaStyle.

Note

This function can be accessed by:

session.AreaStyle
xyPlot.AreaStyle

Note

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

Parameters:¶

color=''¶: A String specifying the color to be used when filling an area with this AreaStyle object. The default value is “White”.
fill=1¶: A Boolean specifying whether to fill the area when using this AreaStyle. The default value is ON.
style=SOLID¶: A SymbolicConstant specifying the area pattern style to be used when filling an area using this AreaStyle. The default value is SOLID.

Returns:¶

An AreaStyle object.

Return type:¶

AreaStyle

Raises:¶

ColorError –

static LineStyle(color='', show=1, style=SOLID, thickness=0)[source]¶

This method creates a LineStyle.

Note

This function can be accessed by:

session.LineStyle
xyPlot.LineStyle

Note

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

Parameters:¶

color=''¶: A String specifying the color to be used when drawing a line with this LineStyle object. The default value is “White”.
show=1¶: A Boolean specifying whether to draw the line when using this LineStyle. The default value is ON.
style=SOLID¶: A SymbolicConstant specifying the line style to be used when drawing lines using this LineStyle. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.
thickness=0¶: A Float specifying the line thickness in mm to be used when drawing lines using this LineStyle. The default value is 0.2.

Returns:¶

A LineStyle object.

Return type:¶

LineStyle

Raises:¶

ColorError –

static QuantityType(label='', type=NONE)[source]¶

This method creates a QuantityType object.

Note

This function can be accessed by:

session.QuantityType
xyPlot.QuantityType

Note

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

Parameters:¶

label=''¶

A String specifying the label for this quantity type.

type=NONE¶

A SymbolicConstant specifying the physical dimension of the axis. Possible values are:

NONE.
ACCELERATION.
ACOUSTIC_INTENSITY.
ANGLE.
ANGULAR_MOMENTUM.
ARC_LENGTH.
AREA.
AREA_VELOCITY_SQUARED, specifying “Velocity squared per area”.
BIMOMENT.
CURVATURE.
CORIOLIS_LOAD.
DAMAGE.
DAMAGE_CRITERION.
DENSITY.
DENSITY_ROTATIONAL_ACCELERATION, specifying “Density * Angular acceleration”.
DISPLACEMENT.
ECURRENT_AREA_TIME, specifying “Time integrated electric current per area”.
ELECTRIC_CHARGE.
ELECTRIC_CURRENT.
ELECTRIC_CURRENT_AREA, specifying “Electric current per unit area”.
ELECTRIC_POTENTIAL.
ENERGY.
ENERGY_DENSITY.
ENERGY_RELEASE_RATE.
EPOTENTIAL_GRADIENT, specifying “Electric potential gradient”.
FREQUENCY.
FORCE.
FORCE_VOLUME, specifying “Force per volume”.
HEAT_FLUX.
HEAT_FLUX_AREA, specifying “Heat flux per area”.
HEAT_FLUX_RATE.
HEAT_FLUX_VOLUME, specifying “Heat flux per volume”.
LENGTH.
LINEAR_PRESSURE.
LUMIN, specifying “Luminous intensity”.
MASS.
MASS_FLOW_AREA, specifying “Mass flow per area”.
MASS_FLOW_AREA_RATE, specifying “Mass flow rate per area”.
MASS_FLOW_RATE.
MODE_NUMBER.
MOMENT.
NUMBER.
PATH.
PHASE.
POSITION.
PRESSURE.
PRESSURE_GRADIENT.
RATE.
ROTARY_INERTIA.
ROTATIONAL_ACCELERATION.
ROTATIONAL_VELOCITY.
STATUS.
STRAIN.
STRAIN_RATE.
STRESS.
STRESS_INTENS_FACTOR, specifying “Stress intensity factor”.
SUBSTANCE, specifying “Amount of substance”.
TEMPERATURE.
THICKNESS.
TIME.
TIME_INCREMENT.
TIME_HEAT_FLUX, specifying “Time integrated heat flux”.
TIME_HEAT_FLUX_AREA, specifying “Time integrated heat flux per area”.
TIME_VOLUME, specifying “Time integrated volume”.
TIME_VOLUME_FLUX, specifying “Time integrated volume flux per area”.
TWIST.
VELOCITY.
VELOCITY_SQUARED.
VOLUME.
VOLUME_FLUX.
VOLUME_FLUX_AREA, specifying “Volume flux per area”.
VOLUME_FRACTION.

The default value is NONE

Returns:¶

A QuantityType object.

Return type:¶

QuantityType

static SymbolStyle(color='', show=1, marker=FILLED_CIRCLE, size=2)[source]¶

This method creates a SymbolStyle object.

Note

This function can be accessed by:

session.SymbolStyle
xyPlot.SymbolStyle

Note

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

Parameters:¶

color=''¶

A String specifying the color to be used when drawing a marker with this SymbolStyle object. The default value is “White”.

show=1¶

A Boolean specifying whether to draw the marker when using this SymbolStyle object. The default value is ON.

marker=FILLED_CIRCLE¶

A SymbolicConstant specifying the marker type be used when drawing symbols using this SymbolStyle object. Possible values are:

FILLED_CIRCLE
FILLED_SQUARE
FILLED_DIAMOND
FILLED_TRI
HOLLOW_CIRCLE
HOLLOW_SQUARE
HOLLOW_DIAMOND
HOLLOW_TRI
CROSS
XMARKER
POINT

The default value is FILLED_CIRCLE.

size=2¶

A Float specifying the marker size to be used when drawing markers using this SymbolStyle object. The default value is 2.0.

Returns:¶

A SymbolStyle object.

Return type:¶

SymbolStyle

Raises:¶

ColorError –

static TextStyle(color='', show=1, font='', rotationAngle=0)[source]¶

This method creates a TextStyle.

Note

This function can be accessed by:

session.TextStyle
xyPlot.TextStyle

Note

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

Parameters:¶

color=''¶: A String specifying the color to be used when drawing text with this TextStyle object. The default value is “White”.
show=1¶: A Boolean specifying whether to draw the text when using this TextStyle object. The default value is ON.
font=''¶: A String specifying the name of the font to be used when drawing text with this TextStyle object. The default value is “--verdana-medium-r-normal---120---p---“.
rotationAngle=0¶: A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

Returns:¶

A TextStyle object.

Return type:¶

TextStyle

Raises:¶

ColorError –

static XYData(data: tuple, name: str = '')[source]¶
static XYData(objectToCopy: XYData)
static XYData(*args, **kwargs)

class XYPlotBase(name)[source]¶

Bases: object

The XYPlot object is used to display Chart objects.

Note

This object can be accessed by:

import visualization
session.xyPlots[name]

Note

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

Member Details:

area : --is-rst--:py:class:`~abaqus.XY.Area.Area` = <abaqus.XY.Area.Area object>[source]¶: An Area object specifying position, padding, background and borders of the XYPlot object.

autoColor(lines=0, symbols=0)[source]¶

This method distributes the colors on all curves displayed in the XYPlot using the color palette defined by the xyColors AutoColors object.

Note

Check XYPlotBase.autoColor on help.3ds.com/2024.

Parameters:¶

lines=0¶: A Boolean defining whether color distribution affects curve lines.
symbols=0¶: A Boolean defining whether color distribution affects curve symbols.

autoSymbol()[source]¶: This method distributes the symbols on all curves displayed in the XYPlot.

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

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

fitCurves()[source]¶

This method resets the transform of all the charts of the XYPlot object.

It cancels any zoom or pan action.

next(drawImmediately=False)[source]¶

This method restores the transform member of the active Chart object to the next setting in the transform list. (There is a list of eight transforms stored for each chart.) If there is no next transform, no action is taken.

Note

Check XYPlotBase.next on help.3ds.com/2024.

Parameters:¶

drawImmediately=False¶: A Boolean specifying the viewport should refresh immediately after the command is processed. This is typically only used when writing a script and it is desirable to show intermediate results before the script completes. The default value is False.

previous(drawImmediately=False)[source]¶

This method restores the transform member of the active Chart object to the previous setting in the transform list. (There is a list of eight transforms stored for each chart.) If there is no next transform, no action is taken.

Note

Check XYPlotBase.previous on help.3ds.com/2024.

Parameters:¶

drawImmediately=False¶: A Boolean specifying the viewport should refresh immediately after the command is processed. This is typically only used when writing a script and it is desirable to show intermediate results before the script completes. The default value is False.

setValues(title, transform)[source]¶

This method modifies the XYPlot object.

Note

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

Parameters:¶

title¶: A Title object specifying the title of the XYPlot object.
transform¶: A sequence of Floats specifying a transformation matrix used to scale or pan along the axes of the active Chart object of this XYPlot.

title : --is-rst--:py:class:`~abaqus.XY.Title.Title` = <abaqus.XY.Title.Title object>[source]¶: A Title object specifying the title of the XYPlot object.

transform : --is-rst--:py:class:`tuple`\ \[:py:class:`float`, :py:data:`...<Ellipsis>`] = ()[source]¶: A tuple of Floats specifying a transformation matrix used to scale or pan along the axes of the active Chart object of this XYPlot.

class XYReportOptions[source]¶

Bases: object

The XYReportOptions object stores settings used by the writeXYReport method when you write an XYData object to an ASCII file. The XYReportOptions object has no constructor. Abaqus creates the xyReportOptions member when you import the Visualization module.

Note

This object can be accessed by:

import visualization
session.defaultXYReportOptions
session.xyReportOptions

Note

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

Member Details:

setValues( pageWidth=80, numDigits=6, interpolation=0, xyData=1, totals=0, minMax=0, pageWidthLimited=0, numberFormat=ENGINEERING, layout=SINGLE_TABLE, )[source]¶

This method modifies the XYReportOptions object.

Note

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

Parameters:¶

pageWidth=80¶: An Int specifying the number of characters per line of the report file when pageWidthLimited = ON. Possible values are pageWidth > 0. The default value is 80.
numDigits=6¶: An Int specifying the number of significant digits to be included for each data value in the report file. Possible values are 0 ≤ numDigits ≤ 9. The default value is 6.
interpolation=0¶: A Boolean specifying whether to perform linear interpolation for missing data values. The default value is OFF.
xyData=1¶: A Boolean specifying whether to print the X and Y values of the selected XYData objects. (If xyData = OFF, totals and minMax can still be printed.) The default value is ON.
totals=0¶: A Boolean specifying whether to print the sum of the Y values of the selected XYData objects. The default value is OFF.
minMax=0¶: A Boolean specifying whether to print the minimum and maximum X and Y values of the selected XYData objects. The default value is OFF.
pageWidthLimited=0¶: A Boolean specifying whether the page width is limited. The default value is OFF.
numberFormat=ENGINEERING¶: A SymbolicConstant specifying the number format to be used in reporting XYData objects. Possible values are AUTOMATIC, ENGINEERING, and SCIENTIFIC. The default value is ENGINEERING.
layout=SINGLE_TABLE¶: A SymbolicConstant specifying the format used in reporting the XYData objects. Possible values are SINGLE_TABLE and SEPARATE_TABLES. The default value is SINGLE_TABLE.

Raises:¶

RangeError –

If xyData, total, and minMax are all OFF: At least one of the data print methods must be selected

class XYSessionBase[source]¶

Bases: SessionBase

The following commands operate on Session objects. For more information about the Session object, see Session object.

Note

This object can be accessed by:

import visualization

Note

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

Member Details:

getLimitForXYDataPlots()[source]¶

This method is used to get the limit for number of XY data objects while creating XYData from field output.

Returns:¶: Int specifying the limit for number of XY data objects.
Return type:¶: int

getPathTolerance()[source]¶

This method is used to get the tolerance used when creating XYData objects by extracting results along Path objects.

Returns:¶: A Double specifying the tolerance.
Return type:¶: float

linearizeStress( name, path, startPoint, endPoint, modelShape, components, xyMembraneComps, xyBendingComps, invariantBendingComps=(), intervals=40, radiusOfCurvature=None, oopRadiusOfCurvature=None, curvatureCorrection=0, curvatureCsys='', useCurvatureCsysForOrient=0, saveXy=0, useMaxStressValue=0, writeReport=0, reportFile='', appendToFile=0, saveToPath=0, )[source]¶

This method is used to perform stress linearization along a defined stress line.

Note

Check XYSessionBase.linearizeStress on help.3ds.com/2024.

Parameters:¶

name¶

A String specifying the name of the stress line.

path¶

APath object specifying the end points of the stress line. Note: You must provide either the path argument or the startPoint and endPoint arguments.

startPoint¶

A String specifying a part instance and a node belonging to that part instance, or a sequence of three Floats specifying the coordinates of a point.

endPoint¶

A String specifying a part instance and a node belonging to that part instance, or a sequence of three Floats specifying the coordinates of a point.

modelShape¶

A SymbolicConstant specifying the model shape to be used for obtaining coordinates of the intermediate points along the stress line. Possible values are UNDEFORMED and DEFORMED. When DEFORMED is selected, the deformation scale factor is always set to a uniform value of 1.0.

components¶

A sequence of Strings specifying the linearized stress components to be displayed in the xyPlot object. Possible values are “S11”, “S22”, “S33”, “S12”, “S23”, and “S13”. Note: You must provide at least one of the components , xyMembraneComps , and xyBendingComps arguments.

xyMembraneComps¶

A sequence of Strings specifying the linearized stress membrane components to be displayed in the xyPlot object. Possible values are “S11”, “S22”, “S33”, “S12”, “S23”, and “S13”.

xyBendingComps¶

A sequence of Strings specifying the linearized stress bending components to be displayed in the xyPlot object. Possible values are “S11”, “S22”, “S33”, “S12”, “S23”, and “S13”.

invariantBendingComps=()¶

A sequence of Strings specifying the linearized stress bending components to be included in the computation of the linearized stress invariants. Possible values are “S11”, “S22”, “S33”, “S12”, “S23”, and “S13”. The default value of the sequence includes all the possible values.

intervals=40¶

An Int specifying the number of equally-spaced intervals into which the stress line is to be divided. The default value is 40.

radiusOfCurvature=None¶

A Float specifying the in-plane radius of curvature of the center section along the stress line for axi-symmetric models. The default value is ∞∞.

oopRadiusOfCurvature=None¶

A Float specifying the out-of-plane radius of curvature of the center section along the Stress Line for axi-symmetric models. The default value forces Abaqus to compute the radius of curvature.

curvatureCorrection=0¶

A Boolean specifying whether the out-of-plane curvature correction should be applied for non-axisymmetric models when performing linearized stress computations. Curvature correction is always applied for axisymmetric models. The default value is OFF.

curvatureCsys=''¶

A String specifying the name of the user-defined local coordinate system to be used for computing the out-of-plane radius of curvature for non-axisymmetric models when curvatureCorrection =ON . The default value uses the global coordinate system to compute the out-of-plane radius of curvature.

useCurvatureCsysForOrient=0¶

A Boolean specifying whether to use the user-defined local coordinate system to compute the local stress line orientation for non-axisymmetric models when curvatureCorrection =ON and curvatureCsys is specified. The default value is OFF.

saveXy=0¶

A Boolean specifying whether to save the xyData objects created during the stress linearization operation to the session. The default value is OFF .

useMaxStressValue=0¶

A Boolean specifying whether to use the maximum stress value from available multiple values at a point. The default value is OFF.

Added in version 2024: The argument useMaxStressValue was added.

writeReport=0¶

A Boolean specifying whether to write the output from the stress linearization operation to a text file. The default value is ON .

reportFile=''¶

A String specifying the report file name. The default value is “linearStress.rpt”.

appendToFile=0¶

A Boolean specifying whether to append output from the stress linearization to the text file specified by the reportFile argument. The default value is ON .

saveToPath=0¶

A Boolean specifying whether to create a Path object containing all the points used when performing the linearized stress computation. The default value is OFF . When this argument is set to ON , a Path object is created with the same name as that of the stress line and placed in the Path repository.

Returns:¶

A list of xyData objects.

Return type:¶

list[XYData]

Raises:¶

TextError – The stress line passes through incompatible part instances. Results cannot be extracted.
TextError – Specified variables cannot be used for extracting results along the stress line.
TextError – Results for all the points along the stress line were not found. Selected end points and all intermediate sample points must lie within the current display group, and within solid continuum elements. Due to tolerance limitations, intermediate points lying on display group boundaries may fail to meet this criterion. Choose new end points, adjust the number of intervals along the line, or modify the current display group to obtain the stress linearization plot.

setLimitForXYDataPlots(limit=None)[source]¶

This method is used to set the limit for number of XY data objects while creating XYData from field output.

Note

Check XYSessionBase.setLimitForXYDataPlots on help.3ds.com/2024.

Parameters:¶

limit=None¶: None or an Int specifying the limit for number of XY data objects. The default value is no limit

Return type:¶

None .

setPathTolerance(tolerance=1e-05)[source]¶

This method is used to set the tolerance to be used when creating XYData objects by extracting results along Path objects. This command should be exercised with caution since setting a value too low or too high may result in getting no results or unpredictable results.

Note

Check XYSessionBase.setPathTolerance on help.3ds.com/2024.

Parameters:¶

tolerance=1e-05¶: A Double specifying the tolerance. The default value is 0.00001.

Return type:¶

None .

writeXYReport(fileName, xyData, appendMode=1)[source]¶

This method writes an XYData object to a user-defined ASCII file.

Note

This function can be accessed by:

session.writeXYReport

Note

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

Parameters:¶

fileName¶: A String specifying the name of the file to which X - Y data will be written.
xyData¶: A sequence of XYData objects to be written to the output file.
appendMode=1¶: A Boolean specifying whether to append the X - Y data to the existing file. The default value is ON.