Oasys.D3PLOT.Component class

Constants

ALE Data Components

Component.ADENS

ALE denisty

Component.ADOMF

ALE dominant fraction

Component.AMMG

ALE multi-material group id

Component.AMMS

ALE multi-material group mass

Basic and Integrated Beam Force/Moment Data Components

Component.BFMV

Force and moment vector [BFX, BFY, BFZ, BMXX, BMYY, BMZZ]

Component.BFR

Force magnitude

Component.BFX

X axial force

Component.BFY

Y axial force

Component.BFZ

Z axial force

Component.BMX

Extra beam data

Component.BMXX

XX torsional moment

Component.BMYY

YY bending moment

Component.BMZZ

ZZ bending moment

Component.BRM

Moment magnitude

Basic and Integrated Beam Strain Data Components

Component.BEAX

Axial strain

Component.BEP

Effective plastic strain

Basic and Integrated Beam Stress Data Components

Component.BSXX

Axial stress

Component.BSXY

XY shear stress

Component.BSZX

ZX shear stress

Belytschko-Schwer Resultant Beam Energy Data Components

Component.BAED

Axial energy density

Component.BAEN

Axial energy

Component.BBED

Bending energy density

Component.BIE

Internal energy

Component.BIED

Internal energy density

Belytschko-Schwer Resultant Beam Moment Data Components

Component.BMY1

Y moment at end 1

Component.BMY2

Y moment at end 2

Component.BMZ1

Z moment at end 1

Component.BMZ2

Z moment at end 2

Belytschko-Schwer Resultant Beam Rotation Data Components

Component.BRXX

Torsional rotation

Component.BRY1

Y rotation at end 1

Component.BRY2

Y rotation at end 2

Component.BRZ1

Z rotation at end 1

Component.BRZ2

Z rotation at end 2

Belytschko-Schwer Resultant Beam Strain Data Components

Component.BPE1

Plastic energy at end 1

Component.BPE2

Plastic energy at end 2

Component.BSAX

Total axial strain

Contact Surface Data Components (if a .ctf file has been read)

Component.CAREA

Contact segment area

Component.CFGX

Contact global X force

Component.CFGY

Contact global Y force

Component.CFGZ

Contact global Z force

Component.CFLX

Contact local X force

Component.CFLY

Contact local Y force

Component.CFLZ

Contact local Z force

Component.CFM

Contact force magnitude

Component.CSN

Contact normal stress

Component.CST

Contact tangential stress

Component.CSX

Contact local X stress

Component.CSY

Contact local Y stress

Element Plastic Strain Data Components

Component.EPL

Effective plastic strain

Component.ERATE

Strain rate

Component.PEMAG

Plastic strain magnitude

Element Plastic Strain Derived Data Components

Component.PEAV

Average plastic strain

Component.PEMAX

Max principal plastic strain

Component.PEMID

Middle principal plastic strain

Component.PEMIN

Min principal plastic strain

Component.PEMS

Max plastic shear strain

Element Plastic Strain Tensor Data Components

Component.PETEN

Plastic strain tensor [EXX, EYY, EZZ, EXY, EYZ, EZX]

Component.PEXX

X Plastic strain

Component.PEXY

XY Plastic shear strain

Component.PEYY

Y Plastic strain

Component.PEYZ

XY Plastic shear strain

Component.PEZX

ZX Plastic shear strain

Component.PEZZ

Z Plastic strain

Element Strain Derived Data Components

Component.E2MAX

2D (in-plane) max principal strain

Component.E2MIN

2D (in-plane) min principal strain

Component.E2SHEAR

2D (in-plane) max shear strain

Component.EAV

Average strain

Component.EMAX

Max prinicipal strain

Component.EMID

Middle prinicipal strain

Component.EMIN

Min prinicipal strain

Component.EMS

Max shear strain

Component.ENGMAJ

Engineering Major strain

Component.ENGMIN

Engineering Minor strain

Component.ENGTHK

Engineering Thickness strain

Component.ERATIO

2D (in-plane) principal strain ratio

Component.EVON

von Mises strain

Component.SED

Strain energy density

Element Strain Tensor Data Components

Component.ETEN

Strain tensor [EXX, EYY, EZZ, EXY, EYZ, EZX]

Component.EXX

X strain

Component.EXY

XY shear strain

Component.EYY

Y strain

Component.EYZ

YZ shear strain

Component.EZX

ZX shear strain

Component.EZZ

Z strain

Element Stress Derived Data Components

Component.LODE_A

Lode angle

Component.LODE_P

Lode parameter

Component.LODE_PA

Lode parameter alt

Component.S2MAX

2D (in-plane) max principal stress

Component.S2MIN

2D (in-plane) min principal stress

Component.S2SHEAR

