Abaqus Output Database#

The Python ODB API commands are used to read and write data from an output database (.odb) file. The path to the Odb object can be via the session.odbs repository or via a variable. In this chapter the Access and Path statements refer to a variable called odb that represents an existing Odb object.

Object features#

OdbBase#

class OdbBase(name: str, analysisTitle: str = '', description: str = '', path: str = '')[source]#

The Odb object is the in-memory representation of an output database (ODB) file.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name]

Attributes:

isReadOnly: Boolean: A Boolean specifying whether the output database was opened with read-only access.
amplitudes: dict[str, Amplitude]: A repository of Amplitude objects.
filters: dict[str, Filter]: A repository of Filter objects.
rootAssembly: OdbAssembly: An OdbAssembly object.
jobData: JobData: A JobData object.
parts: dict[str, OdbPart]: A repository of OdbPart objects.
materials: dict[str, Material]: A repository of Material objects.
steps: dict[str, OdbStep]: A repository of OdbStep objects.
sections: dict[str, Section]: A repository of Section objects.
sectionCategories: dict[str, SectionCategory]: A repository of SectionCategory objects.
sectorDefinition: SectorDefinition: A SectorDefinition object.
userData: UserData: A UserData object.
customData: RepositorySupport: A RepositorySupport object.
profiles: dict[str, Profile]: A repository of Profile objects.

Methods

`close`()	This method closes an output database.
`getFrame`(frameValue[, match])	This method returns the frame at the specified time, frequency, or mode.
`save`()	This method saves output to an output database (.odb ) file.
`update`()	This method is used to update an Odb object in memory while an Abaqus analysis writes data to the associated output database.

close()[source]#: This method closes an output database.

getFrame(frameValue: str, match: SymbolicConstantType = 'CLOSEST')[source]#

This method returns the frame at the specified time, frequency, or mode. It will not interpolate values between frames. The method is not applicable to an Odb object containing steps with different domains or to an Odb object containing a step with load case specific data.

Parameters:

frameValue: A Double specifying the value at which the frame is required. frameValue can be the total time or frequency.
match: A SymbolicConstant specifying which frame to return if there is no frame at the exact frame value. Possible values are CLOSEST, BEFORE, AFTER, and EXACT. The default value is CLOSEST.When *match*=CLOSEST, Abaqus returns the closest frame. If the frame value requested is exactly halfway between two frames, Abaqus returns the frame after the value.When *match*=EXACT, Abaqus raises an exception if the exact frame value does not exist.

Returns:

An OdbFrame object.

Raises:

If the exact frame is not found:
OdbError: Frame not found.

save()[source]#

This method saves output to an output database (.odb ) file.

Raises:

OdbError
Database save failed. The database was opened as read-only. Modification of data is

not permitted.

update()[source]#

This method is used to update an Odb object in memory while an Abaqus analysis writes data to the associated output database. update checks if additional steps have been written to the output database since it was opened or last updated. If additional steps have been written to the output database, update adds them to the Odb object.

Returns:

A Boolean specifying whether additional steps or frames were added to the Odb object.

Odb#

class Odb(name: str, analysisTitle: str = '', description: str = '', path: str = '')[source]#

The Odb object is the in-memory representation of an output database (ODB) file.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name]

Attributes:

isReadOnly: Boolean: A Boolean specifying whether the output database was opened with read-only access.
amplitudes: dict[str, Amplitude]: A repository of Amplitude objects.
filters: dict[str, Filter]: A repository of Filter objects.
rootAssembly: OdbAssembly: An OdbAssembly object.
jobData: JobData: A JobData object.
parts: dict[str, OdbPart]: A repository of OdbPart objects.
materials: dict[str, Material]: A repository of Material objects.
steps: dict[str, OdbStep]: A repository of OdbStep objects.
sections: dict[str, Section]: A repository of Section objects.
sectionCategories: dict[str, SectionCategory]: A repository of SectionCategory objects.
sectorDefinition: SectorDefinition: A SectorDefinition object.
userData: UserData: A UserData object.
customData: RepositorySupport: A RepositorySupport object.
profiles: dict[str, Profile]: A repository of Profile objects.

Methods

`Part`(name, embeddedSpace, type)	This method creates an OdbPart object.
`SectionCategory`(name, description)	This method creates a SectionCategory object.
`Step`(name, description, domain[, ...])	This method creates an OdbStep object.

Part(name: str, embeddedSpace: SymbolicConstantType, type: SymbolicConstantType) → OdbPart[source]#

This method creates an OdbPart object. Nodes and elements are added to this object at a later stage.

Parameters:

name: A String specifying the part name.
embeddedSpace: A SymbolicConstant specifying the dimensionality of the Part object. Possible values are THREE_D, TWO_D_PLANAR, and AXISYMMETRIC.
type: A SymbolicConstant specifying the type of the Part object. Possible values are DEFORMABLE_BODY and ANALYTIC_RIGID_SURFACE.

Returns:

An OdbPart object.

Notes

This function can be accessed by:

session.odbs[name].Part

SectionCategory(name: str, description: str) → SectionCategory[source]#

This method creates a SectionCategory object.

Parameters:

name: A String specifying the name of the category.
description: A String specifying the description of the category.

Returns:

A SectionCategory object.

Notes

This function can be accessed by:

session.odbs[*name*].SectionCategory

Step(name: str, description: str, domain: SymbolicConstantType, timePeriod: float = 0, previousStepName: str = '', procedure: str = '', totalTime: float | None = None) → OdbStep[source]#

This method creates an OdbStep object.

Parameters:

name: A String specifying the repository key.
description: A String specifying the step description.
domain: A SymbolicConstant specifying the domain of the step. Possible values are TIME, FREQUENCY, ARC_LENGTH, and MODAL.The type of OdbFrame object that can be created for this step is based on the value of the domain argument.
timePeriod: A Float specifying the time period of the step. timePeriod is required if *domain*=TIME; otherwise, this argument is not applicable. The default value is 0.0.
previousStepName: A String specifying the preceding step. If previousStepName is the empty string, the last step in the repository is used. If previousStepName is not the last step, this will result in a change to the previousStepName member of the step that was in that position. A special value ‘Initial’ refers to the internal initial model step and may be used exclusively for inserting a new step at the first position before any other existing steps. The default value is an empty string.
procedure: A String specifying the step procedure. The default value is an empty string. The following is the list of valid procedures: ` *ANNEAL *BUCKLE *COMPLEX FREQUENCY *COUPLED TEMPERATURE-DISPLACEMENT *COUPLED TEMPERATURE-DISPLACEMENT, CETOL *COUPLED TEMPERATURE-DISPLACEMENT, STEADY STATE *COUPLED THERMAL-ELECTRICAL, STEADY STATE *COUPLED THERMAL-ELECTRICAL *COUPLED THERMAL-ELECTRICAL, DELTMX *DYNAMIC *DYNAMIC, DIRECT *DYNAMIC, EXPLICIT *DYNAMIC, SUBSPACE *DYNAMIC TEMPERATURE-DISPLACEMENT, EXPLICT *ELECTROMAGNETIC, HIGH FREQUENCY, TIME HARMONIC *ELECTROMAGNETIC, LOW FREQUENCY, TIME DOMAIN *ELECTROMAGNETIC, LOW FREQUENCY, TIME DOMAIN, DIRECT *ELECTROMAGNETIC, LOW FREQUENCY, TIME HARMONIC *FREQUENCY *GEOSTATIC *HEAT TRANSFER *HEAT TRANSFER, DELTAMX=__ *HEAT TRANSFER, STEADY STATE *MAGNETOSTATIC *MAGNETOSTATIC, DIRECT *MASS DIFFUSION *MASS DIFFUSION, DCMAX= *MASS DIFFUSION, STEADY STATE *MODAL DYNAMIC *RANDOM RESPONSE *RESPONSE SPECTRUM *SOILS *SOILS, CETOL/UTOL *SOILS, CONSOLIDATION *SOILS, CONSOLIDATION, CETOL/UTOL *STATIC *STATIC, DIRECT *STATIC, RIKS *STEADY STATE DYNAMICS *STEADY STATE TRANSPORT *STEADY STATE TRANSPORT, DIRECT *STEP PERTURBATION, *STATIC *SUBSTRUCTURE GENERATE *USA ADDDED MASS GENERATION *VISCO `
totalTime: A Float specifying the analysis time spend in all the steps previous to this step. The default value is −1.0.

Returns:

An OdbStep object.

Raises:

If previousStepName is invalid:
ValueError: previousStepName is invalid

Notes

This function can be accessed by:

session.odbs[name].Step

Amplitude features of the Odb#

class AmplitudeOdb(name: str, analysisTitle: str = '', description: str = '', path: str = '')[source]#

The Odb object is the in-memory representation of an output database (ODB) file.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name]

Methods

`ActuatorAmplitude`(name[, timeSpan])	This method creates a ActuatorAmplitude object.
`DecayAmplitude`(name, initial, maximum, ...)	This method creates a DecayAmplitude object.
`EquallySpacedAmplitude`(name, fixedInterval, data)	This method creates an EquallySpacedAmplitude object.
`ModulatedAmplitude`(name, initial, magnitude, ...)	This method creates a ModulatedAmplitude object.
`PeriodicAmplitude`(name, frequency, start, ...)	This method creates a PeriodicAmplitude object.
`PsdDefinition`(name, data[, unitType, ...])	This method creates a PsdDefinition object.
`SmoothStepAmplitude`(name, data[, timeSpan])	This method creates a SmoothStepAmplitude object.
`SolutionDependentAmplitude`(name[, initial, ...])	This method creates a SolutionDependentAmplitude object.
`SpectrumAmplitude`(name, method, data[, ...])	This method creates a SpectrumAmplitude object.
`TabularAmplitude`(name, data[, smooth, timeSpan])	This method creates a TabularAmplitude object.

ActuatorAmplitude(name: str, timeSpan: SymbolicConstantType = 'STEP') → ActuatorAmplitude[source]#

This method creates a ActuatorAmplitude object.

Parameters:

name: A String specifying the repository key.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

An ActuatorAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].ActuatorAmplitude
session.odbs[name].ActuatorAmplitude

DecayAmplitude(name: str, initial: float, maximum: float, start: float, decayTime: float, timeSpan: SymbolicConstantType = 'STEP') → DecayAmplitude[source]#

This method creates a DecayAmplitude object.

Parameters:

name: A String specifying the repository key.
initial: A Float specifying the constant A0A0.
maximum: A Float specifying the coefficient AA.
start: A Float specifying the starting time t0t0. Possible values are non-negative numbers.
decayTime: A Float specifying the decay time tdtd. Possible values are non-negative numbers.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A DecayAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].DecayAmplitude
session.odbs[name].DecayAmplitude

EquallySpacedAmplitude(name: str, fixedInterval: float, data: tuple, begin: float = 0, smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP') → EquallySpacedAmplitude[source]#

This method creates an EquallySpacedAmplitude object.

Parameters:

name: A String specifying the repository key.
fixedInterval: A Float specifying the fixed time interval at which the amplitude data are given. Possible values are positive numbers.
data: A sequence of Floats specifying the amplitude values.
begin: A Float specifying the time at which the first amplitude data are given. Possible values are non-negative numbers. The default value is 0.0.
smooth: The SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing. Possible float values are 0 ≤≤ smoothing ≤≤ 0.5. If *smooth*=SOLVER_DEFAULT, the default degree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

An EquallySpacedAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].EquallySpacedAmplitude
session.odbs[name].EquallySpacedAmplitude

ModulatedAmplitude(name: str, initial: float, magnitude: float, start: float, frequency1: float, frequency2: float, timeSpan: SymbolicConstantType = 'STEP') → ModulatedAmplitude[source]#

This method creates a ModulatedAmplitude object.

Parameters:

name: A String specifying the repository key.
initial: A Float specifying the constant A0A0.
magnitude: A Float specifying the coefficient AA.
start: A Float specifying the starting time t0t0. Possible values are non-negative numbers.
frequency1: A Float specifying the circular frequency 1 (ω1ω1). Possible values are positive numbers.
frequency2: A Float specifying the circular frequency 2 (ω2ω2). Possible values are positive numbers.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A ModulatedAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].ModulatedAmplitude
session.odbs[name].ModulatedAmplitude

PeriodicAmplitude(name: str, frequency: float, start: float, a_0: float, data: tuple, timeSpan: SymbolicConstantType = 'STEP') → PeriodicAmplitude[source]#

This method creates a PeriodicAmplitude object.

Parameters:

name: A String specifying the repository key.
frequency: A Float specifying the circular frequency ωω. Possible values are positive numbers.
start: A Float specifying the starting time t0t0. Possible values are positive numbers.
a_0: A Float specifying the constant A0A0.
data: A sequence of pairs of Floats specifying AiAi and BiBi pairs.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A PeriodicAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].PeriodicAmplitude
session.odbs[name].PeriodicAmplitude

PsdDefinition(name: str, data: tuple, unitType: SymbolicConstantType = 'FORCE', referenceGravityAcceleration: float = 1, referenecePower: float = 0, user: BooleanType = 0, timeSpan: SymbolicConstantType = 'STEP', amplitude: str = '') → PsdDefinition[source]#

This method creates a PsdDefinition object.

Parameters:

name: A String specifying the repository key.
data: A sequence of sequences of Floats specifying the real part of the frequency function, the imaginary part of the frequency function, and the frequency or frequency band number values, depending on the value of unitType.
unitType: A SymbolicConstant specifying the type of units for specifying the frequency function. FORCE implies power units. BASE implies gravity used to define base motion. DB implies decibel units. Possible values are FORCE, BASE, and DB. The default value is FORCE.
referenceGravityAcceleration: A Float specifying the reference gravity acceleration. This argument applies when unitType = BASE. The default value is 1.0.
referenecePower: A Float specifying the reference power value, in load units squared. This argument applies when unitType = DB. The default value is 0.0.
user: A Boolean specifying whether the frequency function is defined in user subroutine UPSD. If specified, then data is not applicable, and the unitType value must not be DB. The default value is OFF.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.
amplitude: A String specifying the name of the amplitude that describes the dynamic event used to define the cross-spectral density frequency function. The default value is an empty string.

Returns:

A PsdDefinition object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].PsdDefinition
session.odbs[name].PsdDefinition

SmoothStepAmplitude(name: str, data: tuple, timeSpan: SymbolicConstantType = 'STEP') → SmoothStepAmplitude[source]#

This method creates a SmoothStepAmplitude object.

Parameters:

