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=()¶

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¶

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.

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=()¶

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¶

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.

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¶