2D (in-plane) max shear stress

Component.SAV

Average stress (pressure)

Component.SMAX

Max principal stress

Component.SMID

Middle principal stress

Component.SMIN

Min principal stress

Component.SMS

Max shear stress

Component.SVON

signed von Mises stress

Component.TRI

Triaxiality

Component.YUTF

Yield Utilisation Factor

Component.YUTP

Yield Utilisation Percentage

Element Stress Tensor Data Components

Component.STEN

Stress tensor [SXX, SYY, SZZ, SXY, SYZ, SZX]

Component.SXX

X stress

Component.SXY

XY stress

Component.SYY

Y stress

Component.SYZ

YZ stress

Component.SZX

ZX stress

Component.SZZ

Z stress

Element Thermal Strain Derived Data Components

Component.TEAV

Average thermal strain

Component.TEMAX

Max principal thermal strain

Component.TEMID

Middle principal thermal strain

Component.TEMIN

Min principal thermal strain

Component.TEMS

Max thermal shear strain

Element Thermal Strain Tensor Data Components

Component.TETEN

Thermal strain tensor [EXX, EYY, EZZ, EXY, EYZ, EZX]

Component.TEXX

X Thermal strain

Component.TEXY

XY Thermal shear strain

Component.TEYY

Y Thermal strain

Component.TEYZ

XY Thermal shear strain

Component.TEZX

ZX Thermal shear strain

Component.TEZZ

Z Thermal strain

Global Energy Data Components

Component.GIE

Internal energy

Component.GKE

Kinetic energy

Component.GTE

Total energy

Global Mass Data Components

Component.GMASS

Mass

Global Momentum Data Components

Component.GMM

Momentum magnitude

Component.GMX

X Momentum

Component.GMY

Y Momentum

Component.GMZ

Z Momentum

Global Velocity Data Components

Component.GVM

Velocity magnitude

Component.GVX

X Velocity

Component.GVY

Y Velocity

Component.GVZ

Z Velocity

LSDA (binout) Database Cross Section Data Components

Component.XSEC_A

Database X-sect area

Component.XSEC_F

Database X-sect force (vector data)

Component.XSEC_M

Database X-sect moment (vector data)

LSDA (binout) Retractor Data Components

Component.RT_F

Retractor force

Component.RT_P

Retractor pull-out

LSDA (binout) SPC Data Components

Component.SPC_F

SPC force (vector data at nodes)

Component.SPC_M

SPC moment (vector data at nodes)

LSDA (binout) Seatbelt Data Components

Component.SB_F

Seatbelt axial force

Component.SB_L

Seatbelt length

LSDA (binout) Slipring Data Components

Component.SR_P

Slipring pull-through

LSDA (binout) Spotweld Data Components

Component.SW_F

Spotweld axial force

Component.SW_FAIL

Spotweld failure

Component.SW_S

Spotweld shear force

Component.SW_TIME

Spotweld failure time

Component.SW_TRSN

Spotweld torsion moment

LSDA (binout) Spring Data Components

Component.SP_E

Spring elongation

Component.SP_F

Spring axial force

Component.SP_M

Spring torsional moment

Component.SP_R

Spring rotation

Material Data Components for PARTs and Part-based elems (needs .ZTF file)

Component.DENS

Material density

Component.FSTRN

Failure strain

Component.PRAT

Poisson’s ratio

Component.YMOD

Young’s modulus

Component.YSTRS

Yield stress

Nastran OP2 Beam Data Components

Component.BENL

Energy loss

Component.BENLD

Energy loss density

Component.BENLP

Energy loss percentage

Component.BKEN

Kinetic energy

Component.BKEND

Kinetic energy density

Component.BKENP

Kinetic energy percentage

Component.BSEN

Strain energy

Component.BSEND

Strain energy density

Component.BSENP

Strain energy percentage

Nodal Data Components

Component.AM

Acceleration magnitude

Component.AV

Acceleration vector [AX, AY, AZ]

Component.AX

X acceleration

Component.AY

Y acceleration

Component.AZ

Z acceleration

Component.BV

Basic (undeformed) vector [BX, BY, BZ]

Component.BX

Basic (undeformed) X coordinate

Component.BY

Basic (undeformed) Y coordinate

Component.BZ

Basic (undeformed) Z coordinate

Component.CV

Current vector [CX, CY, CZ]

Component.CX

Current X coordinate

Component.CY

Current Y coordinate

Component.CZ

Current Z coordinate

Component.DM

Displacement magnitude

Component.DV

Displacement vector [DX, DY, DZ]

Component.DX

X displacement

Component.DY

Y displacement

Component.DZ

Z displacement

Component.RAM

Rotation acceleration magnitude

Component.RAV