name: A String specifying the repository key.
data: A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency are positive numbers.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A SmoothStepAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].SmoothStepAmplitude
session.odbs[name].SmoothStepAmplitude

SolutionDependentAmplitude(name: str, initial: float = 1, minimum: float = 0, maximum: float = 1000, timeSpan: SymbolicConstantType = 'STEP') → SolutionDependentAmplitude[source]#

This method creates a SolutionDependentAmplitude object.

Parameters:

name: A String specifying the repository key.
initial: A Float specifying the initial amplitude value. Possible values are those between minimum and maximum. The default value is 1.0.
minimum: A Float specifying the minimum amplitude value. Possible values are those smaller than maximum and initial. The default value is 0.1.
maximum: A Float specifying the maximum amplitude value. Possible values are those larger than minimum and initial. The default value is 1000.0.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A SolutionDependentAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].SolutionDependentAmplitude
session.odbs[name].SolutionDependentAmplitude

SpectrumAmplitude(name: str, method: SymbolicConstantType, data: tuple, specificationUnits: SymbolicConstantType = 'ACCELERATION', eventUnits: SymbolicConstantType = 'EVENT_ACCELERATION', solution: SymbolicConstantType = 'ABSOLUTE_VALUE', timeIncrement: float = 0, gravity: float = 1, criticalDamping: BooleanType = 0, timeSpan: SymbolicConstantType = 'STEP', amplitude: str = '') → SpectrumAmplitude[source]#

This method creates a SpectrumAmplitude object.

Parameters:

name: A String specifying the repository key.
method: A SymbolicConstant specifying the method for specifying the spectrum. Possible values are DEFINE and CALCULATE.
data: A sequence of sequences of Floats specifying the magnitude, frequency, and damping values.
specificationUnits: A SymbolicConstant specifying the units used for specifying the spectrum. Possible values are DISPLACEMENT, VELOCITY, ACCELERATION, and GRAVITY. The default value is ACCELERATION.
eventUnits: A SymbolicConstant specifying the units used to describe the dynamic event in the amplitude used for the calculation. Possible values are EVENT_DISPLACEMENT, EVENT_VELOCITY, EVENT_ACCELERATION, and EVENT_GRAVITY. The default value is EVENT_ACCELERATION.
solution: A SymbolicConstant specifying the solution method for the dynamic equations. Possible values are ABSOLUTE_VALUE and RELATIVE_VALUE. The default value is ABSOLUTE_VALUE.
timeIncrement: A Float specifying the implicit time increment used to calculate the spectrum. This argument is required when the method = CALCULATE. The default value is 0.0.
gravity: A Float specifying the acceleration due to gravity. This argument applies only when specificationUnits = GRAVITY or*eventUnits* = GRAVITY. The default value is 1.0.
criticalDamping: A Boolean specifying whether to calculate the spectrum for only the specified range of critical damping values or a list of values. If criticalDamping = ON, the spectrum is calculated only for the specified range of critical damping values. If criticalDamping = OFF, the spectrum is calculated for a list of damping values. The default value is OFF.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.
amplitude: A String specifying the name of the amplitude that describes the dynamic event used to calculate the spectrum. The default value is an empty string.

Returns:

A SpectrumAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].SpectrumAmplitude
session.odbs[name].SpectrumAmplitude

TabularAmplitude(name: str, data: tuple, smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP') → TabularAmplitude[source]#

This method creates a TabularAmplitude object.

Parameters:

name: A String specifying the repository key.
data: A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency are positive numbers.
smooth: The SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing. Possible float values are between 0 and 0.5. If *smooth*=SOLVER_DEFAULT, the default degree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.
timeSpan: A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A TabularAmplitude object.

Raises:

InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].TabularAmplitude
session.odbs[name].TabularAmplitude

Filter features of the Odb#

Material features of the Odb#

class MaterialOdb(name: str, analysisTitle: str = '', description: str = '', path: str = '')[source]#

The Odb object is the in-memory representation of an output database (ODB) file.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name]

Methods

Material(name[, description, materialIdentifier])

This method creates a Material object.

Material(name: str, description: str = '', materialIdentifier: str = '')[source]#

This method creates a Material object.

Parameters:

name: A String specifying the name of the new material.
description: A String specifying user description of the material. The default value is an empty string.
materialIdentifier: A String specifying material identifier for customer use. The default value is an empty string.

Returns:

A Material object.

Notes

This function can be accessed by:

session.odbs[name].Material

Beam Section Profile features of the Odb#

class BeamSectionProfileOdb(name: str, analysisTitle: str = '', description: str = '', path: str = '')[source]#

The Odb object is the in-memory representation of an output database (ODB) file.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name]

Methods

`ArbitraryProfile`(name, table)	This method creates a ArbitraryProfile object.
`BoxProfile`(name, a, b, uniformThickness, t1)	This method creates a BoxProfile object.
`CircularProfile`(name, r)	This method creates a CircularProfile object.
`GeneralizedProfile`(name, area, i11, i12, ...)	This method creates a GeneralizedProfile object.
`HexagonalProfile`(name, r, t)	This method creates a HexagonalProfile object.
`IProfile`(name, l, h, b1, b2, t1, t2, t3)	This method creates an IProfile object.
`LProfile`(name, a, b, t1, t2)	This method creates a LProfile object.
`PipeProfile`(name, r, t)	This method creates a PipeProfile object.
`RectangularProfile`(name, a, b)	This method creates a RectangularProfile object.
`TProfile`(name, b, h, l, tf, tw)	This method creates a TProfile object.
`TrapezoidalProfile`(name, a, b, c, d)	This method creates a TrapezoidalProfile object.

ArbitraryProfile(name: str, table: tuple) → ArbitraryProfile[source]#

This method creates a ArbitraryProfile object.

Parameters:

name: A String specifying the repository key.
table: A sequence of sequences of Floats specifying the items described below.

Returns:

An ArbitraryProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].ArbitraryProfile
session.odbs[name].ArbitraryProfile

BoxProfile(name: str, a: float, b: float, uniformThickness: BooleanType, t1: float, t2: float = 0, t3: float = 0, t4: float = 0) → BoxProfile[source]#

This method creates a BoxProfile object.

Parameters:

name: A String specifying the repository key.
a: A Float specifying the a dimension of the box profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).
b: A Float specifying the b dimension of the box profile.
uniformThickness: A Boolean specifying whether the thickness is uniform.
t1: A Float specifying the uniform wall thickness if *uniformThickness*=ON, and the wall thickness of the first segment if *uniformThickness*=OFF.
t2: A Float specifying the wall thickness of the second segment. t2 is required only when *uniformThickness*=OFF. The default value is 0.0.
t3: A Float specifying the wall thickness of the third segment. t3 is required only when *uniformThickness*=OFF. The default value is 0.0.
t4: A Float specifying the wall thickness of the fourth segment. t4 is required only when *uniformThickness*=OFF. The default value is 0.0.

Returns:

A BoxProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].BoxProfile
session.odbs[name].BoxProfile

CircularProfile(name: str, r: float) → CircularProfile[source]#

This method creates a CircularProfile object.

Parameters:

name: A String specifying the repository key.
r: A positive Float specifying the r dimension (outer radius) of the circular profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).

Returns:

A CircularProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].CircularProfile
session.odbs[name].CircularProfile

GeneralizedProfile(name: str, area: float, i11: float, i12: float, i22: float, j: float, gammaO: float, gammaW: float) → GeneralizedProfile[source]#

This method creates a GeneralizedProfile object.

Parameters:

name: A String specifying the repository key.
area: A Float specifying the cross-sectional area for the profile.
i11: A Float specifying the moment of inertia for bending about the 1-axis, I11I11.
i12: A Float specifying the moment of inertia for cross bending, I12I12.
i22: A Float specifying the moment of inertia for bending about the 2-axis, I22I22.
j: A Float specifying the torsional constant, JJ.
gammaO: A Float specifying the sectorial moment, Γ0Γ0.
gammaW: A Float specifying the warping constant, ΓWΓW.

Returns:

A GeneralizedProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].GeneralizedProfile
session.odbs[name].GeneralizedProfile

HexagonalProfile(name: str, r: float, t: float) → HexagonalProfile[source]#

This method creates a HexagonalProfile object.

Parameters:

name: A String specifying the repository key.
r: A positive Float specifying the r dimension (outer radius) of the hexagonal profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).
t: A positive Float specifying the t dimension (wall thickness) of the hexagonal profile, t < (sqrt(3)/2)r.

Returns:

A HexagonalProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].HexagonalProfile
session.odbs[name].HexagonalProfile

IProfile(name: str, l: float, h: float, b1: float, b2: float, t1: float, t2: float, t3: float) → IProfile[source]#

This method creates an IProfile object.

Parameters:

name: A String specifying the repository key.
l: A Float specifying the l dimension (offset of 1–axis from the bottom flange surface) of the I profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).
h: A Float specifying the h dimension (height) of the I profile.
b1: A Float specifying the b1 dimension (bottom flange width) of the I profile.
b2: A Float specifying the b2 dimension (top flange width) of the I profile.
t1: A Float specifying the t1 dimension (bottom flange thickness) of the I profile.
t2: A Float specifying the t2 dimension (top flange thickness) of the I profile.
t3: A Float specifying the t3 dimension (web thickness) of the I profile.

Returns:

An IProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].IProfile
session.odbs[name].IProfile

LProfile(name: str, a: float, b: float, t1: float, t2: float) → LProfile[source]#

This method creates a LProfile object.

Parameters:

name: A String specifying the repository key.
a: A positive Float specifying the a dimension (flange length) of the L profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).
b: A positive Float specifying the b dimension (flange length) of the L profile.
t1: A positive Float specifying the t1 dimension (flange thickness) of the L profile (t1 < b).
t2: A positive Float specifying the t2 dimension (flange thickness) of the L profile (t2< a).

Returns:

A LProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].LProfile
session.odbs[name].LProfile

PipeProfile(name: str, r: float, t: float) → PipeProfile[source]#

This method creates a PipeProfile object.

Parameters:

name: A String specifying the repository key.
r: A Float specifying the outer radius of the pipe. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).
t: A Float specifying the wall thickness of the pipe.

Returns:

A PipeProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].PipeProfile
session.odbs[name].PipeProfile

RectangularProfile(name: str, a: float, b: float) → RectangularProfile[source]#

This method creates a RectangularProfile object.

Parameters:

name: A String specifying the repository key.
a: A positive Float specifying the a dimension of the rectangular profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).
b: A positive Float specifying the b dimension of the rectangular profile.

Returns:

A RectangularProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].RectangularProfile
session.odbs[name].RectangularProfile

TProfile(name: str, b: float, h: float, l: float, tf: float, tw: float) → TProfile[source]#

This method creates a TProfile object.

Parameters:

name: A String specifying the repository key.
b: A positive Float specifying the b dimension (flange width) of the T profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).
h: A positive Float specifying the h dimension (height) of the T profile.
l: A positive Float specifying the l dimension (offset of 1–axis from the edge of web) of the T profile.
tf: A positive Float specifying the tf dimension (flange thickness) of the T profile (tf < h).
tw: A positive Float specifying the tw dimension (web thickness) of the T profile (tw< b).

Returns:

A TProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].TProfile
session.odbs[name].TProfile

TrapezoidalProfile(name: str, a: float, b: float, c: float, d: float) → TrapezoidalProfile[source]#

This method creates a TrapezoidalProfile object.

Parameters:

name: A String specifying the repository key.
a: A positive Float specifying the a dimension of the Trapezoidal profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).
b: A positive Float specifying the b dimension of the Trapezoidal profile.
c: A positive Float specifying the c dimension of the Trapezoidal profile.
d: A Float specifying the d dimension of the Trapezoidal profile.

Returns:

A TrapezoidalProfile object.

Raises:

RangeError.
!img

Notes

This function can be accessed by:

mdb.models[name].TrapezoidalProfile
session.odbs[name].TrapezoidalProfile

AnalyticSurface#

class AnalyticSurface[source]#

The AnalyticSurface object is a geometric surface that can be described with straight and/or curved line segments.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].parts[name].analyticSurface
session.odbs[name].rootAssembly.instances[name].analyticSurface
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.analyticSurface

Attributes:

name: str: A String specifying the name of the analytic surface.
type: SymbolicConstant: A SymbolicConstant specifying the type of AnalyticSurface object. Possible values are SEGMENTS, CYLINDER, and REVOLUTION.
filletRadius: float: A Float specifying radius of curvature to smooth discontinuities between adjoining segments. The default value is 0.0.
segments: OdbSequenceAnalyticSurfaceSegment: An OdbSequenceAnalyticSurfaceSegment object specifying the profile associated with the surface.
localCoordData: float: A tuple of tuples of Floats specifying the global coordinates of points representing the local coordinate system, if used.

AnalyticSurfaceSegment#

class AnalyticSurfaceSegment(type: SymbolicConstantType, data: tuple)[source]#

An individual segment of the analytic surface.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].parts[name].analyticSurface.segments[i]
session.odbs[name].rootAssembly.instances[name].analyticSurface.segments[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.analyticSurface.segments[i]

BeamOrientation#

class BeamOrientation[source]#

The BeamOrientation object represents the direction of the first beam section axis n1n1. Specifying the beam orientation using an additional node in the element connectivity list is not supported.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].parts[name].beamOrientations[i]
session.odbs[name].rootAssembly.instances[name].beamOrientations[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.beamOrientations[i]

Attributes:

method: SymbolicConstant: A SymbolicConstant specifying the orientation assignment method. Possible values are N1_COSINES, CSYS, and VECT.
region: OdbSet: An OdbSet object specifying a region for which the beam orientation is defined.
vector: float: A tuple of Floats specifying direction cosines of the n1-direction of the beam cross-section.

BeamOrientationArray#

class BeamOrientationArray(iterable=(), /)[source]#

Methods

findAt

FieldBulkData#

class FieldBulkData[source]#

The FieldBulkData object represents the entire field data for a class of elements or nodes. All elements in a class correspond to the same element type and material.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].steps[name].frames[i].fieldOutputs[name].bulkDataBlocks[i]

Attributes:

position: SymbolicConstant

A SymbolicConstant specifying the position of the output in the element. Possible values are:

NODAL, specifying the values calculated at the nodes.

INTEGRATION_POINT, specifying the values calculated at the integration points.

ELEMENT_NODAL, specifying the values obtained by extrapolating results calculated at

the integration points.

ELEMENT_FACE.
CENTROID, specifying the value at the centroid obtained by extrapolating results

