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

Methods

writeFieldRepor(filename, append, sortItem, ...)	This method writes a FieldOutput object to a user-defined ASCII file.
writeFreeBodyRepor(fileName, append[, step, ...])	This method writes a FreeBody object to a user-defined ASCII file.

writeFieldRepor(filename: str, append: BooleanType, sortItem: str, odb: Odb, step: int, frame: int, outputPosition: SymbolicConstantType, displayGroup: DisplayGroup, variable: SymbolicConstantType, numericForm: SymbolicConstantType | None = None, complexAngle: float | None = None, stepFrame: SymbolicConstantType = 'SPECIFY')

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

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

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

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

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.

Notes

This function can be accessed by:

session.writeFieldReport

writeFreeBodyRepor(fileName: str, append: BooleanType, step: int | None = None, frame: int | None = None, stepFrame: SymbolicConstantType = 'SPECIFY', odb: Odb | None = None)

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

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

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.

stepFrame

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

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

Returns:

Raises:

Notes

This function can be accessed by:

session.writeFreeBodyReport

Object features

FieldReportOptions

class FieldReportOptions

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.

Notes

This object can be accessed by:

import visualization
session.defaultFieldReportOptions
session.fieldReportOptions

Attributes:

numberFormat: NumberFormat

Format of the number

Methods

NumberFormat([blankPad, format, numDigits, ...])	This method creates a NumberFormat object.
setValues([numColumns, numberFormat, ...])	This method modifies the FieldReportOptions object.

NumberFormat(blankPad: BooleanType = 1, format: SymbolicConstantType = 'ENGINEERING', numDigits: int = 6, precision: int = 0) → NumberFormat

This method creates a NumberFormat object.

Parameters:

blankPad

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

A SymbolicConstant specifying the formatting type. Possible values are ENGINEERING, SCIENTIFIC, and AUTOMATIC. The default value is ENGINEERING.

numDigits

An Int specifying the number of digits to be displayed in the result. numDigits >0>0. The default value is 6.

precision

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.

Notes

This function can be accessed by:

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

setValues(numColumns: int = 80, numberFormat: ~abaqus.Session.NumberFormat.NumberFormat = <abaqus.Session.NumberFormat.NumberFormat object>, printXYData: ~abaqusConstants.BooleanType = 1, printTotal: ~abaqusConstants.BooleanType = 1, printMinMax: ~abaqusConstants.BooleanType = 1, pageWidth: ~abaqusConstants.SymbolicConstantType = 'NO_LIMIT', columnLayout: ~abaqusConstants.SymbolicConstantType = 'SINGLE_TABLE', sort: ~abaqusConstants.SymbolicConstantType = 'ASCENDING', printLocalCSYS: ~abaqusConstants.BooleanType = 0)

This method modifies the FieldReportOptions object.

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

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

printTotal

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

printMinMax

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

pageWidth

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

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

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

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

Returns:

A FieldReportOptions object.

FreeBodyReportOptions

class FreeBodyReportOptions

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.

Notes

This object can be accessed by:

import visualization
session.defaultFreeBodyReportOptions
session.freeBodyReportOptions

Methods

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

This method modifies the FreeBodyReportOptions object.

setValues(numDigits: int = 3, forceThreshold: float | None = None, momentThreshold: float | None = None, numberFormat: SymbolicConstantType = 'SCIENTIFIC', reportFormat: SymbolicConstantType = 'NORMAL_ANNOTATED', csysType: SymbolicConstantType = 'GLOBAL')

This method modifies the FreeBodyReportOptions object.

Parameters:

numDigits

An Int specifying the number of decimal places. The default value is 3.

forceThreshold

A Float specifying the threshold value for force. The default value is 10–6.

momentThreshold

A Float specifying the threshold value for moment. The default value is 10–6.

numberFormat

A SymbolicConstant specifying the number format. Possible values are SCIENTIFIC, FIXED, and ENGINEERING. The default value is SCIENTIFIC.

reportFormat

A SymbolicConstant specifying the report format. Possible values are NORMAL_ANNOTATED and COMMA_SEPARATED_VALUES. The default value is NORMAL_ANNOTATED.

csysType

A SymbolicConstant specifying the coordinate system type. Possible values are GLOBAL and LOCAL. The default value is GLOBAL.

Returns:

A FreeBodyReportOptions object.

OdbFieldVarList

class OdbFieldVarList(iterable=(), /)

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.

Notes

This object can be accessed by:

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

OdbModelFieldVarList

class OdbModelFieldVarList

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

Notes

This object can be accessed by:

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

writeFieldReport

writeFreeBodyReport