Rotation acceleration vector [RAX, RAY, RAZ]

Component.RAX

X rotation acceleration

Component.RAY

Y rotation acceleration

Component.RAZ

Z rotation acceleration

Component.RDM

Rotation displacement magnitude

Component.RDV

Rotation displacement vector [RDX, RDY, RDZ]

Component.RDX

X rotation displacement

Component.RDY

Y rotation displacement

Component.RDZ

Z rotation displacement

Component.RVM

Rotation velocity magnitude

Component.RVV

Rotation velocity vector [RVX, RVY, RVZ]

Component.RVX

X rotation velocity

Component.RVY

Y rotation velocity

Component.RVZ

Z rotation velocity

Component.VM

Velocity magnitude

Component.VV

Velocity vector [VX, VY, VZ]

Component.VX

X velocity

Component.VY

Y velocity

Component.VZ

Z velocity

Shell and Solid Data Components

Component.AREA

Area

Component.DTDT

dTemp / dTime

Component.EDEN

Internal energy density

Component.EMASS

Mass

Component.ENL

Energy loss (Nastran OP2 results only)

Component.ENLD

Energy loss density (Nastran OP2 results only)

Component.ENLP

Energy loss percentage (Nastran OP2 results only)

Component.HGEN

Hourglass energy

Component.KEN

Kinetic energy (Nastran OP2 results only)

Component.KEND

Kinetic energy density (Nastran OP2 results only)

Component.KENP

Kinetic energy percentage (Nastran OP2 results only)

Component.MADD

Added mass

Component.RFX

X force resultant

Component.RFXY

XY force resultant

Component.RFY

Y force resultant

Component.RMX

MX moment resultant

Component.RMXY

MXY moment resultant

Component.RMY

MY moment resultant

Component.RQX

XZ shear force resultant

Component.RQY

YZ shear force resultant

Component.RVOL

Relative volume (solid)

Component.SEN

Strain energy (Nastran OP2 results only)

Component.SEND

Strain energy density (Nastran OP2 results only)

Component.SENP

Strain energy percentage (Nastran OP2 results only)

Component.SHX

Extra shell and thick shell data

Component.SOX

Extra solid data

Component.TBOT

Nodal (shell) bottom surface temperature

Component.TEMP

Nodal temperature

Component.TFM

Temperature magnitude

Component.TFV

Temperature vector [TFX, TFY, TFZ]

Component.TFX

X temperature flux

Component.TFY

Y temperature flux

Component.TFZ

Z temperature flux

Component.THK

Thickness

Component.TMID

Nodal (shell) middle surface temperature

Component.TSTP

Timestep

Component.TTOP

Nodal (shell) top surface temperature

Component.VOL

Volume (solid)

User defined binary component data type

Component.SCALAR

Scalar data (1 value)

Component.TENSOR

Tensor data (6 values)

Component.VECTOR

Vector data (3 values)

User defined binary component existing action

Component.RENAME

Renames the name of the component by adding a suffix to make it unique so any existing component of this name (and data) will be left unchanged and the new one will not clash with it

Component.REPLACE

Replaces any existing component, replacing it with this definition. This means that any existing data for the user-defined component of this name is deleted and the component is re-initialised

User defined binary component location

Component.IN_CORE

held in memory

User defined binary component type

Component.BEAM

User-defined beam component

Component.NODE

User-defined nodal component

Component.OTHER

User-defined other (LSDA) component

Component.SOLID_SHELL_TSHELL

User-defined solid, shell and thick shell component

user

Component.UBMS

Beam scalar

Component.UBMV

Beam vector

Component.UNOS

Node scalar

Component.UNOV

Node vector

Component.USSS

Solid and shell scalar

Component.USST

Solid and shell tensor

Properties

property Component.componentType(read only): constant

The type of component stored in the user defined binary component. Either Component.NODE, Component.BEAM, Component.SOLID_SHELL_TSHELL or Component.OTHER

property Component.dataType(read only): constant

The type of data stored in the user defined binary component. Either Component.SCALAR, Component.TENSOR or Component.VECTOR

property Component.dispose(read only): boolean

If .ubd files for components will be disposed of (deleted) when a model is closed or D3PLOT exits or not. The default is not to delete files

property Component.location(read only): constant | string

Where the user defined binary component will be written to disk. This can be an absolute or relative pathname. If a relative path is used, this is relative to the Ansys LS-DYNA results files. This is done by giving a pathname beginning with “JOBDIR”. For example “JOBDIR/..” refers to the parent directory where the results files are. The default, if location is None, is for .ubd files to be written in the same directory as the Ansys LS-DYNA output files. Alternatively, the data can just be kept in memory and not written to disk by using Component.IN_CORE

property Component.name(read only): string

The name for the user defined binary component