calculated at the integration points.

type: SymbolicConstant

A SymbolicConstant specifying the output type. Possible values are SCALAR, VECTOR, TENSOR_3D_FULL, TENSOR_3D_PLANAR, TENSOR_3D_SURFACE, TENSOR_2D_PLANAR, and TENSOR_2D_SURFACE.

instance: OdbInstance

An OdbInstance object specifying the part to which the labels belong.

sectionPoint: SectionPoint

A SectionPoint object specifying the section point number of the current block of data.

elementLabels: tuple

A sequence of Ints specifying the element labels of the elements in the block. elementLabels is valid only if position=INTEGRATION_POINT, CENTROID, ELEMENT_NODAL, or ELEMENT_FACE.

nodeLabels: tuple

A sequence of Ints specifying the node labels of the nodes in the block. nodelabels is valid only if position=ELEMENT_NODAL or NODAL.

componentLabels: tuple

A sequence of Strings specifying the component labels.

integrationPoints: tuple

A sequence of Ints specifying the integration points in the elements in the block. integrationPoints is available only if position=INTEGRATION_POINT.

data: tuple

A tuple of Floats specifying data in the form described by type. If type=TENSOR or VECTOR, data is a sequence containing the components for each element or node in the block. If the underlying data are in double precision, an exception will be thrown.

conjugateData: tuple

A tuple of Floats specifying data in the form described by type. If type=TENSOR or VECTOR, conjugateData is a sequence containing the imaginary part of the components for each element or node in the block. If the underlying data are in double precision, an exception will be thrown.

mises: tuple

A sequence of Floats specifying the calculated von Mises stress at each output location in the block of element data, or NULL. The value is valid only when the validInvariants member includes MISES; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

localCoordSystem: float

A pointer to an array of Floats specifying the quaternion representing the local coordinate system (the rotation from global to local) at each output location. The quaternion is returned in the form q=(q,q0), which is the reverse of that shown in [Rotation variables](https://help.3ds.com/2022/english/DSSIMULIA_Established/SIMACAETHERefMap/simathe-c-rotationvars.htm?ContextScope=all). localCoordSystem is available for TENSOR data written in a local coordinate system. It is also available for VECTOR data for connector element outputs. For connector element outputs the quaternion form is q=(q0,q)q=(q0,q), which represents the rotation from local to global. If the underlying data are in double precision, an exception will be thrown.

FieldLocation#

class FieldLocation[source]#

The FieldLocation object specifies locations for which data are available in the field. For example, a displacement field will have a FieldLocation object with a position member value of NODAL. The FieldLocation object has no constructor; it is created automatically as an element of the location member of a FieldOutput object by the addData method of a FieldOutput object.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].steps[name].frames[i].fieldOutputs[name].locations[i]

Attributes:

position: SymbolicConstant: A SymbolicConstant specifying the position of the output in the element. Possible values are:NODAL, specifying the values calculated at the nodes.INTEGRATION_POINT, specifying the values calculated at the integration points.ELEMENT_NODAL, specifying the values obtained by extrapolating results calculated at the integration points.ELEMENT_FACE.CENTROID, specifying the value at the centroid obtained by extrapolating results calculated at the integration points.
sectionPoints: SectionPointArray: A SectionPointArray object.

FieldLocationArray#

class FieldLocationArray(iterable=(), /)[source]#

Methods

findAt

FieldOutput#

class FieldOutput(name: str, description: str, type: SymbolicConstantType, componentLabels: tuple = (), validInvariants: SymbolicConstantType = None, isEngineeringTensor: BooleanType = OFF)[source]#

class FieldOutput(field: FieldOutput, name: str = '', description: str = '')

A FieldOutput object contains field data for a specific output variable.

Notes

This object can be accessed by:

import
odbAccess
session.odbs[name].steps[name].frames[i].fieldOutputs[name]

Attributes:

dim: int: An Int specifying the dimension of vector or the first dimension (number of rows) of matrix.
dim2: int: An Int specifying the second dimension (number of columns) of matrix.
isComplex: Boolean: A Boolean specifying whether the data are complex.
locations: FieldLocationArray: A FieldLocationArray object.
values: FieldValueArray: A FieldValueArray object specifying the order of the objects in the array is determined by the Abaqus Scripting Interface; see the data argument to the addData method for a description of the order.

Methods

`getConnectorFieldXformedToNodeA`([...])	This method generates a new vector field containing the transformed component values of the parent connector field to the node A coordinate system.
`setComponentLabels`(componentLabels)	This method sets the component labels for the FieldOutput object.
`setDataType`(type)	This method sets the data type of a FieldOutput object.
`setValidInvariants`(validInvariants)	This method sets the invariants valid for the FieldOutput object.

addData
getScalarField
getSubset
getTransformedField

getConnectorFieldXformedToNodeA(deformationField: FieldOutput | None = None)[source]#

This method generates a new vector field containing the transformed component values of the parent connector field to the node A coordinate system. The new field will hold values for the same connector elements as the parent field. Some connection types such as Axial, Link, Slip Ring, and Radial Thrust require that the deformationField be specified.

Parameters:

deformationField: A FieldOutput object specifying the nodal displacement vectors required by moving coordinate systems to determine instantaneous configurations.

Returns:

A FieldOutput object.

Raises:

The getConnectorFieldXformedToNodeA method throws an exception if the field requires a

deformationField and the argument is not supplied.: odbException: Deformation field is required for transforming this connector field.

setComponentLabels(componentLabels: tuple)[source]#

This method sets the component labels for the FieldOutput object.

Parameters:

componentLabels: A sequence of Strings specifying the labels for each component of the value. The length of the sequence must match the type. If type*=TENSOR, the default value is *name with the suffixes (‘11’, ‘22’, ‘33’, ‘12’, ‘13’, ‘23’). If type*=VECTOR, the default value is *name with the suffixes (‘1’, ‘2’, ‘3’). If *type*=SCALAR, the default value is an empty sequence.

setDataType(type: SymbolicConstantType)[source]#

This method sets the data type of a FieldOutput object.

Parameters:

type: A SymbolicConstant specifying the output type. Possible values are SCALAR, VECTOR, TENSOR_3D_FULL, TENSOR_3D_PLANAR, TENSOR_3D_SURFACE, TENSOR_2D_PLANAR, and TENSOR_2D_SURFACE.

setValidInvariants(validInvariants: SymbolicConstantType)[source]#

This method sets the invariants valid for the FieldOutput object.

Parameters:

validInvariants

A sequence of SymbolicConstants specifying which invariants should be calculated for this field. An empty sequence indicates that no invariants are valid for this field. Possible values are:

MAGNITUDE
MISES
TRESCA
PRESS
INV3
MAX_PRINCIPAL
MID_PRINCIPAL
MIN_PRINCIPAL
MAX_INPLANE_PRINCIPAL
MIN_INPLANE_PRINCIPAL
OUTOFPLANE_PRINCIPAL

The default value is an empty sequence.

FieldValue#

class FieldValue[source]#

The FieldValue object represents the field data at a point. The FieldValue object has no constructor; it is created by the Odb object when data are added to the FieldOutput object using the addData method. For faster, bulk-data access, see Using bulk data access to an output database.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i]

Attributes:

position: SymbolicConstant

A SymbolicConstant specifying the position of the output in the element. Possible values are:

NODAL, specifying the values calculated at the nodes.

INTEGRATION_POINT, specifying the values calculated at the integration points.

ELEMENT_NODAL, specifying the values obtained by extrapolating results calculated at

the integration points.

ELEMENT_FACE, specifying the results obtained for surface variables such as cavity

radiation that are defined for the surface facets of an element.

CENTROID, specifying the value at the centroid obtained by extrapolating results

calculated at the integration points.

precision: SymbolicConstant

A SymbolicConstant specifying the precision of the output in the element. Possible values are:

SINGLE_PRECISION, specifying that the output values are in single precision.

DOUBLE_PRECISION, specifying that the output values are in double precision.

elementLabel: int

An Int specifying the element label of the element containing the location. elementLabel is available only if position=INTEGRATION_POINT, CENTROID, ELEMENT_NODAL, or ELEMENT_FACE.

nodeLabel: int

An Int specifying the node label of the node containing the location. nodelabel is available only if position=ELEMENT_NODAL or NODAL.

integrationPoint: int

An Int specifying the integration point in the element. integrationPoint is available only if position=INTEGRATION_POINT.

face: SymbolicConstant

A SymbolicConstant specifying the face of the element. face is available only if position=ELEMENT_FACE.

type: SymbolicConstant

A SymbolicConstant specifying the output type. Possible values are SCALAR, VECTOR, TENSOR_3D_FULL, TENSOR_3D_PLANAR, TENSOR_3D_SURFACE, TENSOR_2D_PLANAR, and TENSOR_2D_SURFACE.

magnitude: float

A Float specifying the length or magnitude of the vector. magnitude is valid only when type=VECTOR.

mises: float

A Float specifying the calculated von Mises stress. The value is valid only when the validInvariants member includes MISES; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

tresca: float

A Float specifying the calculated Tresca stress. The value is valid only when the validInvariants member includes TRESCA; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

press: float

A Float specifying the calculated pressure stress. The value is valid only when the validInvariants member includes PRESS; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

inv3: float

A Float specifying the calculated third stress invariant. The value is valid only when the validInvariants member includes INV3; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

maxPrincipal: float

A Float specifying the calculated maximum principal stress. The value is valid only when the validInvariants member includes MAX_PRINCIPAL; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

midPrincipal: float

A Float specifying the calculated intermediate principal stress. The value is valid only when the validInvariants member includes MID_PRINCIPAL; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

minPrincipal: float

A Float specifying the minimum principal stress. The value is valid only when the validInvariants member includes MIN_PRINCIPAL; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

maxInPlanePrincipal: float

A Float specifying the maximum principal in-plane stress. The value is valid only when the validInvariants member includes MAX_INPLANE_PRINCIPAL; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

minInPlanePrincipal: float

A Float specifying the calculated minimum principal in-plane stress. The value is valid only when the validInvariants member includes MIN_INPLANE_PRINCIPAL; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

outOfPlanePrincipal: float

A Float specifying the calculated principal out-of-plane stress. The value is valid only when the validInvariants member includes OUTOFPLANE_PRINCIPAL; otherwise, the value is indeterminate. Conjugate data will be ignored in invariant calculation.

instance: OdbInstance

An OdbInstance object specifying the part to which the labels belong.

sectionPoint: SectionPoint

A SectionPoint object.

localCoordSystem: tuple

A tuple of tuples of Floats specifying the 3 × 3 matrix of Floats specifying the direction cosines of the local coordinate system (the rotation from global to local). Each sequence represents a row in the direction cosine matrix. localCoordSystem is available for TENSOR data written in a local coordinate system. It is also available for VECTOR data for connector element outputs. For connector element outputs the rotation is from local to global. If the underlying data are in double precision, an exception will be thrown.

localCoordSystemDouble: tuple

A tuple of tuples of Floats specifying the 3 × 3 matrix of Doubles specifying the direction cosines of the local coordinate system (the rotation from global to local). Each sequence represents a row in the direction cosine matrix. localCoordSystemDouble is available for TENSOR data written in a local coordinate system. It is also available for VECTOR data for connector element outputs. For connector element outputs the rotation is from local to global. If the underlying data are in single precision, an exception will be thrown.

data: tuple

A tuple of Floats specifying data in the form described by type. If type=TENSOR or VECTOR, data is a sequence containing the components. If the underlying data are in double precision an exception will be thrown.

dataDouble: tuple

conjugateData: tuple

A tuple of Floats specifying data in the form described by type. If type=TENSOR or VECTOR, conjugateData is a sequence containing the components. If the underlying data are in double precision, an exception will be thrown.

conjugateDataDouble: tuple

HistoryOutput#

class HistoryOutput(name: str, description: str, type: SymbolicConstantType, validInvariants: SymbolicConstantType | None = None)[source]#

The HistoryOutput object contains the history output at a point for the specified variable.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].steps[name].historyRegions[name].historyOutputs[name]

Attributes:

data: float: A tuple of pairs of Floats specifying the pairs (frameValue, value) where frameValue is either time, frequency, or mode and value is the value of the specified variable at frameValue. (This value depends on the type of the variable.)
conjugateData: float: A tuple of pairs of Floats specifying the imaginary portion of a specified complex variable at each frame value (time, frequency, or mode). The pairs have the form (frameValue, value).

Methods

addData

HistoryPoint#

class HistoryPoint(node: OdbMeshNode)[source]#

class HistoryPoint(element: OdbMeshElement, ipNumber: int = 0, sectionPoint: SectionPoint = None, face: SymbolicConstantType = FACE_UNKNOWN, node: OdbMeshNode = OdbMeshNode())

class HistoryPoint(region: OdbSet)

class HistoryPoint(assembly: OdbAssembly)

class HistoryPoint(instance: OdbInstance)

The HistoryPoint object specifies the point at which history data will be collected. The HistoryPoint object is a temporary object used as an argument to the HistoryRegion method.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].steps[name].historyRegions[name].point

Attributes:

ipNumber: int

An Int specifying the integration point. This argument is used to define a history output position of INTEGRATION_POINT or ELEMENT_FACE_INTEGRATION_POINT. The default value is 0.

face: SymbolicConstant

A SymbolicConstant specifying the element face. This argument is used to define a history output position of ELEMENT_FACE or ELEMENT_FACE_INTEGRATION_POINT. Possible values are:

FACE_UNKOWN, specifying this value indicates that no value has been specified.

FACE1, specifying this value indicates that element face 1 has been specified.

FACE2, specifying this value indicates that element face 2 has been specified.

FACE3, specifying this value indicates that element face 3 has been specified.

FACE4, specifying this value indicates that element face 4 has been specified.

FACE5, specifying this value indicates that element face 5 has been specified.

FACE6, specifying this value indicates that element face 6 has been specified.

SIDE1, specifying this value indicates that element side 1 has been specified.

SIDE2, specifying this value indicates element side 2 has been specified.

END1, specifying this value indicates that element end 1 has been specified.

END2, specifying this value indicates that element end 2 has been specified.

END3, specifying this value indicates that element end 3 has been specified.

The default value is FACE_UNKNOWN.

position: SymbolicConstant

A SymbolicConstant specifying the result position of the history point. Possible values are:

NODAL, specifying the values calculated at the nodes.

ELEMENT_NODAL, specifying the values obtained by extrapolating results calculated at

the integration points.

INTEGRATION_POINT, specifying the values calculated at the integration points.
ELEMENT_FACE, specifying the results obtained for surface variables such as cavity

