FieldReport¶

Field report commands are used to write a field output report and free body computational results to an ASCII file.

Create field reports in Session¶

class FieldReportSession[source]¶

Bases: SessionBase

Public Data Attributes:

Inherited from SessionBase

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

Public Methods:

`writeFieldReport`(filename, append, sortItem, ...)	This method writes a FieldOutput object to a user-defined ASCII file.
`writeFreeBodyReport`(fileName, append[, ...])	This method writes a FreeBody object to a user-defined ASCII file.

Inherited from SessionBase

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

Member Details:

writeFieldReport( filename, append, sortItem, odb, step, frame, outputPosition, displayGroup, variable, numericForm=None, complexAngle=None, stepFrame=SPECIFY, )[source]¶

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

Note

This function can be accessed by:

session.writeFieldReport

Note

Check FieldReportSession.writeFieldReport on help.3ds.com/2024.

Parameters:¶

filename¶

A String specifying the name of the file to which field output will be written.

append¶

A Boolean specifying whether to append the field output to an existing file. The default value is ON.

sortItem¶

A String specifying the item by which to sort the tabular values.

odb¶

An Odb object from which to obtain field output values.

step¶

An Int (or stepIndex) specifying the step from which to obtain field output values. Possible values are 0 ≤ step ≤ (numSteps − 1).

frame¶

An Int (or frameIndex) specifying the frame from which to obtain field output values. Possible values are 0 ≤ frame ≤ (numFramesInStep − 1).

outputPosition¶

A SymbolicConstant specifying the position from which to obtain data. Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, ELEMENT_CENTROID, WHOLE_ELEMENT, WHOLE_REGION, WHOLE_PART_INSTANCE, WHOLE_MODEL, and GENERAL_PARTICLE.

displayGroup¶

A DisplayGroup object specifying the subset of the model for which to obtain data.

variable¶

A sequence of variable description sequences specifying one or more field output variables for which to obtain data. Each variable description sequence contains the following elements:

element0: A String specifying the name of the variable.
element1: A SymbolicConstant specifying the output position at which to report data. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.
element2: A Sequence of tuples each consisting of a SymbolicConstant specifying the refinement (COMPONENT or INVARIANT), followed by a String specifying the name of a component or invariant for which to obtain values. If this element is omitted, data are written for all components and invariants (if applicable). This element is required if element3 (the following element in the tuple) is included.
element3 (if applicable): A Dictionary with a String key and a String value specifying a single section point at which to report data. The key specifies a region in the model; the corresponding value specifies a section point within that region. For example:
```
{'shell < MAT > < 7 section points >': 'SPOS (fraction = 1.0)'}
```
If this element is omitted, data are written for all section points (if applicable). If this element is omitted, data are written for all section points (if applicable).

numericForm=None¶

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_MAG_AT_ANGLE. The initial value is COMPLEX_MAGNITUDE.

complexAngle=None¶

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

stepFrame=SPECIFY¶

A SymbolicConstant indicating whether to obtain the values from the specified frame or from all active frames. Possible values are SPECIFY and ALL. The default value is SPECIFY.

writeFreeBodyReport( fileName, append, step=None, frame=None, stepFrame=SPECIFY, odb=None, )[source]¶

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

Note

This function can be accessed by:

session.writeFreeBodyReport

Note

Check FieldReportSession.writeFreeBodyReport on help.3ds.com/2024.

Parameters:¶

fileName¶: A String specifying the name of the file to which the free body output will be written.
append¶: A Boolean specifying whether to append the free body output to an existing file. The default value is ON.
step=None¶: An Int identifying the step from which to obtain values. The default value is the current step.
frame=None¶: An Int identifying the frame from which to obtain values. The default value is the current frame.
stepFrame=SPECIFY¶: A SymbolicConstant indicating whether to obtain the values from the specified frame or from all active frames. Possible values are SPECIFY and ALL. The default value is SPECIFY.
odb=None¶: An Odb object specifying the output database from which data will be read.

Other Classes¶

class FieldReportOptions[source]¶

Bases: object

The FieldReportOptions object stores settings used by the writeFieldReport method when you write a FieldOutput object to an ASCII file. The FieldReportOptions object has no constructor. Abaqus creates the fieldReportOptions member when you import the Visualization module.

Note

This object can be accessed by:

import visualization
session.defaultFieldReportOptions
session.fieldReportOptions

Note

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

Member Details:

NumberFormat(blankPad=1, format=ENGINEERING, numDigits=6, precision=0)[source]¶

This method creates a NumberFormat object.

Note

This function can be accessed by:

session.defaultFieldReportOptions.NumberFormat
session.fieldReportOptions.NumberFormat
session.journalOptions.NumberFormat

Note

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

Parameters:¶

blankPad=1¶: A Boolean specifying whether the printed digits should be padded with blank characters to ensure equal sized fields. The blankPad argument is useful when your printed output includes columns. The default value is ON.
format=ENGINEERING¶: A SymbolicConstant specifying the formatting type. Possible values are ENGINEERING, SCIENTIFIC, and AUTOMATIC. The default value is ENGINEERING.
numDigits=6¶: An Int specifying the number of digits to be displayed in the result. numDigits >0>0. The default value is 6.
precision=0¶: An Int specifying the number of decimal places to which the number is to be truncated for display. precision ≤0≤0. If precision =0, no truncation is applied. The default value is 0.

Returns:¶

A NumberFormat object.

Return type:¶

NumberFormat

numberFormat : --is-rst--:py:class:`~abaqus.Session.NumberFormat.NumberFormat` = <abaqus.Session.NumberFormat.NumberFormat object>[source]¶: Format of the number

setValues( numColumns, numberFormat, printXYData=1, printTotal=1, printMinMax=1, pageWidth=NO_LIMIT, columnLayout=SINGLE_TABLE, sort=ASCENDING, printLocalCSYS=0, )[source]¶

This method modifies the FieldReportOptions object.

Note

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

Parameters:¶

numColumns¶

An Int specifying the number of columns to display for the tabular report. The default value is 80.

numberFormat¶

A NumberFormat object specifying the format type, number of digits and precision used to print the numeric output.

printXYData=1¶

A Boolean specifying whether to include X - Y data values in the tabular report. The default value is ON.

printTotal=1¶

A Boolean specifying whether to include column totals in the tabular report. The default value is ON.

printMinMax=1¶

A Boolean specifying whether to include column summary minimum and maximum values in the tabular report. The default value is ON.

pageWidth=NO_LIMIT¶

A SymbolicConstant specifying how the width of the tabular report is to be determined. Possible values are NO_LIMIT and SPECIFY. The default value is NO_LIMIT.

columnLayout=SINGLE_TABLE¶

A SymbolicConstant specifying how values are to be presented in the tabular report. Possible values are SINGLE_TABLE and SEPARATE_TABLES. The default value is SINGLE_TABLE.

sort=ASCENDING¶

A SymbolicConstant specifying the order in which values are to be sorted within a tabular report. Possible values are ASCENDING and DESCENDING. The default value is ASCENDING.

printLocalCSYS=0¶

A Boolean specifying whether to include the local coordinate system values in the tabular report. The default value is OFF.

Added in version 2022: The printLocalCSYS argument was added.

Returns:¶

A FieldReportOptions object.

Return type:¶

FieldReportOptions

class FreeBodyReportOptions[source]¶

Bases: object

The FreeBodyReportOptions object stores settings used by the writeFreeBodyReport method when you write free body computational results to an ASCII file. The FreeBodyReportOptions object has no constructor. Abaqus creates the freeBodyReportOptions member when you import the Visualization module.

Note

This object can be accessed by:

import visualization
session.defaultFreeBodyReportOptions
session.freeBodyReportOptions

Note

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

Member Details:

setValues( numDigits=3, forceThreshold=None, momentThreshold=None, numberFormat=SCIENTIFIC, reportFormat=NORMAL_ANNOTATED, csysType=GLOBAL, )[source]¶

This method modifies the FreeBodyReportOptions object.

Note

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

Parameters:¶

numDigits=3¶: An Int specifying the number of decimal places. The default value is 3.
forceThreshold=None¶: A Float specifying the threshold value for force. The default value is 10⁻⁶.
momentThreshold=None¶: A Float specifying the threshold value for moment. The default value is 10⁻⁶.
numberFormat=SCIENTIFIC¶: A SymbolicConstant specifying the number format. Possible values are SCIENTIFIC, FIXED, and ENGINEERING. The default value is SCIENTIFIC.
reportFormat=NORMAL_ANNOTATED¶: A SymbolicConstant specifying the report format. Possible values are NORMAL_ANNOTATED and COMMA_SEPARATED_VALUES. The default value is NORMAL_ANNOTATED.
csysType=GLOBAL¶: A SymbolicConstant specifying the coordinate system type. Possible values are GLOBAL and LOCAL. The default value is GLOBAL.

