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

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.
XYDataFromFile(fileName[, name, ...])	This method creates an XYData object from data in an ASCII file.
XYDataFromFreeBody(odb[, force, moment, ...])	This method creates a list of XYData objects by computing free body data from an Odb object.
XYDataFromHistory(odb, outputVariableName, steps)	This method creates an XYData object by reading history data from an Odb object.
XYDataFromPath(path, name, ...[, viewport, ...])	This method creates an XYData object from path information.
xyDataListFromField(odb, outputPosition, ...)	This method creates a list of XYData objects by reading field data from an Odb object.

XYData

static AreaStyle(color: str = '', fill: BooleanType = 1, style: SymbolicConstantType = 'SOLID') → AreaStyle

This method creates an AreaStyle.

Parameters:

color

A String specifying the color to be used when filling an area with this AreaStyle object. The default value is “White”.

fill

A Boolean specifying whether to fill the area when using this AreaStyle. The default value is ON.

style

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.

Raises:

ColorError

Notes

This function can be accessed by:

session.AreaStyle
xyPlot.AreaStyle

static LineStyle(color: str = '', show: BooleanType = 1, style: SymbolicConstantType = 'SOLID', thickness: float = 0) → LineStyle

This method creates a LineStyle.

Parameters:

color

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

show

A Boolean specifying whether to draw the line when using this LineStyle. The default value is ON.

style

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

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.

Raises:

ColorError

Notes

This function can be accessed by:

session.LineStyle
xyPlot.LineStyle

static QuantityType(label: str = '', type: SymbolicConstantType | None = None) → QuantityType

This method creates a QuantityType object.

Parameters:

label

A String specifying the label for this quantity type.

type

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.

Notes

This function can be accessed by:

session.QuantityType
xyPlot.QuantityType

static SymbolStyle(color: str = '', show: BooleanType = 1, marker: SymbolicConstantType = 'FILLED_CIRCLE', size: float = 2) → SymbolStyle

This method creates a SymbolStyle object.

Parameters:

color

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

show

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

marker

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

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.

Raises:

ColorError

Notes

This function can be accessed by:

session.SymbolStyle
xyPlot.SymbolStyle

static TextStyle(color: str = '', show: BooleanType = 1, font: str = '', rotationAngle: float = 0) → TextStyle

This method creates a TextStyle.

Parameters:

color

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

show

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

A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

Returns:

A TextStyle object.

Raises:

ColorError

Notes

This function can be accessed by:

session.TextStyle
xyPlot.TextStyle

XYDataFromFile(fileName: str, name: str = '', sourceDescription: str = '', contentDescription: str = '', positionDescription: str = '', legendLabel: str = '', xValuesLabel: str = '', yValuesLabel: str = '', axis1QuantityType: QuantityType | None = None, axis2QuantityType: QuantityType | None = None, xField: int = 1, yField: int = 2, skipFrequency: int | None = None)

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

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

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

Returns:

An XYData object

Notes

This function can be accessed by:

session.XYDataFromFile
xyPlot.XYDataFromFile

XYDataFromFreeBody(odb: Odb, force: BooleanType = 1, moment: BooleanType = 0, heatFlowRate: BooleanType = 0, resultant: BooleanType = 1, comp1: BooleanType = 0, comp2: BooleanType = 0, comp3: BooleanType = 0)

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

Parameters:

odb

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

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.

Returns:

A python:list of XYData objects

Notes

This function can be accessed by:

session.XYDataFromFreeBody
xyPlot.XYDataFromFreeBody

XYDataFromHistory(odb: Odb, outputVariableName: str, steps: tuple, name: str = '', sourceDescription: str = '', contentDescription: str = '', positionDescription: str = '', legendLabel: str = '', skipFrequency: int | None = None, numericForm: SymbolicConstantType = 'REAL', complexAngle: float = 0, stepTuple: int | None = None)

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

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

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.

Returns:

An XYData object

Notes

This function can be accessed by:

session.XYDataFromHistory
xyPlot.XYDataFromHistory

XYDataFromPath(path: Path, name: str, includeIntersections: BooleanType, shape: SymbolicConstantType, pathStyle: SymbolicConstantType, numIntervals: int, labelType: SymbolicConstantType, viewport: str = '', removeDuplicateXYPairs: BooleanType = True, includeAllElements: BooleanType = False, step: int | None = None, frame: int | None = None, variable: SymbolicConstantType | None = None, deformedMag: float | None = None, numericForm: SymbolicConstantType = 'REAL', complexAngle: float = 0, projectOntoMesh: BooleanType = False, projectionTolerance: float = 0)

This method creates an XYData object from path information.

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

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

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

includeAllElements

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

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.

projectOntoMesh

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

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 python:list of XYData objects.

Raises:

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

Notes

This function can be accessed by:

session.XYDataFromPath
xyPlot.XYDataFromPath