radiation that are defined for the surface facets of an element.

ELEMENT_FACE_INTEGRATION_POINT, specifying the results obtained for surface variables

such as cavity radiation that are defined for the surface facets of an element when the surface facets have integration points.

WHOLE_ELEMENT, specifying the results obtained for whole element variables.

WHOLE_REGION, specifying the results for an entire region of the model.

WHOLE_PART_INSTANCE, specifying the results for an entire part instance of the model.

WHOLE_MODEL, specifying the results for the entire model.

element: OdbMeshElement

An OdbMeshElement object specifying the element for which the data are to be collected.

sectionPoint: SectionPoint

A SectionPoint object.

region: OdbSet

An OdbSet object specifying the region for which the data are to be collected.

assembly: OdbAssembly

An OdbAssembly object specifying the assembly for which the data are to be collected.

instance: OdbInstance

An OdbInstance object specifying the instance for which the data are to be collected.

HistoryRegion#

class HistoryRegion(name: str, description: str, point: HistoryPoint, loadCase: str | None = None)[source]#

The HistoryRegion object contains history data for a single location in the model.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].steps[name].historyRegions[name]

Attributes:

position: SymbolicConstant: A SymbolicConstant specifying the position of the history output. Possible values are NODAL, INTEGRATION_POINT, WHOLE_ELEMENT, WHOLE_REGION, and WHOLE_MODEL.
historyOutputs: dict[str, HistoryOutput]: A repository of HistoryOutput objects.

Methods

HistoryOutput(name, description, type[, ...])

This method creates a HistoryOutput object.

getSubset

HistoryOutput(name: str, description: str, type: SymbolicConstantType, validInvariants: SymbolicConstantType | None = None)[source]#

This method creates a HistoryOutput object.

Parameters:

name: A String specifying the output variable name.
description: A String specifying the output variable.
type: A SymbolicConstant specifying the output type. Only SCALAR is currently supported.
validInvariants: A sequence of SymbolicConstants specifying which invariants should be calculated for this field. Possible values are MAGNITUDE, MISES, TRESCA, PRESS, INV3, MAX_PRINCIPAL, MID_PRINCIPAL, and MIN_PRINCIPAL. The default value is an empty sequence.

Returns:

A HistoryOutput object.

Notes

This function can be accessed by:

session.odbs[name].steps[name].HistoryRegion

JobData#

class JobData[source]#

The JobData object describes the context in which the analysis was run.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].jobData

Attributes:

name: str: A String specifying the name of the job.
analysisCode: SymbolicConstant: A SymbolicConstant specifying the analysis code. Possible values are ABAQUS_STANDARD, ABAQUS_EXPLICIT, and UNKNOWN_ANALYSIS_CODE.
precision: SymbolicConstant: A SymbolicConstant specifying the precision. Only SINGLE_PRECISION is currently supported. Possible values are DOUBLE_PRECISION and SINGLE_PRECISION.
version: str: A String specifying the release of the analysis code.
creationTime: str: A String specifying the date and time at which the analysis was run.
modificationTime: str: A String specifying the date and time at which the database was last modified.
machineName: str: A String specifying the name of the machine on which the analysis was run.
productAddOns: str: A String specifying an odb_Sequence of productAddOns. Possible values are: Possible values are AQUA, DESIGN, BIORID, CEL, SOLITER, and CAVPARALLEL.

OdbAssembly#

class OdbAssembly[source]#

Methods

`DatumCsys`(name, datumCsys)	This method copies oneOdbDatumCsys object to a new OdbDatumCsys object.
`DatumCsysBy6dofNode`(name, coordSysType, origin)	A datum coordinate system created with this method results in a system that follows the position of a node.
`DatumCsysByThreeCircNodes`(name, ...)	This method is convenient to use where there are no nodes along the axis of a hollow cylinder or at the center of a hollow sphere.
`DatumCsysByThreeNodes`(name, coordSysType, ...)	This method creates an OdbDatumCsys object using the coordinates of three OdbMeshNode objects.
`DatumCsysByThreePoints`(name, coordSysType, ...)	This method creates an OdbDatumCsys object using three points.
`Instance`(name, object[, localCoordSystem])	This method creates an OdbInstance object from an OdbPart object.
`NodeSet`(name, nodes)	This method creates a node set from an array of OdbMeshNode objects (for part instance-level sets) or from a sequence of arrays of OdbMeshNode objects (for assembly-level sets).
`OdbRigidBody`(referenceNode[, position, ...])	This method creates a OdbRigidBody object.

ConnectorOrientation(region: str, localCsys1: ~abaqus.Odb.OdbDatumCsys.OdbDatumCsys = <abaqus.Odb.OdbDatumCsys.OdbDatumCsys object>, axis1: ~abaqusConstants.SymbolicConstantType = 'AXIS_1', angle1: float = 0, orient2sameAs1: ~abaqusConstants.BooleanType = 0, localCsys2: ~abaqus.Odb.OdbDatumCsys.OdbDatumCsys = <abaqus.Odb.OdbDatumCsys.OdbDatumCsys object>, axis2: ~abaqusConstants.SymbolicConstantType = 'AXIS_1', angle2: float = 0)[source]#

This method assigns a connector orientation to a connector region.

Parameters:

region: An OdbSet specifying a region.
localCsys1: An OdbDatumCsys object specifying the first connector node local coordinate system or None, indicating the global coordinate system.
axis1: A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system about which an additional rotation of the first connector node is applied. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle1: A Float specifying the angle of the additional rotation about the first connector node axis. The default value is 0.0.
orient2sameAs1: A Boolean specifying whether the same orientation settings should be used for the second node of the connector. The default value is OFF.
localCsys2: An OdbDatumCsys object specifying the second connector node local coordinate system or None, indicating the global coordinate system.
axis2: A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system about which an additional rotation of the second connector node is applied. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle2: A Float specifying the angle of the additional rotation about the second connector node axis. The default value is 0.0.

Raises:

If region is not an element set:
OdbError: Connector orientation assignment requires element set.

DatumCsys(name: str, datumCsys: OdbDatumCsys)[source]#

This method copies oneOdbDatumCsys object to a new OdbDatumCsys object.

Parameters:

name: A String specifying the repository key.
datumCsys: An OdbDatumCsys object specifying the object to be copied.

Returns:

An OdbDatumCsys object.

Notes

This function can be accessed by:

session.odbs[name].rootAssembly.DatumCsys

DatumCsysBy6dofNode(name: str, coordSysType: SymbolicConstantType, origin: OdbMeshNode)[source]#

A datum coordinate system created with this method results in a system that follows the position of a node. The node location defines the origin of the datum coordinate system. The rotational displacement (UR1, UR2, UR3) of the node defines the orientation of the coordinate system axes. Results, such as those for displacement, are resolved into the orientation of the datum coordinate system without regard to the position of its origin. The last argument is given in the form of an OdbMeshNode object.

Parameters:

name: A String specifying the repository key.
coordSysType: A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL.
origin: An OdbMeshNode object specifying the origin of the datum coordinate system.

Returns:

An OdbDatumCsys object.

Notes

This function can be accessed by:

session.odbs[name].rootAssembly.DatumCsysBy6dofNode

DatumCsysByThreeCircNodes(name: str, coordSysType: SymbolicConstantType, node1Arc: OdbMeshNode, node2Arc: OdbMeshNode, node3Arc: OdbMeshNode)[source]#

This method is convenient to use where there are no nodes along the axis of a hollow cylinder or at the center of a hollow sphere. The three nodes that you provide as arguments determine a circle in space. The center of the circle is the origin of the datum coordinate system. The normal to the circle is parallel to the zz-axis of a cylindrical coordinate system or to the ϕϕ-axis of a spherical coordinate system. The line from the origin to the first node defines the rr-axis.

Parameters:

name: A String specifying the repository key.
coordSysType: A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL.
node1Arc: An OdbMeshNode object that lies on the circular arc.
node2Arc: An OdbMeshNode object that lies on the circular arc.
node3Arc: An OdbMeshNode object that lies on the circular arc.

Returns:

An OdbDatumCsys object.

Notes

This function can be accessed by:

session.odbs[name].rootAssembly.DatumCsysByThreeCircNodes

DatumCsysByThreeNodes(name: str, coordSysType: SymbolicConstantType, origin: OdbMeshNode, point1: OdbMeshNode, point2: OdbMeshNode)[source]#

This method creates an OdbDatumCsys object using the coordinates of three OdbMeshNode objects. A datum coordinate system created with this method results in a system that follows the position of the three nodes. Results, such as those for displacement, are resolved into the orientation of the datum coordinate system without regard to the position of its origin. The last three arguments are given in the form of an OdbMeshNode object.

Parameters:

name: A String specifying the repository key.
coordSysType: A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL.
origin: An OdbMeshNode object specifying a node at the origin of the datum coordinate system.
point1: An OdbMeshNode object specifying a node on the local 1- or rr-axis.
point2: An OdbMeshNode object specifying a node in the 1–2 or rr–θθ plane.

Returns:

An OdbDatumCsys object.

Notes

This function can be accessed by:

session.odbs[name].rootAssembly.DatumCsysByThreeNodes

DatumCsysByThreePoints(name: str, coordSysType: SymbolicConstantType, origin: tuple, point1: tuple, point2: tuple)[source]#

This method creates an OdbDatumCsys object using three points. A datum coordinate system created with this method results in a fixed system.

Parameters:

name: A String specifying the repository key.
coordSysType: A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL.
origin: A sequence of Floats specifying the coordinates of the origin of the datum coordinate system.
point1: A sequence of Floats specifying the coordinates of a point on the local 1- or rr-axis.
point2: A sequence of Floats specifying the coordinates of a point in the 1–2 or rr–θθ plane.

Returns:

An OdbDatumCsys object.

Notes

This function can be accessed by:

session.odbs[name].rootAssembly.DatumCsysByThreePoints

Instance(name: str, object: OdbPart, localCoordSystem: tuple = ()) → OdbInstance[source]#

This method creates an OdbInstance object from an OdbPart object.

Parameters:

name: A String specifying the instance name.
object: An OdbPart object.
localCoordSystem: A sequence of sequences of three Floats specifying the rotation and translation of the part instance in the global Cartesian coordinate system. The first three sequences specify the new local coordinate system with its center at the origin.The first sequence specifies a point on the 1-axis.The second sequence specifies a point on the 2-axis.The third sequence specifies a point on the 3-axis.The fourth sequence specifies the translation of the local coordinate system from the origin to its intended location.For example, the following sequence moves a part 10 units in the X-direction with no rotation:localCoordSystem = ((1, 0, 0), (0, 1, 0), (0, 0, 1), (10, 0, 0))`The following sequence moves a part 5 units in the *X*-direction with rotation: `localCoordSystem = ((0, 1, 0), (1, 0, 0), (0, 0, 1), (5, 0, 0))`transforms a part containing the two points`Pt1= (1,0,0) Pt2= (2,0,0) to Pt1 = (0, 6, 0) Pt2 = (0, 7, 0)

Returns:

An OdbInstance object.

Notes

This function can be accessed by:

session.odbs[*name*].rootAssembly.Instance

NodeSet(name: str, nodes: tuple[OdbMeshNode]) → OdbSet[source]#

This method creates a node set from an array of OdbMeshNode objects (for part instance-level sets) or from a sequence of arrays of OdbMeshNode objects (for assembly-level sets).

Parameters:

name: A String specifying the name of the set and the repository key.
nodes: A sequence of OdbMeshNode objects. For example, for a part:nodes=part1.nodes[1:5]`For an assembly:`nodes=(instance1.nodes[6:7], instance2.nodes[1:5])

Returns:

An OdbSet object.

Notes

This function can be accessed by:

session.odbs[*name*].parts[*name*].NodeSet
session.odbs[*name*].rootAssembly.instances[*name*].NodeSet
session.odbs[*name*].rootAssembly.NodeSet

OdbRigidBody(referenceNode: ~abaqus.Odb.OdbSet.OdbSet, position: ~abaqusConstants.SymbolicConstantType = 'INPUT', isothermal: ~abaqusConstants.BooleanType = 1, elements: ~abaqus.Odb.OdbSet.OdbSet = <abaqus.Odb.OdbSet.OdbSet object>, tieNodes: ~abaqus.Odb.OdbSet.OdbSet = <abaqus.Odb.OdbSet.OdbSet object>, pinNodes: ~abaqus.Odb.OdbSet.OdbSet = <abaqus.Odb.OdbSet.OdbSet object>, analyticSurface: ~abaqus.Odb.AnalyticSurface.AnalyticSurface = <abaqus.Odb.AnalyticSurface.AnalyticSurface object>) → OdbRigidBody[source]#

This method creates a OdbRigidBody object.

Parameters:

referenceNode: An OdbSet object specifying the reference node set associated with the rigid body.
position: A SymbolicConstant specifying the specific location of the OdbRigidBody reference node relative to the rest of the rigid body. Possible values are INPUT and CENTER_OF_MASS. The default value is INPUT.
isothermal: A Boolean specifying specify whether the OdbRigidBody can have temperature gradients or be isothermal. This is used only for fully coupled thermal-stress analysis The default value is ON.
elements: An OdbSet object specifying the element set whose motion is governed by the motion of rigid body reference node.
tieNodes: An OdbSet object specifying the node set which have both translational and rotational degrees of freedom associated with the rigid body.
pinNodes: An OdbSet object specifying the node set which have only translational degrees of freedom associated with the rigid body.
analyticSurface: An AnalyticSurface object specifying the analytic surface whose motion is governed by the motion of rigid body reference node.

Returns:

An OdbRigidBody object.

Notes

This function can be accessed by:

session.odbs[*name*].rootAssembly.instances[*name*].RigidBody
session.odbs[*name*].rootAssembly.RigidBody

RigidBody(referenceNode: str, position: str = 'INPUT', isothermal: BooleanType = 0, elset: str = '', pinNodes: str = '', tieNodes: str = '', analyticSurface: str = '')[source]#

This method defines an OdbRigidBody on the assembly.

Parameters:

referenceNode: An OdbSet specifying the reference node assigned to the rigid body.
position: A symbolic constant specify if the location of the reference node is to be defined by the user. Possible values are INPUT and CENTER_OF_MASS. The default value is INPUT.
isothermal: A Boolean specifying an isothermal rigid body. The default value is OFF. This parameter is used only for a fully coupled thermal stress analysis.
elset: An OdbSet specifying an element set assigned to the rigid body.
pinNodes: An OdbSet specifying pin-type nodes assigned to the rigid body.
tieNodes: An OdbSet specifying tie-type nodes assigned to the rigid body.
analyticSurface: An AnalyticSurface specifying the Analytic Rigid Surface assigned to the rigid body.

