XYData object

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.

The following topics are discussed:

Access

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

XYData(...)

This method creates an XYData object from a sequence of X–Y data pairs.

Path

session.XYData

xyPlot.XYData

Required arguments

data

A sequence of pairs of Floats specifying the X–Y data pairs.

Optional arguments

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

A QuantityType object specifying the QuantityType object associated to the X -axis1- values.

axis2QuantityType

A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.

Return value

An XYData object.

Exceptions

InvalidNameError.

XYData(...)

This method creates an XYData object by copying an existing XYData object.

Path

session.odbs[name].userData.XYData

session.XYData

xyPlot.XYData

Required arguments

objectToCopy

An XYData object to be copied.

Optional arguments

The optional arguments are the same as the optional arguments to the XYData method.

Return value

An XYData object.

Exceptions

InvalidNameError.

XYDataFromFile(...)

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

Path

session.XYDataFromFile

xyPlot.XYDataFromFile

Required arguments

fileName

A String specifying the name of the file from which the X–Y data will be read.

Optional arguments

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

A QuantityType object specifying the QuantityType object associated to the X -axis1- values.

axis2QuantityType

A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.

xField

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

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

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

Return value

An XYData object.

Exceptions

InvalidNameError and RangeError.

XYDataFromHistory(...)

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

Path

session.XYDataFromHistory

xyPlot.XYDataFromHistory

Required arguments

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.

Optional arguments

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

skipFrequency

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

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

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.

Return value

An XYData object.

Exceptions

InvalidNameError and RangeError.

xyDataListFromField(...)

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

Path

session.xyDataListFromField

xyPlot.xyDataListFromField

Required arguments

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)', }), )

Optional arguments

At least one of the following arguments elementSets, elementLabels, nodeSets, and nodeLabels is required.

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

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

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.

Return value

A list of XYData objects.

Exceptions

InvalidNameError and RangeError.

XYDataFromFreeBody(...)

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

Path

session.XYDataFromFreeBody

xyPlot.XYDataFromFreeBody

Required arguments

odb

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

Optional arguments

force

A boolean indicating whether to compute the force. The default is ON.

moment

A boolean indicating whether to compute the moment. The default is OFF.

heatFlowRate

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

A boolean indicating whether to compute the resultant. It applies only to force and moment. The default is ON.

comp1

A boolean indicating whether to compute the first component. It applies only to force and moment. The default is OFF.

comp2

A boolean indicating whether to compute the second component. It applies only to force and moment. The default is OFF.

comp3

A boolean indicating whether to compute the third component. It applies only to force and moment. The default is OFF.

Return value

A list of XYData objects.

Exceptions

InvalidNameError and RangeError.

XYDataFromShellThickness(...)

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

Path

xyPlot.XYDataFromShellThickness

Required arguments

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)', }), )

Optional arguments

At least one of the following arguments elementSets, elementLabels, nodeSets, and nodeLabels is required.

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

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

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.

Return value

A list of XYData objects.

Exceptions

InvalidNameError and RangeError.

XYDataFromPath(...)

This method creates an XYData object from path information.

Path

session.XYDataFromPath

xyPlot.XYDataFromPath

Required arguments

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

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.

Optional arguments

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.

step

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

frame

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

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

numericForm

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

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.

Return value

If variable specified has one fieldoutput: Returns an XYData object.

If variable specified has more than one fieldoutputs: Returns list of XYData objects.

Exceptions

If path is invalid:

ErrorPathNotFound: Path not found.

If viewport is invalid:

ErrorCurrentVPNotFound: Current viewport not found.

If step and/or frame are invalid:

ErrorInvalidUserStepAndFrame: The user step and frame specified have not been defined.

If the variable argument is empty:

ErrorNoVarInPathExtract: No variable selection for XY data extraction from path.

If the specified output variable is not available in the output database:

ErrorUnavailableSelectedVariable: The selected variable is not available for the current frame.

If the specified output variable cannot be used to obtain X–Y data:

ErrorUnusableVarInPathExtract: Specified variable cannot be used in XY data extraction from path.

If the SymbolicConstant specifying the refinement type is invalid:

ErrorUnsupportedRefinementType: Unsupported refinement type.

If the label specifying the refinement invariant or component is invalid:

ErrorInvalidRefinementSpecification: Invalid refinement specification.

If deformedMag does not contain three Floats:

ErrorDeformedMagTupleInPathExtract: Deformed magnification tuple must contain X, Y and Z values.

save()

This method saves a temporary XYData. The name of the XYData is changed to "XYData-#". If the XYData is already saved, nothing is done.

Arguments

None.

Return value

None.

Exceptions

None.

setValues(...)

This method modifies the XYData object.

Required arguments

None.

Optional arguments

The optional arguments to setValues are the same as the arguments to the XYData method, except for the name argument.

Return value

None.

Exceptions

None.

Members

The XYData object has members with the same names and descriptions as the arguments to the XYData method.

In addition, the XYData object has the following members:

sourceType

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.

fileName

A String specifying the source file name of the XYData object.

description

A String specifying the complete description of the XYData object.