xyDataListFromField(odb: Odb, outputPosition: SymbolicConstantType, variable: tuple[tuple[str, abaqusConstants.SymbolicConstantType, tuple[abaqusConstants.SymbolicConstantType, str]]], elementSets: tuple = (), elementLabels: tuple = (), nodeSets: tuple = (), nodeLabels: tuple = (), numericForm: SymbolicConstantType = 'REAL', complexAngle: float = 0, operator: SymbolicConstantType | None = None) → list['XYData']

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

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)’, }), ) (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

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.

operator

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 python:list of XYData objects

Notes

This function can be accessed by:

session.xyDataListFromField
xyPlot.xyDataListFromField

Object features

XY features for Session

class XYSessionBase

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

Notes

This object can be accessed by:

import visualization

Methods

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

getLimitForXYDataPlots()

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.

getPathTolerance()

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.

linearizeStress(name: str, path: str, startPoint: str, endPoint: str, modelShape: SymbolicConstantType, components: tuple, xyMembraneComps: tuple, xyBendingComps: tuple, invariantBendingComps: tuple = (), intervals: int = 40, radiusOfCurvature: float | None = None, oopRadiusOfCurvature: float | None = None, curvatureCorrection: BooleanType = 0, curvatureCsys: str = '', useCurvatureCsysForOrient: BooleanType = 0, saveXy: BooleanType = 0, writeReport: BooleanType = 0, reportFile: str = '', appendToFile: BooleanType = 0, saveToPath: BooleanType = 0)

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

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

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

radiusOfCurvature

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

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

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

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

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

writeReport

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

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

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 python:list of xyData objects.

Raises:

• Text Error

  The stress line passes through incompatible part instances. Results cannot be

extracted.

• Text Error

  Specified variables cannot be used for extracting results along the stress line.

• Text Error

  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: int | None = None)

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

Parameters:

limit

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

Returns:

python:None .

setPathTolerance(tolerance: str = 0)

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.

Parameters:

tolerance

A Double specifying the tolerance. The default value is 0.00001.

Returns:

python:None .

Area

class Area

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.

Notes

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

Attributes:

inset: Boolean

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

positionMethod: SymbolicConstant

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

alignment: SymbolicConstant

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: SymbolicConstant

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

width: float

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

height: float

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

widthScale: float

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: float

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.

pl: float

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

pr: float

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

pt: float

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

pb: float

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

style: AreaStyle

An AreaStyle object specifying whether and how to fill the area.

border: LineStyle

A LineStyle object specifying whether and how to draw the border of the area.

origin: tuple[float]

A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the XYPlot.

originOffset: tuple[float]

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

Methods

setValues([area, style, border, ...])

This method modifies the Area object.

setValues(area: ~abaqus.XY.Area.Area | None = None, style: ~abaqus.XY.AreaStyle.AreaStyle = <abaqus.XY.AreaStyle.AreaStyle object>, border: ~abaqus.XY.LineStyle.LineStyle = <abaqus.XY.LineStyle.LineStyle object>, positionMethod: ~abaqusConstants.SymbolicConstantType = 'AUTO_ALIGN', alignment: ~abaqusConstants.SymbolicConstantType = 'BOTTOM_LEFT', sizeMethod: ~abaqusConstants.SymbolicConstantType = 'AUTOMATIC', originOffset: tuple[float] = (), widthScale: float = 1, heightScale: float = 1, inset: ~abaqusConstants.BooleanType = 0, pl: float = 1, pr: float = 1, pt: float = 1, pb: float = 1)

This method modifies the Area object.

Parameters:

area

An Area object from which attributes are to be copied.

style

An AreaStyle object.

border

A LineStyle object.

positionMethod

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

alignment

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

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

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

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

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

pl

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

pr

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

pt

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

pb

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

Raises:

RangeError

AreaStyle

class AreaStyle(color: str = '', fill: BooleanType = 1, style: SymbolicConstantType = 'SOLID')

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.

Notes

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

Methods

setValues([color, fill, style])

This method modifies the AreaStyle object.

setValues(color: str = '', fill: BooleanType = 1, style: SymbolicConstantType = 'SOLID')

This method modifies the AreaStyle object.

Parameters:

color

A String specifying the color to be used when filling an area with this AreaStyle object. The default value is “White”.

fill

A Boolean specifying whether to fill the area when using this AreaStyle. The default value is ON.

style

A SymbolicConstant specifying the area pattern style to be used when filling an area using this AreaStyle. The default value is SOLID.

Axis

class Axis

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.

Notes

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]

Attributes:

labelFrequency: int

An Int specifying the frequency of the labels with respect to the tick marks. The default value is 1.

tickLength: float

A Float specifying the length of the ticks in mm. The default value is 2.0.

placement: SymbolicConstant

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.

tickPlacement: SymbolicConstant

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.

labelPlacement: SymbolicConstant

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.

axisData: AxisData

An AxisData object specifying the numerical data of the axis.

lineStyle: LineStyle

A LineStyle object specifying the line properties used to display the axis.