Raises:

If referenceNode is not a node set:
OdbError: Rigid body definition requires a node set.

SectionAssignment(region: str, section: Section)[source]#

This method is used to assign a section on an assembly or part. Section assignment on the assembly is limited to the connector elements only.

Parameters:

region: An OdbSet specifying a region.
section: A Section object.

Raises:

If region is not an element set:
OdbError: Section assignment requires element set.

addElements(labels: tuple, connectivity: tuple, instanceNames: tuple, type: str, elementSetName: str = '', sectionCategory: SectionCategory | None = None)[source]#

This method is used to define elements using nodes defined at the OdbAssembly and/or OdbInstance level. For connector elements connected to ground, specify the lone node in the connectivity. The position of the ground node cannot be specified. This is a limitation. Warning:Adding elements not in ascending order of their labels may cause Abaqus/Viewer to plot contours incorrectly.

Parameters:

labels: A sequence of Ints specifying the element labels.
connectivity: A sequence of sequences of Ints specifying the nodal connectivity.
instanceNames: A sequence of Strings specifying the instanceNames of each node in the nodal connectivity array. If the node is defined at the assembly level, the instance name should be an empty string
type: A String specifying the element type.
elementSetName: A String specifying a name for this element set. The default value is the empty string.
sectionCategory: A SectionCategory object for this element set.

Raises:

Only certain element types are permitted at the assembly level. e.g., connector

elements.: OdbError: Addition of this element type is not permitted at the assembly level

If length of label array does not match connectivity data length:
OdbError: Connectivity array must be provided for all element

addNodes(labels: tuple, coordinates: tuple, nodeSetName: str | None = None)[source]#

This method adds nodes to the OdbAssembly object using node labels and coordinates. Warning:Adding nodes not in ascending order of their labels may cause Abaqus/Viewer to plot contours incorrectly.

Parameters:

labels: A sequence of Ints specifying the node labels.
coordinates: A sequence of sequences of Floats specifying the nodal coordinates.
nodeSetName: A String specifying a name for this node set. The default value is None.

Raises:

If length of labels does not match length of coordinates:
OdbError: Number of node labels and coordinates does not match
If width of coordinate array does not match assembly dimension:
OdbError: Node location specification does not correspond to part dimensions

OdbCommands#

OdbDatumCsys#

class OdbDatumCsys[source]#

The OdbDatumCsys object contains a coordinate system that can be stored in an output database. You can create the datum coordinate system in the Visualization module during an Abaqus/CAE session and save the datum coordinate system to the output database before you exit Abaqus/CAE. Alternatively, the analysis code can write the datum coordinate system to the output database.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].rootAssembly.datumCsyses[name]

Attributes:

name: str: A String specifying the repository key.
coordSysType: SymbolicConstant: A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL.
origin: float: A tuple of Floats specifying the coordinates of the origin of the datum coordinate system.
xAxis: float: A tuple of Floats specifying a point on the X-axis.
yAxis: float: A tuple of Floats specifying a point on the Y-axis.
zAxis: float: A tuple of Floats specifying a point on the Z-axis.

Methods

`DatumCsys`(name, datumCsys)	This method copies oneOdbDatumCsys object to a new OdbDatumCsys object.
`DatumCsysBy6dofNode`(name, coordSysType, origin)	A datum coordinate system created with this method results in a system that follows the position of a node.
`DatumCsysByThreeCircNodes`(name, ...)	This method is convenient to use where there are no nodes along the axis of a hollow cylinder or at the center of a hollow sphere.
`DatumCsysByThreeNodes`(name, coordSysType, ...)	This method creates an OdbDatumCsys object using the coordinates of three OdbMeshNode objects.
`DatumCsysByThreePoints`(name, coordSysType, ...)	This method creates an OdbDatumCsys object using three points.
`globalToLocal`(coordinates)	This method transforms specified coordinates in the global coordinate system into this local coordinate system.
`localToGlobal`(coordinates)	This method transforms specified coordinates in this local coordinate system into the global coordinate system.

DatumCsys(name: str, datumCsys: OdbDatumCsys)[source]#

This method copies oneOdbDatumCsys object to a new OdbDatumCsys object.

Parameters:

name: A String specifying the repository key.
datumCsys: An OdbDatumCsys object specifying the object to be copied.

Returns:

An OdbDatumCsys object.

Notes

This function can be accessed by:

session.odbs[name].rootAssembly.DatumCsysByThreePoints

DatumCsysBy6dofNode(name: str, coordSysType: SymbolicConstantType, origin: OdbMeshNode)[source]#

Parameters:

name: A String specifying the repository key.
coordSysType: A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL.
origin: An OdbMeshNode object specifying the origin of the datum coordinate system.

Returns:

An OdbDatumCsys object.

Notes

This function can be accessed by:

session.odbs[name].rootAssembly.DatumCsysByThreePoints

DatumCsysByThreeCircNodes(name: str, coordSysType: SymbolicConstantType, node1Arc: OdbMeshNode, node2Arc: OdbMeshNode, node3Arc: OdbMeshNode)[source]#

Parameters:

name: A String specifying the repository key.
coordSysType: A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL.
node1Arc: An OdbMeshNode object that lies on the circular arc.
node2Arc: An OdbMeshNode object that lies on the circular arc.
node3Arc: An OdbMeshNode object that lies on the circular arc.

Returns:

An OdbDatumCsys object.

Notes

This function can be accessed by:

session.odbs[name].rootAssembly.DatumCsysByThreePoints

DatumCsysByThreeNodes(name: str, coordSysType: SymbolicConstantType, origin: OdbMeshNode, point1: OdbMeshNode, point2: OdbMeshNode)[source]#

Parameters:

name: A String specifying the repository key.
coordSysType: A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL.
origin: An OdbMeshNode object specifying a node at the origin of the datum coordinate system.
point1: An OdbMeshNode object specifying a node on the local 1- or rr-axis.
point2: An OdbMeshNode object specifying a node in the 1–2 or rr–θθ plane.

Returns:

An OdbDatumCsys object.

Notes

This function can be accessed by:

session.odbs[name].rootAssembly.DatumCsysByThreePoints

DatumCsysByThreePoints(name: str, coordSysType: SymbolicConstantType, origin: tuple, point1: tuple, point2: tuple)[source]#

This method creates an OdbDatumCsys object using three points. A datum coordinate system created with this method results in a fixed system.

Parameters:

name: A String specifying the repository key.
coordSysType: A SymbolicConstant specifying the type of coordinate system. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL.
origin: A sequence of Floats specifying the coordinates of the origin of the datum coordinate system.
point1: A sequence of Floats specifying the coordinates of a point on the local 1- or rr-axis.
point2: A sequence of Floats specifying the coordinates of a point in the 1–2 or rr–θθ plane.

Returns:

An OdbDatumCsys object.

Notes

This function can be accessed by:

session.odbs[name].rootAssembly.DatumCsysByThreePoints

globalToLocal(coordinates: tuple[float, float, float]) → tuple[float, float, float][source]#

This method transforms specified coordinates in the global coordinate system into this local coordinate system.

Parameters:

coordinates: A tuple of three Floats representing the coordinates in the global coordinate system.

Returns:

python:tuple[python:float, python:float, python:float]: A tuple of three Floats representing the coordinates in this local coordinate system.

localToGlobal(coordinates: tuple[float, float, float]) → tuple[float, float, float][source]#

This method transforms specified coordinates in this local coordinate system into the global coordinate system.

Parameters:

coordinates: A tuple of three Floats representing the coordinates in the local coordinate system.

Returns:

python:tuple[python:float, python:float, python:float]: A tuple of three Floats representing the coordinates in this global coordinate system.

OdbFrame#

class OdbFrame(incrementNumber: int, frameValue: float, description: str = '')[source]#

class OdbFrame(mode: int, frequency: float, description: str = '')

class OdbFrame(loadCase: OdbLoadCase, description: str = '', frequency: float = 0)

The domain of the OdbFrame object is taken from the parent step.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].steps[name].frames[i]

Attributes:

cyclicModeNumber: int: An Int specifying the cyclic mode number associated with the data stored on this frame. Only frequency analyses of cyclic symmetry models possess cyclic mode numbers.
domain: SymbolicConstant: A SymbolicConstant specifying the domain of the step of which the frame is a member. Possible values are TIME, FREQUENCY, and MODAL.
frequency: float: A Float specifying the frequency. This member is valid only if domain=FREQUENCY or if the procedureType member of the Step object=FREQUENCY. The default value is 0.0.
mode: int: An Int specifying the eigenmode. This member is valid only if domain=MODAL.
associatedFrame: ‘OdbFrame’: An OdbFrame object specifying the real or imaginary portion of the data corresponding to this cyclic symmetry mode.
fieldOutputs: dict[str, FieldOutput]: A repository of FieldOutput objects specifying the key to the **fieldOutputs**repository is a String representing an output variable.
loadCase: OdbLoadCase: An OdbLoadCase object specifying the load case for the frame.

Methods

FieldOutput
Frame

OdbFrameArray#

class OdbFrameArray(iterable=(), /)[source]#

Methods

findAt

OdbInstance#

class OdbInstance(name: str, object: OdbPart, localCoordSystem: tuple = ())[source]#

Methods

`NodeSet`(name, nodes)	This method creates a node set from an array of OdbMeshNode objects (for part instance-level sets) or from a sequence of arrays of OdbMeshNode objects (for assembly-level sets).
`OdbRigidBody`(referenceNode[, position, ...])	This method creates a OdbRigidBody object.

NodeSet(name: str, nodes: tuple[OdbMeshNode]) → OdbSet[source]#

This method creates a node set from an array of OdbMeshNode objects (for part instance-level sets) or from a sequence of arrays of OdbMeshNode objects (for assembly-level sets).

Parameters:

name: A String specifying the name of the set and the repository key.
nodes: A sequence of OdbMeshNode objects. For example, for a part:nodes=part1.nodes[1:5]`For an assembly:`nodes=(instance1.nodes[6:7], instance2.nodes[1:5])

Returns:

An OdbSet object.

Notes

This function can be accessed by:

session.odbs[*name*].parts[*name*].NodeSet
session.odbs[*name*].rootAssembly.instances[*name*].NodeSet
session.odbs[*name*].rootAssembly.NodeSet

This method creates a OdbRigidBody object.

Parameters:

referenceNode: An OdbSet object specifying the reference node set associated with the rigid body.
position: A SymbolicConstant specifying the specific location of the OdbRigidBody reference node relative to the rest of the rigid body. Possible values are INPUT and CENTER_OF_MASS. The default value is INPUT.
isothermal: A Boolean specifying specify whether the OdbRigidBody can have temperature gradients or be isothermal. This is used only for fully coupled thermal-stress analysis The default value is ON.
elements: An OdbSet object specifying the element set whose motion is governed by the motion of rigid body reference node.
tieNodes: An OdbSet object specifying the node set which have both translational and rotational degrees of freedom associated with the rigid body.
pinNodes: An OdbSet object specifying the node set which have only translational degrees of freedom associated with the rigid body.
analyticSurface: An AnalyticSurface object specifying the analytic surface whose motion is governed by the motion of rigid body reference node.

Returns:

An OdbRigidBody object.

Notes

This function can be accessed by:

session.odbs[*name*].rootAssembly.instances[*name*].RigidBody
session.odbs[*name*].rootAssembly.RigidBody

OdbInstanceBase#

class OdbInstanceBase(name: str, object: OdbPart, localCoordSystem: tuple = ())[source]#

A part instance is the usage of a part within an assembly.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].rootAssembly.instances[name]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance

Attributes:

name: str: A String specifying the instance name.
type: SymbolicConstant: A SymbolicConstant specifying the type of the Part object. Only a value of DEFORMABLE_BODY is currently supported.
embeddedSpace: SymbolicConstant: A SymbolicConstant specifying the dimensionality of the Part object. Possible values are THREE_D, TWO_D_PLANAR, AXISYMMETRIC, and UNKNOWN_DIMENSION.
resultState: SymbolicConstant: A SymbolicConstant specifying the state of the Instance as modified by the analysis. This member is only present if the Instance is part of the RootAssemblyState tree. Possible values are:PROPAGATED, specifying that the value is the same as the previous frame or the original rootAssembly.MODIFIED, specifying that the geometry of the instance has been changed at this frame.The default value is PROPAGATED.
nodes: OdbMeshNodeArray: An OdbMeshNodeArray object.
elements: OdbMeshElementArray: An OdbMeshElementArray object.
nodeSets: dict[str, OdbSet]: A repository of OdbSet objects specifying node sets.
elementSets: dict[str, OdbSet]: A repository of OdbSet objects specifying element sets.
surfaces: dict[str, OdbSet]: A repository of OdbSet objects specifying surfaces.
sectionAssignments: SectionAssignmentArray: A SectionAssignmentArray object.
rigidBodies: OdbRigidBodyArray: An OdbRigidBodyArray object.
beamOrientations: BeamOrientationArray: A BeamOrientationArray object.
materialOrientations: MaterialOrientationArray: A MaterialOrientationArray object.
rebarOrientations: RebarOrientationArray: A RebarOrientationArray object.
analyticSurface: AnalyticSurface: An AnalyticSurface object specifying analytic Surface defined on the instance.

Methods

`AnalyticRigidSurf2DPlanar`(name, profile[, ...])	This method is used to define a two-dimensional AnalyticSurface object on the instance.
`AnalyticRigidSurfExtrude`(name, profile[, ...])	This method is used to define a three-dimensional cylindrical AnalyticSurface on the instance.
`AnalyticRigidSurfRevolve`(name, profile[, ...])	This method is used to define a three-dimensional AnalyticSurface of revolution on the instance.
`RigidBody`(referenceNode[, position, ...])	This method defines an OdbRigidBody on the instance.
`assignBeamOrientation`(region, method, vector)	This method assigns a beam section orientation to a region of a part instance.
`assignMaterialOrientation`(region, localCsys)	This method assigns a material orientation to a region of a part instance.
`assignRebarOrientation`(region, localCsys[, ...])	This method assigns a rebar reference orientation to a region of a part instance.
`assignSection`(region, section)	This method is used to assign a section to a region on an instance.
`getElementFromLabel`(label)	This method is used to retrieved an element with a specific label from an instance object.
`getNodeFromLabel`(label)	This method is used to retrieved a node with a specific label from an instance object.