Returns:¶

A FreeBodyReportOptions object.

Return type:¶

FreeBodyReportOptions

class OdbFieldVarList(iterable=(), /)[source]¶

Bases: List[str]

The read-only OdbFieldVarList object is a sequence listing all variables available for the current step and frame. Each item in the sequence is itself a sequence fully describing the given variable.

Note

This object can be accessed by:

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

Note

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

Member Details:

class OdbModelFieldVarList[source]¶

Bases: object

The read-only OdbModelFieldVarList object lists all variables available for the model in the current OdbDisplay object.

Note

This object can be accessed by:

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

Note

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

Member Details:

writeFieldReport( filename, append, sortItem, odb, step, frame, outputPosition, displayGroup, variable, numericForm=None, complexAngle=None, stepFrame=SPECIFY, )[source]¶

This function writes a FieldOutput object to a user-defined ASCII file.

Note

This function can be accessed by:

session.writeFieldReport

Note

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

Parameters:¶

filename¶

A String specifying the name of the file to which field output will be written.

append¶

A Boolean specifying whether to append the field output to an existing file. The default value is ON.

sortItem¶

A String specifying the item by which to sort the tabular values.

odb¶

An Odb object from which to obtain field output values.

step¶

An Int (or stepIndex) specifying the step from which to obtain field output values. Possible values are 0 ≤ step ≤ (numSteps − 1).

frame¶

An Int (or frameIndex) specifying the frame from which to obtain field output values. Possible values are 0 ≤ frame ≤ (numFramesInStep − 1).

outputPosition¶

displayGroup¶

A DisplayGroup object specifying the subset of the model for which to obtain data.

variable¶

A sequence of variable description sequences specifying one or more field output variables for which to obtain data. Each variable description sequence contains the following elements:

element0: A String specifying the name of the variable.
element1: A SymbolicConstant specifying the output position at which to report data. Possible values are ELEMENT_CENTROID, ELEMENT_FACE, ELEMENT_NODAL, GENERAL_PARTICLE, INTEGRATION_POINT, NODAL, WHOLE_ELEMENT, WHOLE_MODEL, WHOLE_PART_INSTANCE, and WHOLE_REGION.
element2: A Sequence of tuples each consisting of a SymbolicConstant specifying the refinement (COMPONENT or INVARIANT), followed by a String specifying the name of a component or invariant for which to obtain values. If this element is omitted, data are written for all components and invariants (if applicable). This element is required if element3 (the following element in the tuple) is included.
element3 (if applicable): A Dictionary with a String key and a String value specifying a single section point at which to report data. The key specifies a region in the model; the corresponding value specifies a section point within that region. For example:
```
{'shell < MAT > < 7 section points >': 'SPOS (fraction = 1.0)'}
```
If this element is omitted, data are written for all section points (if applicable). If this element is omitted, data are written for all section points (if applicable).

numericForm=None¶

complexAngle=None¶

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

stepFrame=SPECIFY¶

A SymbolicConstant indicating whether to obtain the values from the specified frame or from all active frames. Possible values are SPECIFY and ALL. The default value is SPECIFY.

writeFreeBodyReport(fileName, append, step=None, frame=None, stepFrame=SPECIFY, odb=None)[source]¶

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

Note

This function can be accessed by:

session.writeFreeBodyReport

Note

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

Parameters:¶

fileName¶: A String specifying the name of the file to which the free body output will be written.
append¶: A Boolean specifying whether to append the free body output to an existing file. The default value is ON.
step=None¶: An Int identifying the step from which to obtain values. The default value is the current step.
frame=None¶: An Int identifying the frame from which to obtain values. The default value is the current frame.
stepFrame=SPECIFY¶: A SymbolicConstant indicating whether to obtain the values from the specified frame or from all active frames. Possible values are SPECIFY and ALL. The default value is SPECIFY.
odb=None¶: An Odb object specifying the output database from which data will be read.