labelStyle: TextStyle

A TextStyle object specifying the text properties to be used when displaying axis labels.

titleStyle: TextStyle

A TextStyle object specifying the text properties to be used when displaying the axis title.

tickStyle: LineStyle

A LineStyle object specifying the line properties to be used when displaying axis ticks.

Methods

setValues([axis, labelFrequency, ...])

This method modifies the Axis object.

setValues(axis: ~abaqus.XY.Axis.Axis | None = None, labelFrequency: int = 1, labelPlacement: ~abaqusConstants.SymbolicConstantType = 'INSIDE', labelStyle: ~abaqus.XY.TextStyle.TextStyle = <abaqus.XY.TextStyle.TextStyle object>, lineStyle: ~abaqus.XY.LineStyle.LineStyle = <abaqus.XY.LineStyle.LineStyle object>, placement: ~abaqusConstants.SymbolicConstantType = 'MIN_MAX_EDGE', tickLength: float = 2, tickPlacement: ~abaqusConstants.SymbolicConstantType = 'INSIDE', tickStyle: ~abaqus.XY.LineStyle.LineStyle = <abaqus.XY.LineStyle.LineStyle object>, titleStyle: ~abaqus.XY.TextStyle.TextStyle = <abaqus.XY.TextStyle.TextStyle object>)

This method modifies the Axis object.

Parameters:

axis

An Axis object from which attributes are to be copied.

labelFrequency

An Int specifying the frequency of the labels with respect to the tick marks. The default value is 1.

labelPlacement

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

A TextStyle object specifying the text properties to be used when displaying axis labels.

lineStyle

A LineStyle object specifying the line properties used to display the axis.

placement

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

A Float specifying the length of the ticks in mm. The default value is 2.0.

tickPlacement

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

A LineStyle object specifying the line properties to be used when displaying axis ticks.

titleStyle

A TextStyle object specifying the text properties to be used when displaying the axis title.

AxisArray

class AxisArray(iterable=(), /)

Methods

findAt

AxisData

class AxisData

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

Notes

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

Attributes:

dbReference: float

A Float specifying the reference value for decibel computation. The default value is 1.0.

direction: SymbolicConstant

A SymbolicConstant specifying the direction of the axis. Possible values are ABSCISSA and ORDINATE.

labelFormat: SymbolicConstant

A SymbolicConstant specifying how tick labels are formatted. Possible values are AUTOMATIC, DECIMAL, SCIENTIFIC, and ENGINEERING. The default value is AUTOMATIC.

labelNumDigits: int

An Int specifying the number of significant digits displayed for the labels. Possible values are 1 to 7. The default value is 2.

maxAutoCompute: Boolean

A Boolean specifying whether or not to use the automatically computed maximum value for the axis. The default value is ON.

maxAutoValue: float

A Float specifying the maximum value when maxAutoCompute is true.

maxValue: float

A Float specifying the maximum value when maxAutoCompute is false. By default, maxValue is set to maxAutoValue.

maxShownValue: float

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

minAutoCompute: Boolean

A Boolean specifying whether or not to use the automatically computed minimum value for the axis. The default value is ON.

minAutoValue: float

A Float specifying the minimum value when minAutoCompute is true.

minValue: float

A Float specifying the minimum value when minAutoCompute is false. By default, minValue is set to minAutoValue.

minShownValue: float

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

minorTickCount: int

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.

scale: SymbolicConstant

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.

tickMode: SymbolicConstant

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.

tickCount: int

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: int

An Int specifying the number of major ticks effectively shown. This value takes zoom, pan and rounding into account.

tickIncrement: float

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: float

A Float specifying the shown tick increment of the major ticks. This value takes zoom/pan into account.

useSystemTitle: Boolean

A Boolean specifying whether the title to use for the axis title is system defined or user defined. The default value is ON.

curves: XYCurveArray