AnalyticRigidSurf2DPlanar(name: str, profile: tuple[AnalyticSurfaceSegment], filletRadius: str = 0)[source]#

This method is used to define a two-dimensional AnalyticSurface object on the instance.

Parameters:

name: The name of the analytic surface.
profile: A sequence of AnalyticSurfaceSegment objects or an OdbSequenceAnalyticSurfaceSegment object.
filletRadius: A Double specifying the radius of curvature to smooth discontinuities between adjoining segments. The default value is 0.0.

Raises:

If OdbPart associated with the part instance is of type THREE_D:
OdbError: 2D-Planar Analytic Rigid Surface can be defined only if the instance is of

type TWO_D_PLANAR or AXISYMMETRIC.

AnalyticRigidSurfExtrude(name: str, profile: tuple[AnalyticSurfaceSegment], filletRadius: str = 0, localCoordData: tuple = ())[source]#

This method is used to define a three-dimensional cylindrical AnalyticSurface on the instance.

Parameters:

name: The name of the analytic surface.
profile: A sequence of AnalyticSurfaceSegment objects or an OdbSequenceAnalyticSurfaceSegment object.
filletRadius: A Double specifying the radius of curvature to smooth discontinuities between adjoining segments. The default value is 0.0.
localCoordData: A sequence of sequences of Floats specifying the global coordinates of points used to define the local coordinate system.

Raises:

If OdbPart associated with the part instance is not of type THREE_D:
OdbError: Analytic Rigid Surface of type CYLINDER can be defined only if the instance

is of type THREE_D.

AnalyticRigidSurfRevolve(name: str, profile: tuple[AnalyticSurfaceSegment], filletRadius: str = 0, localCoordData: tuple = ())[source]#

This method is used to define a three-dimensional AnalyticSurface of revolution on the instance.

Parameters:

name: The name of the analytic surface.
profile: A sequence of AnalyticSurfaceSegment objects or an OdbSequenceAnalyticSurfaceSegment object.
filletRadius: A Double specifying the radius of curvature to smooth discontinuities between adjoining segments. The default value is 0.0.
localCoordData: A sequence of sequences of Floats specifying the global coordinates of points used to define the local coordinate system.

Raises:

If OdbPart associated with the part instance is not of type THREE_D:
OdbError: Analytic Rigid Surface of type REVOLUTION can be defined only if the

instance is of type THREE_D.

RigidBody(referenceNode: str, position: str = 'INPUT', isothermal: BooleanType = 0, elset: str = '', pinNodes: str = '', tieNodes: str = '', analyticSurface: str = '')[source]#

This method defines an OdbRigidBody on the instance.

Parameters:

referenceNode: An OdbSet specifying the reference node assigned to the rigid body.
position: A symbolic constant specify if the location of the reference node is to be defined by the user. Possible values are INPUT, and CENTER_OF_MASS. The default value is INPUT.
isothermal: A Boolean specifying an isothermal rigid body. The default value is OFF. This parameter is used only for a fully-coupled thermal stress analysis.
elset: An OdbSet specifying an element set assigned to the rigid body.
pinNodes: An OdbSet specifying pin-type nodes assigned to the rigid body.
tieNodes: An OdbSet specifying tie-type nodes assigned to the rigid body.
analyticSurface: An AnalyticSurface specifying the Analytic Rigid Surface assigned to the rigid body.

Raises:

If referenceNode is not a node set:
OdbError: Rigid body definition requires a node set.

assignBeamOrientation(region: str, method: SymbolicConstantType, vector: tuple)[source]#

This method assigns a beam section orientation to a region of a part instance.

Parameters:

region: An OdbSet specifying a region on an instance.
method: A SymbolicConstant specifying the assignment method. Only a value of N1_COSINES is currently supported.
vector: A sequence of three Floats specifying the approximate local n1n1-direction of the beam cross-section.

assignMaterialOrientation(region: str, localCsys: OdbDatumCsys, axis: SymbolicConstantType = 'AXIS_1', angle: float = 0, stackDirection: SymbolicConstantType = 'STACK_3')[source]#

This method assigns a material orientation to a region of a part instance.

Parameters:

region: An OdbSet specifying a region on an instance.
localCsys: An OdbDatumCsys object specifying the local coordinate system or None, indicating the global coordinate system.
axis: A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system about which an additional rotation is applied. For shells this axis is also the shell normal. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle: A Float specifying the angle of the additional rotation. The default value is 0.0.
stackDirection: A SymbolicConstant specifying the stack or thickness direction of the material. Possible values are STACK_1, STACK_2, STACK_3, and STACK_ORIENTATION. The default value is STACK_3.

assignRebarOrientation(region: str, localCsys: OdbDatumCsys, axis: SymbolicConstantType = 'AXIS_1', angle: float = 0)[source]#

This method assigns a rebar reference orientation to a region of a part instance.

Parameters:

region: An OdbSet specifying a region on an instance.
localCsys: An OdbDatumCsys object specifying the local coordinate system or None, indicating the global coordinate system.
axis: A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system about which an additional rotation is applied. For shells this axis is also the shell normal. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle: A Float specifying the angle of the additional rotation. The default value is 0.0.

assignSection(region: str, section: Section)[source]#

This method is used to assign a section to a region on an instance.

Parameters:

region: An OdbSet specifying a region on an instance.
section: A Section object.

Raises:

If region is not an element set:
OdbError: Section assignment requires element set.
If the element set is not from the current instance:
OdbError: Section assignment requires element set from this part instance.

getElementFromLabel(label: int)[source]#

This method is used to retrieved an element with a specific label from an instance object.

Parameters:

label: An Int specifying the element label.

Returns:

An OdbMeshElement object.

Raises:

If no element with the specified label exists:
OdbError: Invalid element label

getNodeFromLabel(label: int)[source]#

This method is used to retrieved a node with a specific label from an instance object.

Parameters:

label: An Int specifying the node label.

Returns:

AnOdbMeshNode object.

Raises:

If no node with the specified label exists:
OdbError: Invalid node label

OdbLoadCase#

class OdbLoadCase(name: str)[source]#

The OdbLoadCase object describes a load case.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].steps[name].frames[i].loadCase
session.odbs[name].steps[name].historyRegions[name].loadCase
session.odbs[name].steps[name].loadCases[name]

OdbMeshElement#

class OdbMeshElement[source]#