Constructor

classmethod Component(name, component, data, options=Oasys.gRPC.defaultArg)
Creates a new user defined binary data component in D3PLOT

Parameters:

name (string) – Name for the component

component (constant) – The type of component stored in the user defined binary component. Either Component.NODE, Component.BEAM, Component.SOLID_SHELL_TSHELL or Component.OTHER

data (constant) – The type of data stored in the user defined binary component. Either Component.SCALAR, Component.TENSOR or Component.VECTOR

options (dict) –
Optional. Dictionary containing extra information. Can contain any of:

dispose:

(boolean) If .ubd files for components will be disposed of (deleted) when a model is closed or D3PLOT exits or not. The default is not to delete files

exists:

(constant) Action to take if a component with this name already exists. Either Component.RENAME or Component.REPLACE (default)

location:

(constant|string|None) Location to store the .ubd files. See location for details. The default, if location is None, is for .ubd files to be written in the same directory as the Ansys LS-DYNA output files. This default can be changed with the d3plot*ubd_file_location preference

Returns:

Model object

Return type:

Model

Example

To create a user defined binary data component in D3PLOT:
options = { "dispose": True, "exists": Oasys.D3PLOT.Component.RENAME, "location": None }
ub = Oasys.D3PLOT.Component("My component", Oasys.D3PLOT.Component.NODE, Oasys.D3PLOT.Component.SCALAR, options)

Static methods

classmethod Component.First()
Returns the first user defined binary component in D3PLOT (or None if there are no components)

Returns:

Component object

Return type:

Component

Example

To get the first user defined binary component:
c = Oasys.D3PLOT.Component.First()
classmethod Component.GetFromID(number)
Returns the user defined binary component in D3PLOT by ID (or None if the component does not exist)

Parameters:

number (integer) – number of the component you want the Component object for

Returns:

Component object

Return type:

Component

Example

To get the Component object for user defined binary component number 1:
c = Oasys.D3PLOT.Component.GetFromID(1)
classmethod Component.GetFromName(name)
Returns the user defined binary component in D3PLOT by name (or None if the component does not exist)

Parameters:

name (string) – name of the component you want the Component object for

Returns:

Component object

Return type:

Component

Example

To get the Component object for user defined binary component named test:
c = Oasys.D3PLOT.Component.GetFromName("test")
classmethod Component.Last()
Returns the last user defined binary component in D3PLOT (or None if there are no components)

Returns:

Component object

Return type:

Component

Example

To get the last user defined binary component:
c = Oasys.D3PLOT.Component.Last()
classmethod Component.Total()
Returns the total number of user defined binary components in D3PLOT

Returns:

Total number of user binary components

Return type:

integer

Example

To get total number of components:
total = Oasys.D3PLOT.Component.Total()

Instance methods

Component.Delete()
Deletes the next user defined binary data component.
Do not use the component object after calling this method

Returns:

Component object

Return type:

Component

Example

To delete component c:
c.Delete()
Component.GetData(item, options=Oasys.gRPC.defaultArg)
Returns the user defined binary data component for an item

Parameters:

item (Node|Beam|Shell|Solid|Tshell) – The Node, Beam, Shell, Solid or Tshell the data should be retrieved for

options (dict) –
Optional. Dictionary containing extra information. Can contain any of:

ip:

(integer) The integration point to get the data for for shells and thick shells

op:

(integer) The on plan integration point to get the data for for fully integrated shells and thick shells. If omitted the first on plan integration point will be used

Returns:

The component data

Return type:

float|array

Example

To get the data for solid s, user defined component c:
data = c.GetData(s)
Component.Next()
Returns the next user defined binary data component (or None if there is not one)

Returns:

Component object

Return type:

Component

Example

To get the component after component c:
c = c.Next()
Component.Previous()
Returns the previous user defined binary data component (or None if there is not one)

Returns:

Component object

Return type:

Component

Example

To get the component before component c:
c = c.Previous()
Component.PutData(item, data, options=Oasys.gRPC.defaultArg)
Sets the user defined binary data component for an item

Parameters:

item (Node|Beam|Shell|Solid|Tshell) – The Node, Beam, Shell, Solid or Tshell the data should be set for

data (float|list) – The data to set. If the component data property is Component.SCALAR this will be a single value. If the component data property is Component.VECTOR this is a list with length 3. If the component data property is Component.TESNOR this is a list with length 6

options (dict) –
Optional. Dictionary containing extra information. Can contain any of:

ip:

(integer) The integration point to set the data for for shells and thick shells

op:

(integer) The on plan integration point to set the data for for fully integrated shells and thick shells

Returns:

No return value

Return type:

None

Example

To Set the data for solid s, user defined component c to be 1.23:
c.PutData(s, 1.23)