An Curve`Array object specifying a read-only sequence of Curve objects associated to this axis.

quantityType: QuantityType

A QuantityType object specifying the quantity type: i.e. the physical dimension and associated label of the data represented by this axis.

tickValues: float

A tuple of Floats specifying the read-only major tick values shown.

tickLabels: tuple

A tuple of Strings specifying the read-only major tick labels shown.

systemTitle: str

A String specifying the system title. The system title is based on the quantityType of the axis and associated curves.

title: str

A String specifying the title of the axis. By default, the title is set to the systemTitle.

Methods

setValues([axisData, labelFormat, ...])

This method modifies the AxisData object.

setValues(axisData: AxisData | None = None, labelFormat: SymbolicConstantType = 'AUTOMATIC', labelNumDigits: int = 2, scale: SymbolicConstantType = 'LINEAR', dbReference: float = 1, minAutoCompute: BooleanType = 1, minValue: float | None = None, maxAutoCompute: BooleanType = 1, maxValue: float | None = None, tickMode: SymbolicConstantType = 'AUTOCOMPUTE', tickIncrement: float | None = None, tickCount: int | None = None, minorTickCount: int = 1, title: str = '', useSystemTitle: BooleanType = 1)

This method modifies the AxisData object.

Parameters:

axisData

An AxisData object from which attributes are to be copied.

labelFormat

A SymbolicConstant specifying how tick labels are formatted. Possible values are AUTOMATIC, DECIMAL, SCIENTIFIC, and ENGINEERING. The default value is AUTOMATIC.

labelNumDigits

An Int specifying the number of significant digits displayed for the labels. Possible values are 1 to 7. The default value is 2.

scale

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

A Float specifying the reference value for decibel computation. The default value is 1.0.

minAutoCompute

A Boolean specifying whether or not to use the automatically computed minimum value for the axis. The default value is ON.

minValue

A Float specifying the minimum value when minAutoCompute is false. By default, minValue is set to minAutoValue.

maxAutoCompute

A Boolean specifying whether or not to use the automatically computed maximum value for the axis. The default value is ON.

maxValue

A Float specifying the maximum value when maxAutoCompute is false. By default, maxValue is set to maxAutoValue.

tickMode

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

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

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

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

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

Chart

class Chart

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

Notes

This object can be accessed by:

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

Attributes:

name: str

A String specifying the name of the Chart object.

useQuantityType: Boolean

A Boolean specifying whether to use the QuantityType to associate curves with axes. The default value is ON.

aspectRatio: float

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.

curves: dict[str, XYCurve]

A repository of XYCurve.:py:class:~abaqus.XY.XYCurve.XYCurve` objects specifying a repository of XYCurve.:py:class:~abaqus.XY.XYCurve.XYCurve` objects to display in the Chart.

axes1: AxisArray

An AxisArray object specifying a read-only sequence of axis objects displayed as axes1 - the abscissa for a Cartesian chart.

axes2: AxisArray

An AxisArray object specifying a read-only sequence of axis objects displayed as axes2 - the ordinate for a Cartesian chart.

area: Area

An Area object specifying position, padding, background and borders of the chart.

gridArea: Area

An Area object specifying how to display the grid area.

legend: Legend

A Legend object specifying the attributes for the legend of the chart.

majorAxis1GridStyle: LineStyle

A LineStyle object specifying the line properties to be used when drawing major gridlines along axis 1.

majorAxis2GridStyle: LineStyle

A LineStyle object specifying the line properties to be used when drawing major gridlines along axis 2.

minorAxis1GridStyle: LineStyle

A LineStyle object specifying the line properties to be used when drawing minor gridlines along axis 1.

minorAxis2GridStyle: LineStyle

A LineStyle object specifying the line properties to be used when drawing minor gridlines along axis 2.

tagTextStyle: TextStyle

A TextStyle object specifying the text properties to be used when creating tags.

tagAreaStyle: AreaStyle

An AreaStyle object specifying the area properties to be used when creating tags.

tagBorder: LineStyle

A LineStyle object specifying the tag area border properties to be used when creating tags.

transform: float

A tuple of Floats specifying a transformation matrix used to scale or pan along the axes of the Chart.

Methods

autoColor([lines, symbols])	This method distributes the colors on all curves displayed in the chart using the color palette defined by the xyColors object.
autoSymbol()	This method distributes the symbols on all curves displayed in the chart.
fitCurves()	This method resets the transform of the chart.
getAxis1(curve, quantityType)	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.
getAxis2(curve, quantityType)	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.
moveAxisDown(axis)	This method moves the relative position of the given Axis object down in the axis sequence of the Chart.
moveAxisUp(axis)	This method moves the relative position of the given Axis object up in the axis sequence of the Chart.
removeCurve(curve)	This method removes the given XYCurve from the Chart.
setValues([chart, curvesToPlot, ...])	This method modifies the Chart object.

autoColor(lines: BooleanType = 0, symbols: BooleanType = 0)

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

Parameters:

lines

A Boolean defining whether color distribution affects curve lines.

symbols

A Boolean defining whether color distribution affects curve symbols.

autoSymbol()

This method distributes the symbols on all curves displayed in the chart.

fitCurves()

This method resets the transform of the chart. It cancels any zoom or pan action.

getAxis1(curve: str, quantityType: str)

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.

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.

Raises:

If the given XYCurve is not used in the Chart.

XypError: Curve not found:

• If both arguments are specified.

  TypeError: Specify curve or quantityType; too many arguments; expected 1, got 2.

• If the given QuantityType is not used in the Chart.

  ValueError: QuantityType not found

getAxis2(curve: str, quantityType: str)

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.

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.

Raises:

If the given XYCurve is not used in the Chart.

XypError: Curve not found:

• If both arguments are specified.

  TypeError: Specify curve or quantityType; too many arguments; expected 1, got 2.

• If the given QuantityType is not used in the Chart.

  ValueError: QuantityType not found

moveAxisDown(axis: str)

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

Parameters:

axis

The Axis object to be moved.

moveAxisUp(axis: str)

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

Parameters:

axis

The Axis object to be moved.

removeCurve(curve: str)

This method removes the given XYCurve from the Chart.

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: Chart | None = None, curvesToPlot: tuple[XYCurve] = (), aspectRatio: float | None = None, transform: tuple = (), view: View | None = None, useQuantityType: BooleanType = 1)

This method modifies the Chart object.

Parameters:

chart

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

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

A View object.

useQuantityType

A Boolean specifying whether to use the QuantityType to associate curves with axes. The default value is ON.

Raises:

RangeError

DefaultChartOptions

class DefaultChartOptions

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.

Notes

This object can be accessed by:

import visualization
session.defaultChartOptions

Methods

setValues([areaStyle, aspectRatio, ...])

This method modifies the DefaultChartOptions object.

setValues(areaStyle: ~abaqus.XY.AreaStyle.AreaStyle = <abaqus.XY.AreaStyle.AreaStyle object>, aspectRatio: float | None = None, defaultAxis1Options: ~abaqus.XY.Axis.Axis = <abaqus.XY.Axis.Axis object>, defaultAxis2Options: ~abaqus.XY.Axis.Axis = <abaqus.XY.Axis.Axis object>, gridArea: ~abaqus.XY.Area.Area = <abaqus.XY.Area.Area object>, legend: ~abaqus.XY.Legend.Legend = <abaqus.XY.Legend.Legend object>, majorAxis1GridStyle: ~abaqus.XY.LineStyle.LineStyle = <abaqus.XY.LineStyle.LineStyle object>, majorAxis2GridStyle: ~abaqus.XY.LineStyle.LineStyle = <abaqus.XY.LineStyle.LineStyle object>, minorAxis1GridStyle: ~abaqus.XY.LineStyle.LineStyle = <abaqus.XY.LineStyle.LineStyle object>, minorAxis2GridStyle: ~abaqus.XY.LineStyle.LineStyle = <abaqus.XY.LineStyle.LineStyle object>, tagAreaStyle: ~abaqus.XY.AreaStyle.AreaStyle = <abaqus.XY.AreaStyle.AreaStyle object>, tagBorder: ~abaqus.XY.LineStyle.LineStyle = <abaqus.XY.LineStyle.LineStyle object>, tagTextStyle: ~abaqus.XY.TextStyle.TextStyle = <abaqus.XY.TextStyle.TextStyle object>, useQuantityType: ~abaqusConstants.BooleanType = 1)

This method modifies the DefaultChartOptions object.

Parameters:

areaStyle

An AreaStyle object specifying an AreaStyle used to hold on to the default display properties for the chart area.

aspectRatio

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

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

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

An Area object specifying how to display the grid area by default.

legend

A Legend object specifying the default attributes for the legend of the chart.

majorAxis1GridStyle

A LineStyle object specifying the default line properties to be used when drawing major gridlines along axis 1.

majorAxis2GridStyle

A LineStyle object specifying the default line properties to be used when drawing major gridlines along axis 2.

minorAxis1GridStyle

A LineStyle object specifying the default line properties to be used when drawing minor gridlines along axis 1.

minorAxis2GridStyle

A LineStyle object specifying the default line properties to be used when drawing minor gridlines along axis 2.

tagAreaStyle

An AreaStyle object specifying the default area properties to be used when creating tags.

tagBorder

A LineStyle object specifying the default tag area border properties to be used when creating tags.

tagTextStyle

A TextStyle object specifying the default text properties to be used when creating tags.

useQuantityType

A Boolean specifying whether to use the QuantityType to associate curves with axes. The default value is ON.

DefaultPlot

class DefaultPlot

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.

Notes

This object can be accessed by:

import visualization
session.defaultPlot

Attributes:

area: Area

An Area object specifying an Area used to hold on to the default display properties for the plot area.

title: Title

A Title.:py:class:~abaqus.XY.Title.Title` object specifying a Title.:py:class:~abaqus.XY.Title.Title` object used to hold on to the default properties of the XY-Plot title.

Legend

class Legend

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.

Notes

This object can be accessed by:

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

Attributes:

numberFormat: SymbolicConstant

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: int

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.

show: Boolean

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

showMinMax: Boolean

A Boolean specifying whether to display the minimum and maximum values. The default value is OFF.

area: Area

An Area object specifying the area of the legend.

textStyle: TextStyle

A TextStyle object specifying the text properties used to display the legend text.

title: str

A String specifying the title to appear on the legend. The default value is an empty string.

titleStyle: TextStyle

A TextStyle object specifying the text properties used to display the legend title.

Methods

setValues([legend, show, showMinMax, title, ...])

This method modifies the Legend object.

setValues(legend: ~abaqus.XY.Legend.Legend | None = None, show: ~abaqusConstants.BooleanType = 1, showMinMax: ~abaqusConstants.BooleanType = 0, title: str = '', numberFormat: ~abaqusConstants.SymbolicConstantType = 'AUTOMATIC', numDigits: int = 2, textStyle: ~abaqus.XY.TextStyle.TextStyle = <abaqus.XY.TextStyle.TextStyle object>, titleStyle: ~abaqus.XY.TextStyle.TextStyle = <abaqus.XY.TextStyle.TextStyle object>)

This method modifies the Legend object.

Parameters:

legend

A Legend object from which attributes are to be copied.

show

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

showMinMax

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

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

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

A TextStyle object specifying the text properties used to display the legend text.

titleStyle

A TextStyle object specifying the text properties used to display the legend title.

LineStyle

class LineStyle(color: str = '', show: BooleanType = 1, style: SymbolicConstantType = 'SOLID', thickness: float = 0)

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.

Notes

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

Methods

setValues([color, show, style, thickness])

This method modifies the LineStyle object.

setValues(color: str = '', show: BooleanType = 1, style: SymbolicConstantType = 'SOLID', thickness: float = 0)

This method modifies the LineStyle object.

Parameters:

color

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

show

A Boolean specifying whether to draw the line when using this LineStyle. The default value is ON.

style

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

A Float specifying the line thickness in mm to be used when drawing lines using this LineStyle. The default value is 0.2.

QuantityType

class QuantityType(label: str = '', type: SymbolicConstantType | None = None)

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.

Notes

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

Methods

setValues()

This method modifies the QuantityType object.

setValues()

This method modifies the QuantityType object.

SymbolStyle

class SymbolStyle(color: str = '', show: BooleanType = 1, marker: SymbolicConstantType = 'FILLED_CIRCLE', size: float = 2)

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.

Notes

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

Methods

setValues([color, show, marker, size])

This method modifies the SymbolStyle object.

setValues(color: str = '', show: BooleanType = 1, marker: SymbolicConstantType = 'FILLED_CIRCLE', size: float = 2)

This method modifies the SymbolStyle object.

Parameters:

color

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

show

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

marker

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

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

TextStyle

class TextStyle(color: str = '', show: BooleanType = 1, font: str = '', rotationAngle: float = 0)

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.

Notes

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

Methods

setValues([color, show, font, rotationAngle])

This method modifies the TextStyle object.

setValues(color: str = '', show: BooleanType = 1, font: str = '', rotationAngle: float = 0)

This method modifies the TextStyle object.

Parameters:

color

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

show

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

A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

Title

class Title

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.

Notes

This object can be accessed by:

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

Attributes:

useDefault: Boolean

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

area: Area

An Area object specifying the area of the title.

text: str

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: TextStyle

A TextStyle object specifying the text properties used to display the legend title.

Methods

setValues([title, text, area, useDefault, ...])

This method modifies the Title object.

setValues(title: ~abaqus.XY.Title.Title | None = None, text: str = '', area: ~abaqus.XY.Area.Area = <abaqus.XY.Area.Area object>, useDefault: ~abaqusConstants.BooleanType = 0, titleStyle: ~abaqus.XY.TextStyle.TextStyle = <abaqus.XY.TextStyle.TextStyle object>)

This method modifies the Title object.

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

An Area object specifying the area of the title.

useDefault

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

titleStyle

A TextStyle object specifying the text properties used to display the legend title.

writeXYReport

XYCurve

class XYCurve

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

Notes

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]

Attributes:

name: str

A String specifying the repository key.

symbolFrequency: int

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: Boolean

A Boolean specifying whether to use the system supplied legend label. The default value is ON.

legendSource: SymbolicConstant

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.

data: XYData

An XYData object specifying the data for the curve.

lineStyle: LineStyle

A LineStyle object specifying the line properties used to display the curve.

symbolStyle: SymbolStyle

A SymbolStyle object specifying the symbol properties used to display the curve.

legendLabel: str

A String specifying the label to be displayed in the legend. By default, the label is system defined.

displayTypes: SymbolicConstant

A tuple of SymbolicConstants specifying that describe how curves are to be displayed. Possible values are LINE and SYMBOL. The default value is (LINE).

Methods

Curve(name, data)	This method creates an XYCurve object from an XYData object.
setValues([displayTypes, legendLabel, ...])	This method modifies the XYCurve object.

Curve(name: str, data: XYData)

This method creates an XYCurve object from an XYData object.

Parameters:

name

A String specifying the repository key.

data

An XYData object specifying the data for the curve.

Returns:

An XYCurve object.

Notes

This function can be accessed by:

session.Curve

setValues(displayTypes: SymbolicConstantType | None = None, legendLabel: str = '', symbolFrequency: int = 1, useDefault: BooleanType = 1)

This method modifies the XYCurve object.

Parameters:

displayTypes

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

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

A Boolean specifying whether to use the system supplied legend label. The default value is ON.

XYCurveArray

class XYCurveArray(iterable=(), /)

Methods

findAt

XYData

class XYData(data: tuple, name: str = '', sourceDescription: str = '', contentDescription: str = '', positionDescription: str = '', legendLabel: str = '', xValuesLabel: str = '', yValuesLabel: str = '', axis1QuantityType: QuantityType = QuantityType(), axis2QuantityType: QuantityType = QuantityType())

class XYData(objectToCopy: XYData)

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.

Notes

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

Attributes:

sourceType: SymbolicConstant

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: str

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

description: str

A String specifying the complete description of the XYData object.

Methods

XYDataFromFile(fileName[, name, ...])	This method creates an XYData object from data in an ASCII file.
XYDataFromFreeBody(odb[, force, moment, ...])	This method creates a list of XYData objects by computing free body data from an Odb object.
XYDataFromHistory(odb, outputVariableName, steps)	This method creates an XYData object by reading history data from an Odb object.
XYDataFromPath(path, name, ...[, viewport, ...])	This method creates an XYData object from path information.
XYDataFromShellThickness(odb, ...[, ...])	This method creates a list of XYData objects by reading through the thickness field data from an Odb object.
save()	This method saves a temporary XYData.
setValues([sourceDescription, ...])	This method modifies the XYData object.
xyDataListFromField(odb, outputPosition, ...)	This method creates a list of XYData objects by reading field data from an Odb object.

XYDataFromFile(fileName: str, name: str = '', sourceDescription: str = '', contentDescription: str = '', positionDescription: str = '', legendLabel: str = '', xValuesLabel: str = '', yValuesLabel: str = '', axis1QuantityType: ~abaqus.XY.QuantityType.QuantityType = <abaqus.XY.QuantityType.QuantityType object>, axis2QuantityType: ~abaqus.XY.QuantityType.QuantityType = <abaqus.XY.QuantityType.QuantityType object>, xField: int = 1, yField: int = 2, skipFrequency: int | None = None)

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

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

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

Returns:

An XYData object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

session.XYData
xyPlot.XYData

XYDataFromFreeBody(odb: Odb, force: BooleanType = 1, moment: BooleanType = 0, heatFlowRate: BooleanType = 0, resultant: BooleanType = 1, comp1: BooleanType = 0, comp2: BooleanType = 0, comp3: BooleanType = 0)

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

Parameters:

odb

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

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.

Returns:

A python:list of XYData objects.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

session.XYData
xyPlot.XYData

XYDataFromHistory(odb: Odb, outputVariableName: str, steps: tuple, name: str = '', sourceDescription: str = '', contentDescription: str = '', positionDescription: str = '', legendLabel: str = '', skipFrequency: int | None = None, numericForm: SymbolicConstantType = 'REAL', complexAngle: float = 0, stepTuple: int | None = None)

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

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

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.

Returns:

An XYData object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

session.XYData
xyPlot.XYData

XYDataFromPath(path: Path, name: str, includeIntersections: BooleanType, shape: SymbolicConstantType, pathStyle: SymbolicConstantType, numIntervals: int, labelType: SymbolicConstantType, viewport: str = '', removeDuplicateXYPairs: BooleanType = True, includeAllElements: BooleanType = False, step: int | None = None, frame: int | None = None, variable: SymbolicConstantType | None = None, deformedMag: float | None = None, numericForm: SymbolicConstantType = 'REAL', complexAngle: float = 0, projectOntoMesh: BooleanType = False, projectionTolerance: float = 0)

This method creates an XYData object from path information.

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

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

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

includeAllElements

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

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.

projectOntoMesh

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

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 python:list of XYData objects.

Raises:

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

Notes

This function can be accessed by:

session.XYData
xyPlot.XYData

XYDataFromShellThickness(odb: Odb, outputPosition: SymbolicConstantType, variable: SymbolicConstantType, elementSets: tuple = (), elementLabels: tuple = (), nodeSets: tuple = (), nodeLabels: tuple = (), numericForm: SymbolicConstantType = 'REAL', complexAngle: float = 0)

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

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

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.

Returns:

A python:list of XYData objects.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

session.XYData
xyPlot.XYData

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.

setValues(sourceDescription: str = '', contentDescription: str = '', positionDescription: str = '', legendLabel: str = '', xValuesLabel: str = '', yValuesLabel: str = '', axis1QuantityType: ~abaqus.XY.QuantityType.QuantityType = <abaqus.XY.QuantityType.QuantityType object>, axis2QuantityType: ~abaqus.XY.QuantityType.QuantityType = <abaqus.XY.QuantityType.QuantityType object>)

This method modifies the XYData object.

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

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.

xyDataListFromField(odb: Odb, outputPosition: SymbolicConstantType, variable: tuple[tuple], elementSets: tuple = (), elementLabels: tuple = (), nodeSets: tuple = (), nodeLabels: tuple = (), numericForm: SymbolicConstantType = 'REAL', complexAngle: float = 0, operator: SymbolicConstantType | None = None) → list['XYData']

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

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

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.

operator

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 python:list of XYData objects.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

session.XYData
xyPlot.XYData

XYPlot

class XYPlot(name: str)

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

static AreaStyle(color: str = '', fill: BooleanType = 1, style: SymbolicConstantType = 'SOLID') → AreaStyle

This method creates an AreaStyle.

Parameters:

color

A String specifying the color to be used when filling an area with this AreaStyle object. The default value is “White”.

fill

A Boolean specifying whether to fill the area when using this AreaStyle. The default value is ON.

style

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.

Raises:

ColorError

Notes

This function can be accessed by:

session.AreaStyle
xyPlot.AreaStyle

static LineStyle(color: str = '', show: BooleanType = 1, style: SymbolicConstantType = 'SOLID', thickness: float = 0) → LineStyle

This method creates a LineStyle.

Parameters:

color

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

show

A Boolean specifying whether to draw the line when using this LineStyle. The default value is ON.

style

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

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.

Raises:

ColorError

Notes

This function can be accessed by:

session.LineStyle
xyPlot.LineStyle

static QuantityType(label: str = '', type: SymbolicConstantType | None = None) → QuantityType

This method creates a QuantityType object.

Parameters:

label

A String specifying the label for this quantity type.

type

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.

Notes

This function can be accessed by:

session.QuantityType
xyPlot.QuantityType

static SymbolStyle(color: str = '', show: BooleanType = 1, marker: SymbolicConstantType = 'FILLED_CIRCLE', size: float = 2) → SymbolStyle

This method creates a SymbolStyle object.

Parameters:

color

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

show

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

marker

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

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.

Raises:

ColorError

Notes

This function can be accessed by:

session.SymbolStyle
xyPlot.SymbolStyle

static TextStyle(color: str = '', show: BooleanType = 1, font: str = '', rotationAngle: float = 0) → TextStyle

This method creates a TextStyle.

Parameters:

color

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

show

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

A Float specifying the angle in degrees used for displaying the text. The default value is 0.0.

Returns:

A TextStyle object.

Raises:

ColorError

Notes

This function can be accessed by:

session.TextStyle
xyPlot.TextStyle

XYPlotBase

class XYPlotBase(name: str)

The XYPlot object is used to display Chart objects.

Notes

This object can be accessed by:

import visualization
session.xyPlots[name]

Attributes:

area: Area

An Area object specifying position, padding, background and borders of the XYPlot object.

title: Title

A Title object specifying the title of the XYPlot object.

charts: dict[str, Chart]

A repository of Chart objects.

curves: dict[str, XYCurve]

A repository of XYCurve objects.

transform: float

A tuple of Floats specifying a transformation matrix used to scale or pan along the axes of the active Chart object of this XYPlot.

Methods

autoColor([lines, symbols])	This method distributes the colors on all curves displayed in the XYPlot using the color palette defined by the xyColors AutoColors object.
autoSymbol()	This method distributes the symbols on all curves displayed in the XYPlot.
fitCurves()	This method resets the transform of all the charts of the XYPlot object.
next([drawImmediately])	This method restores the transform member of the active Chart object to the next setting in the transform list.
previous([drawImmediately])	This method restores the transform member of the active Chart object to the previous setting in the transform list.
setValues([title, transform])	This method modifies the XYPlot object.

autoColor(lines: BooleanType = 0, symbols: BooleanType = 0)

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

Parameters:

lines

A Boolean defining whether color distribution affects curve lines.

symbols

A Boolean defining whether color distribution affects curve symbols.

autoSymbol()

This method distributes the symbols on all curves displayed in the XYPlot.

fitCurves()

This method resets the transform of all the charts of the XYPlot object. It cancels any zoom or pan action.

next(drawImmediately: BooleanType = False)

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.

Parameters:

drawImmediately

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: BooleanType = False)

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.

Parameters:

drawImmediately

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: ~abaqus.XY.Title.Title = <abaqus.XY.Title.Title object>, transform: tuple = ())

This method modifies the XYPlot object.

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.

XYReportOptions

class XYReportOptions

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.

Notes

This object can be accessed by:

import visualization
session.defaultXYReportOptions
session.xyReportOptions

Methods

setValues([pageWidth, numDigits, ...])

This method modifies the XYReportOptions object.

setValues(pageWidth: int = 80, numDigits: int = 6, interpolation: BooleanType = 0, xyData: BooleanType = 1, totals: BooleanType = 0, minMax: BooleanType = 0, pageWidthLimited: BooleanType = 0, numberFormat: SymbolicConstantType = 'ENGINEERING', layout: SymbolicConstantType = 'SINGLE_TABLE')

This method modifies the XYReportOptions object.

Parameters:

pageWidth

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

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

A Boolean specifying whether to perform linear interpolation for missing data values. The default value is OFF.

xyData

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

A Boolean specifying whether to print the sum of the Y-values of the selected XYData objects. The default value is OFF.

minMax

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

A Boolean specifying whether the page width is limited. The default value is OFF.

numberFormat

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

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