OdbMeshElement objects are created with the part.addElements or rootAssembly.addElements methods.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].parts[name].elements[i]
session.odbs[name].parts[name].elementSets[name].elements[i]
session.odbs[name].parts[name].nodeSets[name].elements[i]
session.odbs[name].parts[name].surfaces[name].elements[i]
session.odbs[name].rootAssembly.elements[i]
session.odbs[name].rootAssembly.elementSets[name].elements[i]
session.odbs[name].rootAssembly.instances[name].elements[i]
session.odbs[name].rootAssembly.instances[name].elementSets[name].elements[i]
session.odbs[name].rootAssembly.instances[name].nodeSets[name].elements[i]
session.odbs[name].rootAssembly.instances[name].surfaces[name].elements[i]
session.odbs[name].rootAssembly.nodeSets[name].elements[i]
session.odbs[name].rootAssembly.surfaces[name].elements[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.elements[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.elementSets[name].elements[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.nodeSets[name].elements[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.surfaces[name].elements[i]

Attributes:

label: int: An Int specifying the element label.
type: str: A String specifying the element type.
sectionCategory: SectionCategory: A SectionCategory object specifying the element section properties.
connectivity: int: A tuple of Ints specifying the element connectivity. For connector elements connected to ground, the other node is repeated in the connectivity data. The position of the ground node cannot be ascertained. This is a limitation. It is important to note the difference with MeshElement object of MDB where the connectivity is node indices instead of node labels.
instanceNames: tuple: A tuple of Strings specifying the instance names for nodes in the element connectivity.
instanceName: str: A String specifying the instance name.

Methods

getNormal(faceIndex[, stepName, frameValue, ...])

This method returns the normal direction for the element face.

getNormal(faceIndex: str, stepName: str = '', frameValue: str = '', match: SymbolicConstantType = 'CLOSEST')[source]#

This method returns the normal direction for the element face.

Parameters:

faceIndex: The value of faceIndex is 0 for a shell element and can range from 0 to 5 for a solid element.
stepName: Name of the step.
frameValue: A Double specifying the value at which the frame is required. frameValue can be the total fime or frequency.
match: A SymbolicConstant specifying which frame to return if there is no frame at the exact frame value. Possible values are CLOSEST, BEFORE, AFTER, and EXACT. The default value is CLOSEST.When *match*=CLOSEST, Abaqus returns the closest frame. If the frame value requested is exactly halfway between two frames, Abaqus returns the frame after the value.When *match*=EXACT, Abaqus raises an exception if the exact frame value does not exist.

Returns:

A python:tuple of 3 floats representing the unit normal vector. If the element face is
collapsed such that a normal cannot be computed, a zero-length vector is returned.

Raises:

If the exact frame is not found:
OdbError: Frame not found.
If the step name is not found:
OdbError: Step is not present in the ODB.
If frameValue is not provided and stepName is empty:
frameValue*OdbError: *stepName should be specified with frameValue.

OdbMeshElementArray#

class OdbMeshElementArray(iterable=(), /)[source]#

Methods

findAt

OdbMeshNode#

class OdbMeshNode[source]#

OdbMeshNode objects are created with the part.addNodes method.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].parts[name].nodes[i]
session.odbs[name].parts[name].nodeSets[name].nodes[i]
session.odbs[name].parts[name].surfaces[name].nodes[i]
session.odbs[name].rootAssembly.instances[name].nodes[i]
session.odbs[name].rootAssembly.instances[name].nodeSets[name].nodes[i]
session.odbs[name].rootAssembly.instances[name].surfaces[name].nodes[i]
session.odbs[name].rootAssembly.nodes[i]
session.odbs[name].rootAssembly.nodeSets[name].nodes[i]
session.odbs[name].rootAssembly.surfaces[name].nodes[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.nodes[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.nodeSets[name].nodes[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.surfaces[name].nodes[i]

Attributes:

label: int: An Int specifying the node label.
coordinates: float: A tuple of Floats specifying the nodal coordinates in the global Cartesian coordinate system.

OdbMeshNodeArray#

class OdbMeshNodeArray(iterable=(), /)[source]#

Methods

findAt

OdbPart#

class OdbPart(name: str, embeddedSpace: SymbolicConstantType, type: SymbolicConstantType)[source]#

Methods

`NodeSet`(name, nodes)	This method creates a node set from an array of OdbMeshNode objects (for part instance-level sets) or from a sequence of arrays of OdbMeshNode objects (for assembly-level sets).
`RigidBody`(referenceNode[, position, ...])	This method defines an OdbRigidBody on the part object.

NodeSet(name: str, nodes: tuple[OdbMeshNode]) → OdbSet[source]#

This method creates a node set from an array of OdbMeshNode objects (for part instance-level sets) or from a sequence of arrays of OdbMeshNode objects (for assembly-level sets).

Parameters:

name: A String specifying the name of the set and the repository key.
nodes: A sequence of OdbMeshNode objects. For example, for a part:nodes=part1.nodes[1:5]`For an assembly:`nodes=(instance1.nodes[6:7], instance2.nodes[1:5])

Returns:

An OdbSet object.

Notes

This function can be accessed by:

session.odbs[*name*].parts[*name*].NodeSet
session.odbs[*name*].rootAssembly.instances[*name*].NodeSet
session.odbs[*name*].rootAssembly.NodeSet

RigidBody(referenceNode: str, position: str = 'INPUT', isothermal: BooleanType = 0, elset: str = '', pinNodes: str = '', tieNodes: str = '', analyticSurface: str = '')[source]#

This method defines an OdbRigidBody on the part object.

Parameters:

referenceNode: An OdbSet specifying the reference node assigned to the rigid body.
position: A symbolic constant specify if the location of the reference node is to be defined by the user. Possible values are INPUT and CENTER_OF_MASS. The default value is INPUT.
isothermal: A Boolean specifying an isothermal rigid body. The default value is OFF. This parameter is used only for a fully-coupled thermal stress analysis.
elset: An OdbSet specifying an element set assigned to the rigid body.
pinNodes: An OdbSet specifying pin-type nodes assigned to the rigid body.
tieNodes: An OdbSet specifying tie-type nodes assigned to the rigid body.
analyticSurface: An AnalyticSurface specifying the Analytic Rigid Surface assigned to the rigid body.

Returns:

None.

Raises:

If referenceNode is not a node set:
OdbError: Rigid body definition requires a node set.

OdbPartBase#

class OdbPartBase(name: str, embeddedSpace: SymbolicConstantType, type: SymbolicConstantType)[source]#

The OdbPart object is similar to the kernel Part object and contains nodes and elements, but not geometry.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].parts[name]

Attributes:

nodes: OdbMeshNodeArray: An OdbMeshNodeArray object.
elements: OdbMeshElementArray: An OdbMeshElementArray object.
nodeSets: dict[str, OdbSet]: A repository of OdbSet objects specifying node sets.
elementSets: dict[str, OdbSet]: A repository of OdbSet objects specifying element sets.
surfaces: dict[str, OdbSet]: A repository of OdbSet objects specifying surfaces.
sectionAssignments: SectionAssignmentArray: A SectionAssignmentArray object.
beamOrientations: BeamOrientationArray: A BeamOrientationArray object.
materialOrientations: MaterialOrientationArray: A MaterialOrientationArray object.
rebarOrientations: RebarOrientationArray: A RebarOrientationArray object.
rigidBodies: OdbRigidBodyArray: An OdbRigidBodyArray object.
analyticSurface: AnalyticSurface: An AnalyticSurface object specifying analytic Surface defined on the instance.

Methods

`AnalyticRigidSurf2DPlanar`(name, profile[, ...])	This method is used to define a two-dimensional AnalyticSurface object on the part object.
`AnalyticRigidSurfExtrude`(name, profile[, ...])	This method is used to define a three-dimensional cylindrical AnalyticSurface on the part object.
`AnalyticRigidSurfRevolve`(name, profile[, ...])	This method is used to define a three-dimensional AnalyticSurface of revolution on the part object.
`assignBeamOrientation`(region, method, vector)	This method assigns a beam section orientation to a region of a part instance.
`assignMaterialOrientation`(region, localCSys)	This method assigns a material orientation to a region of a part instance.
`assignRebarOrientation`(region, localCsys[, ...])	This method assigns a rebar reference orientation to a region of a part instance.
`getElementFromLabel`(label)	This method is used to retrieved an element with a specific label from a part object.
`getNodeFromLabel`(label)	This method is used to retrieved a node with a specific label from a part object.

addElements
addNodes

AnalyticRigidSurf2DPlanar(name: str, profile: tuple[AnalyticSurfaceSegment], filletRadius: str = 0)[source]#

This method is used to define a two-dimensional AnalyticSurface object on the part object.

Parameters:

name: The name of the analytic surface.
profile: A sequence of AnalyticSurfaceSegment objects or an OdbSequenceAnalyticSurfaceSegment object.
filletRadius: A Double specifying the radius of curvature to smooth discontinuities between adjoining segments. The default value is 0.0.

Raises:

If OdbPart is of type THREE_D:
OdbError: 2D-Planar Analytic Rigid Surface can be defined only if the part is of type

TWO_D_PLANAR or AXISYMMETRIC.

AnalyticRigidSurfExtrude(name: str, profile: tuple[AnalyticSurfaceSegment], filletRadius: str = 0)[source]#

This method is used to define a three-dimensional cylindrical AnalyticSurface on the part object.

Parameters:

name: The name of the analytic surface.
profile: A sequence of AnalyticSurfaceSegment objects or an OdbSequenceAnalyticSurfaceSegment object.
filletRadius: A Double specifying the radius of curvature to smooth discontinuities between adjoining segments. The default value is 0.0.

Raises:

If OdbPart is not of type THREE_D:
OdbError: Analytic Rigid Surface of type CYLINDER can be defined only if the part is

of type THREE_D.

AnalyticRigidSurfRevolve(name: str, profile: tuple[AnalyticSurfaceSegment], filletRadius: str = 0)[source]#

This method is used to define a three-dimensional AnalyticSurface of revolution on the part object.

Parameters:

name: The name of the analytic surface.
profile: A sequence of AnalyticSurfaceSegment objects or an OdbSequenceAnalyticSurfaceSegment object.
filletRadius: A Double specifying the radius of curvature to smooth discontinuities between adjoining segments. The default value is 0.0.

Raises:

If OdbPart is not of type THREE_D:
OdbError: Analytic Rigid Surface of type REVOLUTION can be defined only if the part is

of type THREE_D.

assignBeamOrientation(region: str, method: SymbolicConstantType, vector: tuple)[source]#

This method assigns a beam section orientation to a region of a part instance.

Parameters:

region: An OdbSet specifying a region on an instance.
method: A SymbolicConstant specifying the assignment method. Only a value of N1_COSINES is currently supported.
vector: A sequence of three Floats specifying the approximate local n1n1 -direction of the beam cross-section.

assignMaterialOrientation(region: str, localCSys: OdbDatumCsys, axis: SymbolicConstantType = 'AXIS_1', angle: float = 0, stackDirection: SymbolicConstantType = 'STACK_3')[source]#

This method assigns a material orientation to a region of a part instance.

Parameters:

region: An OdbSet specifying a region on an instance.
localCSys: An OdbDatumCsys object specifying the local coordinate system or None, indicating the global coordinate system.
axis: A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system about which an additional rotation is applied. For shells this axis is also the shell normal. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle: A Float specifying the angle of the additional rotation. The default value is 0.0.
stackDirection: A SymbolicConstant specifying the stack or thickness direction of the material. Possible values are STACK_1, STACK_2, STACK_3, and STACK_ORIENTATION. The default value is STACK_3.

assignRebarOrientation(region: str, localCsys: OdbDatumCsys, axis: SymbolicConstantType = 'AXIS_1', angle: float = 0)[source]#

This method assigns a rebar reference orientation to a region of a part instance.

Parameters:

region: An OdbSet specifying a region on an instance.
localCsys: An OdbDatumCsys object specifying the local coordinate system or None, indicating the global coordinate system.
axis: A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system about which an additional rotation is applied. For shells this axis is also the shell normal. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.
angle: A Float specifying the angle of the additional rotation. The default value is 0.0.

getElementFromLabel(label: int)[source]#

This method is used to retrieved an element with a specific label from a part object.

Parameters:

label: An Int specifying the element label.

Returns:

An OdbMeshElement object.

Raises:

If no element with the specified label exists:
OdbError: Invalid element label

getNodeFromLabel(label: int)[source]#

This method is used to retrieved a node with a specific label from a part object.

Parameters:

label: An Int specifying the node label.

Returns:

An OdbMeshNode object.

Raises:

If no node with the specified label exists:
OdbError: Invalid node label

OdbPretensionSection#

class OdbPretensionSection[source]#

The pretension section object is used to define an assembly load. It associates a pretension node with a pretension section.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].rootAssembly.pretensionSections[i]

Attributes:

node: OdbSet: An OdbSet object specifying the node set containing the pretension node.
element: OdbSet: An OdbSet object specifying the element set that defines the pretension section.
surface: OdbSet: An OdbSet object specifying the surface set that defines the pretension section.
normal: float: A tuple of Floats specifying the components of the normal to the pretension section.

OdbPretensionSectionArray#

class OdbPretensionSectionArray(iterable=(), /)[source]#

Methods

findAt

OdbRigidBody#

class OdbRigidBody(referenceNode: ~abaqus.Odb.OdbSet.OdbSet, position: ~abaqusConstants.SymbolicConstantType = 'INPUT', isothermal: ~abaqusConstants.BooleanType = 1, elements: ~abaqus.Odb.OdbSet.OdbSet = <abaqus.Odb.OdbSet.OdbSet object>, tieNodes: ~abaqus.Odb.OdbSet.OdbSet = <abaqus.Odb.OdbSet.OdbSet object>, pinNodes: ~abaqus.Odb.OdbSet.OdbSet = <abaqus.Odb.OdbSet.OdbSet object>, analyticSurface: ~abaqus.Odb.AnalyticSurface.AnalyticSurface = <abaqus.Odb.AnalyticSurface.AnalyticSurface object>)[source]#

The Rigid body object is used to bind a set of elements and/or a set of nodes and/or an analytical surface with a reference node.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].parts[name].rigidBodies[i]
session.odbs[name].rootAssembly.instances[name].rigidBodies[i]
session.odbs[name].rootAssembly.rigidBodies[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.rigidBodies[i]

OdbRigidBodyArray#

class OdbRigidBodyArray(iterable=(), /)[source]#

Methods

findAt

OdbSequenceAnalyticSurfaceSegment#

class OdbSequenceAnalyticSurfaceSegment[source]#

A sequence of AnalyticSurfaceSegment describing an analytic surface profile.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].parts[name].analyticSurface.segments
session.odbs[name].rootAssembly.instances[name].analyticSurface.segments
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.analyticSurface.segments

Methods

`Circle`(center, endPoint)	This method adds a AnalyticSurfaceSegment describing a circular segment of the surface profile.
`Line`(endPoint)	This method adds a AnalyticSurfaceSegment describing the line segment of the surface profile.
`Parabola`(middlePoint, endPoint)	This method adds a AnalyticSurfaceSegment describing a parabolic segment of the surface profile.
`Start`(origin)	This method adds a AnalyticSurfaceSegment describing the first segment of the surface profile.

Circle(center: tuple, endPoint: tuple)[source]#

This method adds a AnalyticSurfaceSegment describing a circular segment of the surface profile.

Parameters:

center: A sequence of Floats specifying the coordinates of center of the circular segment.
endPoint: A sequence of Floats specifying the coordinates of end point of the circular segment.

Line(endPoint: tuple)[source]#

This method adds a AnalyticSurfaceSegment describing the line segment of the surface profile.

Parameters:

endPoint: A sequence of Floats specifying the coordinates of end point.

Parabola(middlePoint: tuple, endPoint: tuple)[source]#

This method adds a AnalyticSurfaceSegment describing a parabolic segment of the surface profile.

Parameters:

middlePoint: A sequence of Floats specifying the coordinates of middle point of the parabolic segment.
endPoint: A sequence of Floats specifying the coordinates of end point of the parabolic segment.

Start(origin: tuple)[source]#

This method adds a AnalyticSurfaceSegment describing the first segment of the surface profile.

Parameters:

origin: A sequence of Floats specifying the coordinates of start point.

OdbSession#

class OdbSession[source]#

Methods

ScratchOdb(odb)

This method creates a new ScratchOdb object.

ScratchOdb(odb: Odb) → ScratchOdb[source]#

This method creates a new ScratchOdb object.

Parameters:

odb: An Odb object specifying the output database with which to associate.

Returns:

A ScratchOdb object.

Notes

This function can be accessed by:

session.ScratchOdb

OdbSet#

class OdbSet(name: str, nodes: tuple[OdbMeshNode])[source]#

The set objects are used to identify regions of a model.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].parts[name].elementSets[name]
session.odbs[name].parts[name].nodeSets[name]
session.odbs[name].parts[name].surfaces[name]
session.odbs[name].rootAssembly.elementSets[name]
session.odbs[name].rootAssembly.instances[name].elementSets[name]
session.odbs[name].rootAssembly.instances[name].nodeSets[name]
session.odbs[name].rootAssembly.instances[name].surfaces[name]
session.odbs[name].rootAssembly.nodeSets[name]
session.odbs[name].rootAssembly.surfaces[name]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.elementSets[name]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.nodeSets[name]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.surfaces[name]

Attributes:

name: str: A String specifying the name of the set and the repository key.
instanceNames: tuple: A tuple of Strings specifying the namespaces for the nodes, elements, and faces; None if the set is on a Part or an OdbInstance object.
nodes: OdbMeshNodeArray: An OdbMeshNodeArray object specifying the nodes of an OdbSet. If a set spans more than one part instance, this member is a sequence of sequences for each part instance.
elements: OdbMeshElementArray: An OdbMeshElementArray object specifying the elements of an OdbSet. If a set spans more than one part instance, this member is a sequence of sequences for each part instance.
faces: SymbolicConstant: A tuple of SymbolicConstants specifying the element face. If a set spans more than one part instance, this member is a sequence of sequences for each part instance.
instances: str: A repository of an OdbInstance object.
isInternal: Boolean: A Boolean specifying whether the set is internal.

Methods

`ElementSet`(name, elements)	This method creates an element set from an array of OdbMeshElement objects (for part instance-level sets) or from a sequence of arrays of OdbMeshElement objects (for assembly-level sets).
`ElementSetFromElementLabels`(name, elementLabels)	This method creates an element set from a sequence of element labels.
`MeshSurface`(name, meshSurfaces)	This method creates a surface from the element and side identifiers for the assembly.
`MeshSurfaceFromElsets`(name, elementSetSeq)	This method creates a mesh surface from a sequence of element sets.
`MeshSurfaceFromLabels`(name, surfaceLabels)	This method creates a mesh surface from a sequence of surface labels.
`NodeSetFromNodeLabels`(name, nodeLabels)	This method creates a node set from a sequence of node labels.

ElementSet(name: str, elements: tuple[OdbMeshElement])[source]#

This method creates an element set from an array of OdbMeshElement objects (for part instance-level sets) or from a sequence of arrays of OdbMeshElement objects (for assembly-level sets).

Parameters:

name: A String specifying the name of the set and the repository key.
elements: A sequence of OdbMeshElement objects. For example, for a part:elements=instance1.elements[1:5]`For an assembly:`elements=(instance1.elements[1:5], instance2.elements[1:5])

Returns:

An OdbSet object.

Notes

This function can be accessed by:

session.odbs[*name*].parts[*name*].NodeSet
session.odbs[*name*].rootAssembly.instances[*name*].NodeSet
session.odbs[*name*].rootAssembly.NodeSet

ElementSetFromElementLabels(name: str, elementLabels: tuple)[source]#

This method creates an element set from a sequence of element labels.

Parameters:

name: A String specifying the name of the set and the repository key.
elementLabels: A sequence of element labels. An element label is a sequence of Int element identifiers. For example, for a part:elementLabels=(2,3,5,7)`For an assembly:`elementLabels=((‘Instance-1’, (2,3,5,7)), (‘Instance-2’, (1,2,3)))

Returns:

An OdbSet object.

Notes

This function can be accessed by:

session.odbs[*name*].parts[*name*].NodeSet
session.odbs[*name*].rootAssembly.instances[*name*].NodeSet
session.odbs[*name*].rootAssembly.NodeSet

MeshSurface(name: str, meshSurfaces: tuple)[source]#

This method creates a surface from the element and side identifiers for the assembly.

Parameters:

name: A String specifying the name of the set and the repository key.
meshSurfaces: A sequence of sequences. Each sequence consists of an element sequence and a side identifier. The possible side identifiers depend on the type of element, as described in the following table: | Sequence of elements | Side identifiers | | ——————————– | —————————————- | | Solid elements | FACE1, FACE2, FACE3, FACE4, FACE5, FACE6 | | Three-dimensional shell elements | SIDE1, SIDE2 | | Two-dimensional elements | FACE1, FACE2, FACE3, FACE4 | | Wire elements | END, END2 | For example: ` side1Elements=instance1.elements[217:218] side2Elements=instance2.elements[100:105] assembly.MeshSurface(name='Surf-1' meshSurfaces=((side1Elems,SIDE1) (side2Elems,SIDE2))) `

Returns:

An OdbSet object.

Notes

This function can be accessed by:

session.odbs[*name*].parts[*name*].NodeSet
session.odbs[*name*].rootAssembly.instances[*name*].NodeSet
session.odbs[*name*].rootAssembly.NodeSet

MeshSurfaceFromElsets(name: str, elementSetSeq: tuple)[source]#

This method creates a mesh surface from a sequence of element sets.

Parameters:

name: A String specifying the name of the set and the repository key.
elementSetSeq: A sequence of element sets. For example,`elementSetSeq=((elset1,SIDE1),(elset2,SIDE2))`where elset1=session.odbs[name].rootAssembly.elementSets[‘Clutch’] `and `SIDE1 and SIDE2 indicate the side of the element set.

Returns:

An OdbSet object.

Notes

This function can be accessed by:

session.odbs[*name*].parts[*name*].NodeSet
session.odbs[*name*].rootAssembly.instances[*name*].NodeSet
session.odbs[*name*].rootAssembly.NodeSet

MeshSurfaceFromLabels(name: str, surfaceLabels: tuple)[source]#

This method creates a mesh surface from a sequence of surface labels.

Parameters:

name: A String specifying the name of the set and the repository key.
surfaceLabels: A sequence of surface labels. For example,`surfaceLabels=((‘Instance-1’, ((10, FACE1), (11, FACE2))), (‘Instance-2’, ((10, FACE3), (12, FACE4))))`where 10 is an element number and FACE1 indicates the side of the element.

Returns:

An OdbSet object.

Notes

This function can be accessed by:

session.odbs[*name*].parts[*name*].NodeSet
session.odbs[*name*].rootAssembly.instances[*name*].NodeSet
session.odbs[*name*].rootAssembly.NodeSet

NodeSetFromNodeLabels(name: str, nodeLabels: tuple)[source]#

This method creates a node set from a sequence of node labels.

Parameters:

name: A String specifying the name of the set and the repository key.
nodeLabels: A sequence of node labels. A node label is a sequence of Int node identifiers. For example, for a part:nodeLabels=(2,3,5,7)`For an assembly:`nodeLabels=((‘Instance-1’, (2,3,5,7)), (‘Instance-2’, (1,2,3)))

Returns:

An OdbSet object.

Notes

This function can be accessed by:

session.odbs[*name*].parts[*name*].NodeSet
session.odbs[*name*].rootAssembly.instances[*name*].NodeSet
session.odbs[*name*].rootAssembly.NodeSet

OdbStep#

class OdbStep(name: str, description: str, domain: SymbolicConstantType, timePeriod: float = 0, previousStepName: str = '', procedure: str = '', totalTime: float | None = None)[source]#

Methods

`HistoryRegion`(name, description, point[, ...])	This method creates a HistoryRegion object.
`OdbLoadCase`(name)	This method creates an OdbLoadCase object.

Frame

HistoryRegion(name: str, description: str, point: HistoryPoint, loadCase: str | None = None) → HistoryRegion[source]#

This method creates a HistoryRegion object.

Parameters:

name: A String specifying the name of the HistoryRegion object.
description: A String specifying the description of the HistoryRegion object.
point: A HistoryPoint object specifying the point to which the history data refer.
loadCase: None or an OdbLoadCase object specifying the load case associated with the HistoryRegion object. The default value is None.

Returns:

A HistoryRegion object.

Notes

This function can be accessed by:

session.odbs[name].steps[name].HistoryRegion

OdbLoadCase(name: str) → OdbLoadCase[source]#

This method creates an OdbLoadCase object.

Parameters:

name: A String specifying the name of the OdbLoadCase object.

Returns:

An OdbLoadCase object.

Notes

This function can be accessed by:

session.odbs[*name*].steps[*name*].LoadCase

OdbStepBase#

class OdbStepBase(name: str, description: str, domain: SymbolicConstantType, timePeriod: float = 0, previousStepName: str = '', procedure: str = '', totalTime: float | None = None)[source]#

An output database contains the same steps of the model database that originated it.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].steps[name]

Attributes:

number: int: An Int specifying the step number.
nlgeom: Boolean: A Boolean specifying whether geometric nonlinearity can occur in this step.
mass: float: A Float specifying the current value of the mass of the model. This does not include the mass of the acoustic media if any present.
acousticMass: float: A Float specifying the current value of the mass of the acoustic media of the model.
frames: OdbFrameArray: An OdbFrameArray object.
historyRegions: dict[str, HistoryRegion]: A repository of HistoryRegion objects.
loadCases: dict[str, OdbLoadCase]: A repository of OdbLoadCase objects.
massCenter: float: A tuple of Floats specifying the coordinates of the center of mass.
inertiaAboutCenter: float: A tuple of Floats specifying the moments and products of inertia about the center of mass. For 3-D models inertia quantities are written in the following order: I(XX), I(YY), I(ZZ), I(XY), I(XZ), and I(YZ). For 2-D models only I(ZZ) and I(XY) are outputted.
inertiaAboutOrigin: float: A tuple of Floats specifying the moments and products of inertia about the origin of the global coordinate system. For 3-D models inertia quantities are written in the following order: I(XX), I(YY), I(ZZ), I(XY), I(XZ), and I(YZ). For 2-D models only I(ZZ) and I(XY) are outputted.
acousticMassCenter: float: A tuple of Floats specifying the coordinates of the center of mass of the acoustic media.

Methods

`getHistoryRegion`(point[, loadCase])	This method retrieves a HistoryRegion object associated with a HistoryPoint in the model.
`setDefaultDeformedField`(field)	This method sets the default deformed field variable in a step.
`setDefaultField`(field)	This method sets the default field variable in a step.

getFrame

getHistoryRegion(point: ~abaqus.Odb.HistoryPoint.HistoryPoint, loadCase: ~abaqus.Odb.OdbLoadCase.OdbLoadCase = <abaqus.Odb.OdbLoadCase.OdbLoadCase object>)[source]#

This method retrieves a HistoryRegion object associated with a HistoryPoint in the model.

Parameters:

point: A HistoryPoint object specifying the point in the model.
loadCase: An OdbLoadCase object specifying a load case in the step.

Returns:

A HistoryRegion object.

Raises:

If a HistoryRegion object is not found:
OdbError: HistoryRegion not found.

setDefaultDeformedField(field: FieldOutput)[source]#

This method sets the default deformed field variable in a step.

Parameters:

field: A FieldOutput object specifying the default deformed field variable for visualization.

setDefaultField(field: FieldOutput)[source]#

This method sets the default field variable in a step.

Parameters:

field: A FieldOutput object specifying the default field variable for visualization.

RebarOrientation#

class RebarOrientation[source]#

The RebarOrientation object represents the orientation of the rebar reference.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].parts[name].rebarOrientations[i]
session.odbs[name].rootAssembly.instances[name].rebarOrientations[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.rebarOrientations[i]

Attributes:

axis: SymbolicConstant: A SymbolicConstant specifying the axis of a cylindrical or spherical datum coordinate system about which an additional rotation is applied. Possible values are AXIS_1, AXIS_2, and AXIS_3.
angle: float: A Float specifying the angle of the additional rotation.
region: OdbSet: An OdbSet object specifying a region for which the rebar orientation is defined.
csys: OdbDatumCsys: An OdbDatumCsys object specifying a datum coordinates system.

RebarOrientationArray#

class RebarOrientationArray(iterable=(), /)[source]#

Methods

findAt

ScratchOdb#

class ScratchOdb(odb: Odb)[source]#

A scratch output database is associated with an open output database and is used to store session-related, non-persistent objects, such as Step, Frame and FieldOutput objects. Abaqus creates a scratch output database when needed for these non-persistent objects during an Abaqus/CAE session. Abaqus deletes the scratch output database when the associated output database is closed.

Notes

This object can be accessed by:

import odbAccess
session.scratchOdbs[name]

SectionCategory#

class SectionCategory(name: str, description: str)[source]#

The SectionCategory object is used to group regions of the model with like sections. Section definitions that contain the same number of section points or integration points are grouped together. To access data for a particular section definition, use the individual Section objects in the output database. For more information, see Beam Section profile commands and Section commands.

Notes

This object can be accessed by:

import
odbAccess
session.odbs[name].parts[name].elements[i].sectionCategory
session.odbs[name].parts[name].elementSets[name].elements[i].sectionCategory
session.odbs[name].parts[name].nodeSets[name].elements[i].sectionCategory
session.odbs[name].parts[name].surfaces[name].elements[i].sectionCategory
session.odbs[name].rootAssembly.elements[i].sectionCategory
session.odbs[name].rootAssembly.elementSets[name].elements[i].sectionCategory
session.odbs[name].rootAssembly.instances[name].elements[i].sectionCategory
session.odbs[name].rootAssembly.instances[name].elementSets[name].elements[i].sectionCategory
session.odbs[name].rootAssembly.instances[name].nodeSets[name].elements[i].sectionCategory
session.odbs[name].rootAssembly.instances[name].surfaces[name].elements[i].sectionCategory
session.odbs[name].rootAssembly.nodeSets[name].elements[i].sectionCategory
session.odbs[name].rootAssembly.surfaces[name].elements[i].sectionCategory
session.odbs[name].sectionCategories[name]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.elements[i].sectionCategory
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.elementSets[name].elements[i].sectionCategory
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.nodeSets[name].elements[i].sectionCategory
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.surfaces[name].elements[i].sectionCategory

Attributes:

sectionPoints: SectionPointArray: A SectionPointArray object.

Methods

SectionPoint(number, description)

This method creates a SectionPoint object.

SectionPoint(number: int, description: str) → SectionPoint[source]#

This method creates a SectionPoint object.

Parameters:

number: An Int specifying the number of the section point. See Beam elements and Shell elements for the numbering convention.
description: A String specifying the description of the section point.

Returns:

A SectionPoint object.

Notes

This function can be accessed by:

session.odbs[*name*].SectionCategory

SectionPoint#

class SectionPoint(number: int, description: str)[source]#

The SectionPoint object describes the location of a section point within a section category.

Notes

This object can be accessed by:

import
odbAccess
session.odbs[name].parts[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].parts[name].elementSets[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].parts[name].nodeSets[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].parts[name].surfaces[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.elementSets[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.instances[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.instances[name].elementSets[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.instances[name].nodeSets[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.instances[name].surfaces[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.nodeSets[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].rootAssembly.surfaces[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].sectionCategories[name].sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].locations[i].sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.elementSets[name].elements[i].sectionCategory        .sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.nodeSets[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].instance.surfaces[name].elements[i].sectionCategory.sectionPoints[i]
session.odbs[name].steps[name].frames[i].fieldOutputs[name].values[i].sectionPoint

SectionPointArray#

class SectionPointArray(iterable=(), /)[source]#

Methods

findAt

SectorDefinition#

class SectorDefinition[source]#

The SectorDefinition object describes the number of symmetry sectors and axis of symmetry for a cyclic symmetry model.

Notes

This object can be accessed by:

import odbAccess
session.odbs[name].sectorDefinition

Attributes:

numSectors: int: An Int specifying the number of sectors in the cyclic symmetry model.
symmetryAxis: float: A tuple of tuples of Floats specifying the coordinates of two points on the axis of symmetry.

UserData#

class UserData[source]#

Arrow(name: str, startPoint: tuple[float] = (), endPoint: tuple[float] = (), startAnchor: SymbolicConstantType | float = 'BOTTOM_LEFT', endAnchor: SymbolicConstantType | float = 'BOTTOM_LEFT', startHeadStyle: SymbolicConstantType = 'NONE', endHeadStyle: SymbolicConstantType = 'FILLED_ARROW', startGap: float = 0, endGap: float = 0, color: str = '', lineStyle: SymbolicConstantType = 'SOLID', lineThickness: SymbolicConstantType = 'VERY_THIN') → Arrow[source]#

This method creates an Arrow object.

Parameters:

name

A String specifying the annotation repository key.

startPoint

A pair of Floats specifying the start point X- and Y-offsets in millimeters from startAnchor. The default value is (0, 0).

endPoint

A pair of Floats specifying the end point X- and Y-offsets in millimeters from endAnchor. The default value is (0, 0).

startAnchor

A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y-coordinates as percentages of the viewport width and height. A sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant indicates a relative position. 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.

endAnchor

A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y-coordinates as percentages of the viewport width and height. A Sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant indicates a relative position. 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.

startHeadStyle

A SymbolicConstant specifying the style of the start head. Possible values are:: ARROW FILLED_ARROW HOLLOW_CIRCLE FILLED_CIRCLE HOLLOW_DIAMOND FILLED_DIAMOND HOLLOW_SQUARE FILLED_SQUARE NONE

The default value is NONE.

endHeadStyle

A SymbolicConstant specifying the style of the end head. Possible values are: ARROW

FILLED_ARROW HOLLOW_CIRCLE FILLED_CIRCLE HOLLOW_DIAMOND FILLED_DIAMOND HOLLOW_SQUARE FILLED_SQUARE NONE

The default value is FILLED_ARROW.

startGap

A Float specifying the distance in millimeters between the arrow start point and the arrow start head. The default value is 0.0.

endGap

A Float specifying the distance in millimeters between the arrow end point and the arrow end head. The default value is 0.0.

color

A String specifying the color of the arrow. Possible string values are any valid color. The default value is “White”.

lineStyle

A SymbolicConstant specifying the line style of the arrow. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

lineThickness

A SymbolicConstant specifying the line thickness of the arrow. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

Returns:

An Arrow object.

Notes

This function can be accessed by:

mdb.Arrow
session.odbs[*name*].userData.Arrow

Text(name: str, text: str = '', offset: tuple[float] = (), anchor: SymbolicConstantType | float = 'BOTTOM_LEFT', referencePoint: SymbolicConstantType | float = 'BOTTOM_LEFT', rotationAngle: float = 0, color: str = '', font: str = '', backgroundStyle: SymbolicConstantType = 'TRANSPARENT', backgroundColor: str = '', box: BooleanType = 0, justification: SymbolicConstantType = 'JUSTIFY_LEFT') → Text[source]#

This method creates a Text object.

Parameters:

name

A String specifying the annotation repository key.

text

A String specifying the text of the Text object. The default value is an empty string.

offset

A pair of Floats specifying the X- and Y-offsets in millimeters of the Text object from anchor. The default value is (0, 0).

anchor

A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y coordinates as percentages of the viewport width and height. A Sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant specifies a relative position. 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.

referencePoint

A SymbolicConstant or a sequence of Floats specifying a point. The sequence of two Floats specifies the X- and Y-coordinates of the reference point of the Text annotation given as percentages of its width and height. The SymbolicConstant indicates a relative position. 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.

rotationAngle

A Float specifying the amount of rotation in degrees about referencePoint. The default value is 0.0.

color

A String specifying the color of the Text object. Possible string values are any valid color. The default value is “White”.

font

A String specifying the font of the Text object. Possible string values are any valid font specification. The default value is “--verdana-medium-r-normal–120-“.

backgroundStyle

A SymbolicConstant specifying the Text object background style. Possible values are MATCH, TRANSPARENT, and OTHER. The default value is TRANSPARENT.

backgroundColor

A String specifying the color of the Text object background. Possible string values are any valid color. The default value matches the viewport background.

box

A Boolean specifying whether the box around the text is shown. The default value is OFF.

justification

A SymbolicConstant specifying the Text object justification for multiline text. Possible values are JUSTIFY_LEFT, JUSTIFY_CENTER, and JUSTIFY_RIGHT. The default value is JUSTIFY_LEFT.

Returns:

A Text object.
!img

Notes

This function can be accessed by:

mdb.Text
session.odbs[*name*].userData.Text

XYData(name: str, data: tuple, 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>)[source]#

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

Parameters:

name: A String specifying the repository key.
data: A sequence of pairs of Floats specifying the X–Y data pairs.
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.

Returns:

An XYData object.

Notes

This function can be accessed by:

session.odbs[name].userData.XYData