You are on page 1of 1011

ANSYS Mechanical User's Guide -II

ANSYS, Inc.
Southpointe
2600 ANSYS Drive
Canonsburg, PA 15317 ANSYS, Inc. and
ansysinfo@ansys.com ANSYS Europe,
Ltd. are UL
http://www.ansys.com registered ISO
(T) 724-746-3304 9001: 2008
(F) 724-514-9494 companies.
Copyright and Trademark Information

© 2017 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.

ANSYS, ANSYS Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand, product, service and feature
names, logos and slogans are registered trademarks or trademarks of ANSYS, Inc. or its subsidiaries located in the
United States or other countries. ICEM CFD is a trademark used by ANSYS, Inc. under license. CFX is a trademark
of Sony Corporation in Japan. All other brand, product, service and feature names or trademarks are the property
of their respective owners. FLEXlm and FLEXnet are trademarks of Flexera Software LLC.

Disclaimer Notice

THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFID-
ENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.

ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2008 companies.

U.S. Government Rights

For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).

Third-Party Software

See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, contact ANSYS, Inc.

Published in the U.S.A.


Setting Up Boundary Conditions

The following animation shows total deformation:

The following demo is presented as an animated GIF. View online if you are reading the PDF version of the
help. Interface names and other components shown in the demo may differ from those in the released
product.

Moment
This boundary condition distributes a moment "about" (the vector of ) an axis across one or more flat
or curved faces, or about one or more edges or vertices. Use the right-hand rule to determine the sense
of the moment.

A Moment is classified as a remote boundary condition. Refer to the Remote Boundary Conditions (p. 1132)
section for a listing of all remote boundary conditions and their characteristics.

Analysis Types
Moment is available for the following analysis types:

• Harmonic Acoustics (p. 247)

• Harmonic Response (p. 211)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Release 2020 R1 - © ANSYS, Inc.


972
Types of Boundary Conditions

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Moment boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Note

Face and edge selections for the moment load can span multiple parts, however, multiple
vertex selections must be of the same part type (solid, 3D surface or line bodies) or the selec-
tion is ignored.

Topology: The following topology selection options are supported for Moment.

• Body: Not Supported.

• Face: Supported - 3D only. If a face enlarges (e.g., due to a change in parameters), the total load applied to
the face remains constant, but the load per unit area decreases.

• Edge: Supported.

• Vertex: Supported. This boundary condition cannot be applied to a vertex scoped to an end release (p. 828).

• Nodes: Supported.

Loading Types: The boundary condition’s loading is defined using one of the following options.

• Vector – Supported. While loads are associative with geometry changes, load directions are not.

The vector load definition displays in the Annotation legend with the label Components (p. 162). The
Magnitude and Direction entries, in any combination or sequence, define these displayed values.
These are the values sent to the solver.

• Vector: Real - Imaginary. Supported for Harmonic Response Analysis only.

• Components – Supported.

• Components: Real - Imaginary. Supported for Harmonic Response Analysis only.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying): Supported.

• Tabular (Step Varying): Supported for Static Structural analysis only.

Release 2020 R1 - © ANSYS, Inc.


973
Setting Up Boundary Conditions

• Tabular (Frequency Varying): Supported for Harmonic Response Analysis only.

By default, at least two frequency entries are required when defining a frequency dependent tabular
load.

• Tabular (Spatially Varying): Not Supported.

• Function (Time Varying): Supported.

• Function (Spatially Varying): Not Supported.

Boundary Condition Application


To apply a Moment:

1. On the Environment context toolbar: click Loads>Moment. Or, right-click the Environment tree object
or the Geometry window and select Insert>Moment.

2. Define the Scoping Method.

Note

When specifying the Scoping Method, faces and edges can be scoped to either the
geometry where the load is to be applied (Geometry Selection), to a Named Selection,
or to a Remote Point (p. 609). Vertices cannot be scoped to Remote Point.

3. Select the method used to define the moment: Vector (default), Vector: Real - Imaginary, Components,
or Components: Real - Imaginary.

4. Define the Magnitude, Coordinate System directional loading, and/or Direction of the load based on
the above selections.

5. For Harmonic analyses, specify a Phase Angle as needed.

6. Select the Behavior of the geometry.

7. As needed, enter a Pinball Region value. The default value is All.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary condition


is applied to a geometry or geometries, which are chosen using a graphical
selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of
geometric entities (for example: 1 Body, 2 Edges) to which the boundary
has been applied using the selection tools.

Release 2020 R1 - © ANSYS, Inc.


974
Types of Boundary Conditions

Category Fields/Options/Description
• Named Selection: Indicates that the geometry selection is defined by a Named
Selection.

– Named Selection: Visible when the Scoping Method is set to Named Se-
lection. This field provides a drop-down list of available user-defined Named
Selections.

• Remote Point

– Remote Point: Visible when the Scoping Method is set to Remote Point.
This field provides a drop-down list of available user-defined Remote Points.

Definition Type: Read-only field that displays boundary condition type - Moment.

Define By (3D Only), options include:

• Vector: A magnitude and direction (based on selected geometry). Requires


the specification of the following inputs:

– Magnitude

– Phase Angle (Harmonic Analysis (p. 211) only)

– Direction

• Vector: Real - Imaginary (Harmonic Analysis only): Real and imaginary


magnitude and direction (based on selected geometry). Requires the
specification of the following inputs:

– Magnitude - Real

– Magnitude - Imag

– Direction

• Components: Option to define the loading type as Components (in the world
coordinate system or local coordinate system, if applied). Requires the
specification of at least one of the following inputs:

– Coordinate System: Drop-down list of available coordinate systems. Global


Coordinate System is the default.

– X Component: Defines magnitude in the X direction.

– Y Component: Defines magnitude in the Y direction.

– Z Component: Defines magnitude in the Z direction.

– X Phase Angle (Harmonic Analysis (p. 211) only)

– Y Phase Angle (Harmonic Analysis (p. 211) only)

– Z Phase Angle (Harmonic Analysis (p. 211) only)

Release 2020 R1 - © ANSYS, Inc.


975
Setting Up Boundary Conditions

Category Fields/Options/Description
• Components: Real - Imaginary (Harmonic Analysis (p. 211) only): Option to
define the loading type as real and imaginary components (in the world
coordinate system or local coordinate system, if applied). Requires the
specification of at least one of the following inputs:

– X Component - Real

– X Component - Imaginary

– Y Component - Real

– Y Component - Imaginary

– Z Component - Real

– Z Component - Imaginary

Magnitude (2D Only).

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Behavior (p. 614): This option dictates the behavior of the attached
geometry. If the Scope Method property is set to Remote Point, the
boundary condition will then assume the Behavior defined in the
referenced Remote Point as well as other related properties. Options
include:

• Rigid: Does not allow the scoped geometry to deform.

• Deformable: Allows the scoped geometry to deform.

• Coupled: Allows the scoped geometry to have the same DOF solution on its
underlying nodes as the remote point location.

• Beam: This option specifies a connection from the remote load to the model
using linear massless beam elements. It is not a valid option for a Modal
Superposition Harmonic Response analysis unless a Remote Point references
the load.

Material: This property is available when the Behavior property is set to


Beam. Select a material to define material properties for the beams used
in the connection. Density is excluded from the material definition.

Radius: This property is available when the Behavior property is set to


Beam. Specify a radius to define the cross section dimension of the circular
beam used for the connection.
Advanced Pinball Region

Generalized Plane Strain


This boundary condition is used during 2D simulations (p. 502) involving generalized plane strain beha-
vior (p. 503).

Release 2020 R1 - © ANSYS, Inc.


976
Types of Boundary Conditions

Analysis Types
The Generalized Plane Strain boundary condition is available for the following analysis types:

• Modal Analysis (p. 227)

• Eigenvalue Buckling (p. 203)

• Harmonic Response (p. 211)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Not Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Generalized Plane Strain boundary condition
include:

• Solid: Not Supported.

• Surface/Shell: Supported - 2D Surface Only.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Generalized Plane Strain.

• Body: Supported - All Bodies.

• Face: Not Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Types and Loading Data Definition (p. 1150): The Generalized Plane Strain boundary con-
dition is defined as a constant.

Boundary Condition Application


To apply a Generalized Plane Strain:

1. On the Environment context toolbar, click Loads>Generalized Plane Strain. Or, right-click the Environ-
ment tree object or in the Geometry window and select Insert>Generalized Plane Strain.

Release 2020 R1 - © ANSYS, Inc.


977
Setting Up Boundary Conditions

2. The Geometry selection for this boundary condition is, by default, set to All Bodies and is a read-only
property.

3. Define the X Coordinate of Reference Point and the Y Coordinate of Reference Point. These entries are
distance values defining the starting point in space.

4. Define the properties for the Condition Along Fiber Direction, that includes options for the Boundary
Condition property and a Magnitude as applicable.

• Free - No magnitude.

• Force - Enter magnitude.

• Displacement - Enter magnitude.

5. Define the properties for the Condition for Rotation About X-axis and the Condition for Rotation About
Y-axis. The options for the include Boundary Condition property are listed below. Magnitude is defined
when applicable.

• Free - No magnitude.

• Moment - Enter magnitude.

• Rotation - Enter magnitude.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Geometry: Read-only field that displays geometry selection - All Bodies
Definition Coordinate System: Drop-down list of available coordinate systems.
Global Coordinate System is the default.

X Coordinate of Reference Point

Y Coordinate of Reference Point

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.
Condition for Rotation Boundary Condition, options include:
About X-axis
• Free: No magnitude.

• Moment: Enter magnitude.

• Rotation: Enter magnitude.

Magnitude
Condition for Rotation Boundary Condition, options include:
About Y-axis
• Free: No magnitude.

• Moment: Enter magnitude.

Release 2020 R1 - © ANSYS, Inc.


978
Types of Boundary Conditions

Category Fields/Options/Description
• Rotation: Enter magnitude.

Magnitude

Note

You may wish to review the Generalized Plain Strain Probes (p. 1303) section of the Help for
additional information about this boundary condition.

Line Pressure
For 3D simulations, a line pressure load applies a distributed force using force density loading in units
of force per length. You can define force density as a vector, an axial component, or tangentially. Tan-
gential loads can be applied to one edge only whereas vector and component loads and can be applied
to one or more edges.

If a pressurized edge enlarges due to a change in CAD parameters, the total load applied to the edge
increases, but the pressure (force per unit length) remains constant.

Analysis Types
Line Pressure is available for the following analysis types:

• Explicit Dynamics

• Harmonic Acoustics (p. 247)

• Harmonic Response (p. 211)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

Release 2020 R1 - © ANSYS, Inc.


979
Setting Up Boundary Conditions

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Line Pressure boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Line Pressure.

• Body: Not Supported.

• Face: Not Supported.

• Edge: Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Types: The boundary condition’s loading is defined using one of the following options.

• Vector: Supported.

The vector load definition displays in the Annotation legend with the label Components (p. 162). The
Magnitude and Direction entries, in any combination or sequence, define these displayed values.
These are the values sent to the solver.

• Tangential: Supported (scoped to one edge only).

• Components: Supported.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying): Supported.

• Tabular (Step Varying): Supported for Static Structural analysis only.

• Tabular (Spatially Varying): Supported for Tangential loading only

• Function (Time Varying): Supported.

• Function (Spatially Varying): Supported for Tangential loading only.

Boundary Condition Application


To apply a Line Pressure:

1. On the Environment context toolbar: click Loads>Line Pressure. Or, right-click the Environment tree
object or the Geometry window and select Insert>Line Pressure.

Release 2020 R1 - © ANSYS, Inc.


980
Types of Boundary Conditions

2. Define the Scoping Method.

3. Select the method used to define the Line Pressure: Vector (default), Tangential, or Components.

4. Define the Magnitude, Coordinate System, and/or Direction of the Line Pressure based on the above
selections.

5. For Harmonic analyses, specify a Phase Angle as needed.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary condition


is applied to a geometry or geometries, which are chosen using a graphical
selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of
geometric entities (for example: 1 Body, 2 Edges) to which the boundary
has been applied using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Se-
lection. This field provides a drop-down list of available user-defined Named
Selections.

Definition Type: Read-only field that displays boundary condition type - Line Pres-
sure.

Define By, options include:

• Vector: A magnitude and direction (based on selected geometry). Requires


the specification of the following inputs:

– Magnitude

– Direction

• Tangential (scoped to one edge only)

• Components: Option to define the loading type as Components (in the world
coordinate system or local coordinate system, if applied). Requires the
specification of at least one of the following inputs:

– Coordinate System: Drop-down list of available coordinate systems. Global


Coordinate System is the default.

– X Component: Defines magnitude in the X direction.

Release 2020 R1 - © ANSYS, Inc.


981
Setting Up Boundary Conditions

Category Fields/Options/Description
– Y Component: Defines magnitude in the Y direction.

– Z Component: Defines magnitude in the Z direction.

Phase Angle (Harmonic Analysis (p. 211) only).

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Line pressure is applied using the SFE command and the SURF156 element type.

• Magnitude (constant, tabular, and function) is always represented as one or more tables in the input file.

PSD Base Excitation


PSD Base Excitation loads are used exclusively in random vibration analyses (p. 235) to provide excitation
in terms of spectral value vs. frequency to your choice of the supports that were applied in the pre-
requisite modal analysis (p. 227). The Boundary Condition setting in the Details view includes a drop-
down list where you can specify any of the following supports for excitation that are defined in the
modal analysis: Fixed Support, Displacement, Remote Displacement, and Body-to-Ground Spring.
If multiple fixed supports or multiple remote displacements are defined in the modal analysis, you can
apply the excitation load to all fixed supports or all remote displacements or all of both loads using
one of the following options:

• All Fixed Supports

• All Remote Displacements

• All Fixed and Remote Displacements

• All Supports (including Fixed, Remote Displacement, Displacement, and Grounded Springs)

Note

• Only fixed degrees of freedom of the supports are valid for excitations.

• Boundary conditions defined with a local coordinate system are not supported.

You can also specify the excitation direction (X Axis, Y Axis, or Z Axis).

Release 2020 R1 - © ANSYS, Inc.


982
Types of Boundary Conditions

The user-defined PSD data table is created in the Tabular Data window. You can create a new PSD
table or import one from a library that you have created, via the fly-out of the Load Data option in the
Details view.

Note

Only positive table values can be input when defining this load.

When creating PSD loads for a Random Vibration analysis in the Mechanical application, Workbench
evaluates your entries by performing a "Goodness of Fit" to ensure that your results will be dependable.

Click the fly-out of the Load Data option and choose Improved Fit after entering data points for
viewing the graph and updating the table. Interpolated points are displayed if they are available from
the goodness of fit approximation. Once load entries are entered, the table provides one of the following
color-code indicators per segment:

• Green: Values are considered reliable and accurate.

• Yellow: This is a warning indicator. Results produced are not considered to be reliable and accurate.

• Red: Results produced are not considered trustworthy. If you choose to solve the analysis, the Mechanical
APDL application executes the action, however; the results are almost certainly incorrect. It is recommended
that you modify your input PSD loads prior to the solution process.

Four types of base excitation are supported:

• PSD Acceleration

• PSD G Acceleration

• PSD Velocity

• PSD Displacement

The direction of the PSD base excitation is defined in the nodal coordinate of the excitation points.

Multiple PSD excitations (uncorrelated) can be applied. Typical usage is to apply three different PSDs
in the X, Y, and Z directions. Correlation between PSD excitations is not supported.

RS Base Excitation
RS Base Excitation loads are used exclusively in response spectrum analyses (p. 242) to provide excitation
in terms of a spectrum. For each spectrum value, there is one corresponding frequency. Use the
Boundary Condition setting in the Details view to apply an excitation to all of the fixed supports that
were applied in the prerequisite modal analysis (p. 227).

Note

Only fixed DOFs of the supports are valid for excitations.

You can also specify the excitation in a given direction (X Axis, Y Axis, or Z Axis).

Release 2020 R1 - © ANSYS, Inc.


983
Setting Up Boundary Conditions

The user-defined RS data table is created in the Tabular Data window. You can create a new RS table
or import one from a library that you have created, via the fly-out of the Load Data option in the Details
view.

Note

Only positive table values can be used when defining this load.

Three types of base excitation are supported:

• RS Acceleration

• RS Velocity

• RS Displacement

You should specify the direction of the RS base excitation in the global Cartesian system.

Multiple RS excitations (uncorrelated) can be applied. Typical usage is to apply 3 different RS excitations
in the X, Y, and Z directions. Correlation between RS excitations is not supported.

The following additional settings are included in the Details view of an RS Base Excitation load:

• Scale Factor: Scales the entire table of input excitation spectrum for a Single Point response spectrum.
The factor must be greater than 0.0. The default is 1.0.

• Missing Mass Effect: Set to Yes to include the contribution of high frequency modes in the total response
calculation. Including these modes is normally required for nuclear power plant design.

The responses contributed by frequency modes higher than those of rigid responses, specifically
frequency modes beyond Zero Period Acceleration (ZPA) are called residual rigid responses. The fre-
quency modes beyond ZPA are defined as frequency modes at which the spectral acceleration returns
to the Zero Period Acceleration. In some applications, especially in the nuclear power plant industry,
it is critical and required to include the residual rigid responses to the total responses. Ignoring the
residual rigid responses will result in an underestimation of responses in the vicinity of supports.
There are two methods available to calculate residual rigid responses: the Missing Mass and Static
ZPA methods. The Missing Mass method is named based on the fact that the mass associated with
the frequency modes higher than that of ZPA are missing from the analysis. As a result, the residual
rigid responses are sometimes referred to missing mass responses. When set to Yes, the Missing
Mass Effect is used in a response spectrum analysis.

• Rigid Response Effect: Set to Yes to include rigid responses to the total response calculation. Rigid responses
normally occur in the frequency range that is lower than that of missing mass responses, but higher than
that of periodic responses.

In many cases, it is impractical and difficult to accurately calculate all natural frequencies and mode
shapes for use in the response spectrum evaluation. For high-frequency modes, rigid responses ba-
sically predominate. To compensate for the contribution of higher modes to the responses, the rigid
responses are combined algebraically to the periodic responses, which occur in the low-frequency
modes that are calculated using one the methods above. The most widely adopted methods to cal-
culate the rigid responses are the Gupta and Lindley-Yow methods. These two methods are available
for a response spectrum analysis under Rigid Response Effect Type when Rigid Response Effect
is set to Yes.

Release 2020 R1 - © ANSYS, Inc.


984
Types of Boundary Conditions

Joint Load
When you are using joints in a Transient Structural (p. 384) or Rigid Dynamics (p. 263) analysis, you
use a Joint Load object to apply a kinematic driving condition to a single degree of freedom on a Joint
object. Joint Load objects are applicable to all joint types (p. 750) except fixed, general, universal, and
spherical joints. For translation degrees of freedom, the Joint Load can apply a displacement, velocity,
acceleration, or force. For rotation degrees of freedom, the Joint Load can apply a rotation, angular
velocity, angular acceleration, or moment. The directions of the degrees of freedom are based on the
reference coordinate system of the joint and not on the mobile coordinate system.

A positive joint load will tend to cause the mobile body to move in the positive degree of freedom
direction with respect to the reference body, assuming the mobile body is free to move. If the mobile
body is not free to move then the reference body will tend to move in the negative degree of freedom
direction for the Joint Load. One way to learn how the mechanism will behave is to use the Config-
ure (p. 796) feature. For the joint with the applied Joint Load, dragging the mouse will indicate the
nature of the reference/mobile definition in terms of positive and negative motion.

To apply a Joint Load:

1. Highlight the Transient environment object and insert a Joint Load from the right mouse button context
menu or from the Loads drop-down menu in the Environment toolbar.

2. From the Joint drop-down list in the Details view of the Joint Load, select the particular Joint object that
you would like to apply to the Joint Load. You should apply a Joint Load to the mobile bodies of the
joint. It is therefore important to carefully select the reference and mobile bodies while defining the joint.

3. Select the unconstrained degree of freedom for applying the Joint Load, based on the type of joint (p. 750).
You make this selection from the DOF drop-down list. For joint types that allow multiple unconstrained
degrees of freedom, a separate Joint Load is necessary to drive each one. Further limitations apply as
outlined under Joint Load Limitations (p. 986) below. Joint Load objects that include velocity, acceleration,
rotational velocity or rotational acceleration are not applicable to static structural analyses.

4. Select the type of Joint Load from the Type drop-down list. The list is filtered with choices of Displace-
ment, Velocity, Acceleration, and Force if you selected a translational DOF in step 3. The choices are
Rotation, Rotational Velocity, Rotational Acceleration, and Moment if you selected a rotational DOF.

Note

If you are using the Mechanical APDL solver and scoping the Joint Load to a General
joint that has the Rotation property set to Free All, then the Moment option is not
listed in the Type property drop-down list.

5. Specify the magnitude of the Joint Load type selected in step 4 as a constant, in tabular format, or as a
function of time using the same procedure as is done for most loads in the Mechanical application. Refer
to Defining Boundary Condition Magnitude (p. 1150) for further information.

Tip

On Windows platforms, an alternative and more convenient way to accomplish steps 1


and 2 above is to drag and drop the Joint object of interest from under the Connections
object folder to the Transient object folder. When you highlight the new Joint Load

Release 2020 R1 - © ANSYS, Inc.


985
Setting Up Boundary Conditions

object, the Joint field is already completed and you can continue at step 3 with DOF
selection.

6. As applicable, specify the load step at which you want to lock the joint load by entering the value of the
step in the Lock at Load Step field. The default value for this option is zero (0) and is displayed as Never.
This feature immobilizes movement of the joint’s DOFs. For example, this option is beneficial when you
want to tighten a bolt to an initial torque value (via a Moment Joint Driver on a Revolute Joint) and then
lock that joint during a subsequent load step.

Note

Mechanical APDL References:

This feature makes use of the %_FIX% parameter on the DJ command.


When a joint driver with a force or moment load is deactivated, then the lock con-
straint on the joint is also deleted using the DJDELE command. This happens if the
locking occurs before the deactivation.

Joint Load Limitations


Some joint types have limitations on the unconstrained degrees of freedom that allow the application
of joint loads as illustrated in the following table:

Joint Type Unconstrained Degrees of Allowable Degrees of Freedom for


Freedom Applying Joint Loads
Fixed (p. 750) None Not applicable
Revolute (p. 750) ROTZ ROTZ
Cylindrical (p. 751) UZ, ROTZ UZ, ROTZ
Translational (p. 751) UX UX
Slot (p. 752) UX, ROTX, ROTY, ROTZ UX
Universal (p. 753) ROTX, ROTZ None
Spherical (p. 753) ROTX, ROTY, ROTZ None
Planar (p. 754) UX, UY, ROTZ UX, UY, ROTZ
General (p. 757) UX, UY and UZ, Free X, Free All unconstrained degrees of
Y, Free Z, and Free All freedom
Bushing (p. 754) UX, UY, UZ, ROTX, ROTY, All unconstrained degrees of
ROTZ freedom
Point on Curve (p. 757) UX UX

Note

Where applicable, you must define all three rotations for a Joint Load before proceeding to
a solve.

Release 2020 R1 - © ANSYS, Inc.


986
Types of Boundary Conditions

Thermal Condition
You can insert a known temperature (not from data transfer) boundary condition in an analysis by in-
serting a Thermal Condition object and specifying the value of the temperature in the Details view
under the Magnitude property. If the load is applied to a surface body, by default the temperature is
applied to both the top and bottom surface body faces. You do have the option to apply different
temperatures to the top and bottom faces by adjusting the Shell Face entry in the details view. When
you apply a thermal condition load to a solid body, the Shell Face property is not available in the Details
view. You can add the thermal condition load as time-dependent (p. 50) or spatially varying (p. 1149).

Note

• When a Thermal Condition is specified on the Top or Bottom shell face of a surface body, the
opposite face defaults to the environment temperature unless it is otherwise specified from an-
other load object.

• For an assembly of bodies with different topologies (solid body, line, shell, beam), you must
define a separate Thermal Condition load for each topology, that is, you must define one load
scoped to line bodies, define a second load scoped to surface bodies, and so on.

• For each load step, if an Imported Body temperature load and a Thermal Condition load are applied
on common geometry selections, the Imported Body temperature load takes precedence. See
Activation/Deactivation of Loads (p. 875) for additional rules when multiple load objects of the
same type exist on common geometry selections.

• If the Thermal Condition is applied to a shell face that has a Layered Section (p. 494) applied to
it, you must set Shell Face to Both in order to solve the analysis.

Analysis Types
Thermal Condition is available for the following analysis types:

• Eigenvalue Buckling (p. 203)

• Electric Analysis (p. 199)

• Modal (p. 227)

• Modal Acoustics (p. 253)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

Release 2020 R1 - © ANSYS, Inc.


987
Setting Up Boundary Conditions

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Thermal Condition boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Thermal Condition.

• Body: Supported. The Thermal Condition is a body-based boundary condition.

• Face: Not Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Types: The Thermal Condition boundary condition’s loading is defined by Magnitude only.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant (only option for Eigenvalue Buckling analyses).

• Tabular (Time Varying).

• Tabular (Step Varying): Supported for Static Structural analysis only.

• Tabular (Spatially Varying).

• Function (Time Varying).

• Function (Spatially Varying).

Boundary Condition Application


To apply a Thermal Condition:

1. On the Environment context toolbar: click Loads>Thermal Condition. Or, right-click the Environment
tree object or the Geometry window and select Insert>Thermal Condition.

2. Define the Scoping Method. This property has two options: Geometry Selection and Named Selection.
For either scoping type, you must use the body selection filter (on the Graphics Toolbar (p. 70)) for geometry
selection or Named Selection definition. Only solid bodies, surface body faces, or line bodies can be selected
or defined.

For surface bodies, in the Details view, the Shell Face property provides a drop-down list. Select
Top, Bottom, or Both (default) to apply the thermal boundary condition to the selected face. For
bodies that have one or more layered section objects, you need to specify Both for Shell Face or
the Thermal Condition will be under-defined and an error message will be generated.

Release 2020 R1 - © ANSYS, Inc.


988
Types of Boundary Conditions

3. Define the Magnitude, Coordinate System, and/or Direction of the thermal boundary condition based
on the above selections.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary condition


is applied to a geometry or geometries, which are chosen using a graphical
selection tools.

– Geometry: Visible when the Scoping Method property is set to Geometry


Selection. Displays the type of geometry (Body, Face, etc.) and the number
of geometric entities (for example: 1 Body, 2 Edges) to which the boundary
has been applied using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method property is set to


Named Selection. This field provides a drop-down list of available
user–defined Named Selections.

Definition Type: Read-only field that displays boundary condition type - Thermal
Condition.

Magnitude: Temperature value. The default is 22 degrees Celsius.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Temperatures are applied using the BF command. For surface bodies, with Top or Bottom Shell Face selec-
tion, temperatures are applied using the BFE command.

• Magnitude (constant, tabular, and function) is always represented as a table in the input file.

Temperature
This boundary condition simulates a uniform, time-dependent, or spatially varying temperature over
the selected geometry.

Release 2020 R1 - © ANSYS, Inc.


989
Setting Up Boundary Conditions

A spatially varying load allows you to vary the magnitude of a temperature in a single coordinate direction
and as a function of time using the Tabular Data or Function features. See the Defining Boundary
Condition Magnitude (p. 1150) section for the specific steps to apply tabular and/or function loads.

Note

For each load step, if an Imported Temperature load and a Temperature load are applied on
common geometry selections, the Imported Temperature load takes precedence. See Activ-
ation/Deactivation of Loads (p. 875) for additional rules when multiple load objects of the
same type exist on common geometry selections.

Analysis Types
Temperature is available for the following analysis types:

• Steady-State Thermal Analysis (p. 344)

• Transient Thermal Analysis (p. 397)

• Thermal-Electric Analysis (p. 348)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported - Plane Stress and Axisymmetric behaviors only.

Geometry Types: Geometry types supported for the Temperature boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Temperature.

• Body: Supported. When scoping a load to a body, you need to specify whether the temperature is applied
to Exterior Faces Only or to the Entire Body using the Apply To option.

• Face: Supported.

• Edge: Supported.

• Vertex: Supported.

Release 2020 R1 - © ANSYS, Inc.


990
Types of Boundary Conditions

• Nodes: Not Supported.

Note

The same temperature value is applied when multiple faces, edges, or vertices are selected.

Loading Types: The Temperature boundary condition’s loading is defined by Magnitude only.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant.

• Tabular (Time Varying).

• Tabular (Spatially Varying).

• Function (Time Varying).

• Function (Spatially Varying).

Boundary Condition Application


To apply a Temperature:

1. On the Environment context toolbar: click Loads>Temperature. Or, right-click the Environment tree
object or the Geometry window and select Insert>Temperature.

2. Define the Scoping Method and a geometry selection.

3. Enter a Magnitude for the Temperature.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary condition


is applied to a geometry or geometries, which are chosen using a graphical
selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of
geometric entities (for example: 1 Body, 2 Edges) to which the boundary
has been applied using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Se-
lection. This field provides a drop-down list of available user-defined Named
Selections.

Release 2020 R1 - © ANSYS, Inc.


991
Setting Up Boundary Conditions

Category Fields/Options/Description
Apply To (Body scoping only), options include:

• Exterior Faces Only

• Entire Body

Definition Type: Read-only field that displays boundary condition type - Temperature.

Magnitude: Temperature value. The default is 22o Celsius.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Temperatures are applied using the D command.

• Magnitude (constant, tabular, and function) is always represented as a table in the input file.

Convection
This boundary condition causes convective heat transfer (p. 992) to occur through one or more flat or
curved faces (in contact with a fluid).

The bulk fluid temperature is measured at a distance from the face outside of the thermal boundary
layer. The face temperature refers to the temperature at the face of the simulation model.

Convective Heat Transfer


Convection is related to heat flux by use of Newton's law of cooling:

q/A = h(t s - t f)

where:

• q/A is heat flux out of the face (calculated within the application)

• h is the film coefficient (you provide)

• t s is the temperature on the face (calculated within the application)

• t f is the bulk fluid temperature (you provide)

When the fluid temperature exceeds face temperature, energy flows into a part. When the face temper-
ature exceeds the fluid temperature, a part loses energy.

If you select multiple faces when defining convection, the same bulk fluid temperature and film coefficient
is applied to all selected faces.

Release 2020 R1 - © ANSYS, Inc.


992
Types of Boundary Conditions

Analysis Types
Convection is available for the following analysis types:

• Steady-State Thermal Analysis (p. 344)

• Thermal-Electric Analysis (p. 348)

• Transient Thermal Analysis (p. 397)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported: Plane Stress and Axisymmetric behaviors only.

Geometry Types: Geometry types supported for the Convection boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Convection.

• Body: Supported (3D Only).

• Face: Supported.

• Edge: Supported (2D Only).

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Options:

• Film Coefficient: The film coefficient (also called the heat transfer coefficient or unit thermal conductance)
is based on the composition of the fluid in contact with the face, the geometry of the face, and the hydro-
dynamics of the fluid flow past the face. It is possible to have a time, temperature or spatially dependent
film coefficient. Refer to heat transfer handbooks or other references to obtain appropriate values for film
coefficient.

• Coefficient Type: This field is available when the film coefficient is temperature dependent. Its value can
be evaluated at the average film temperature (average of surface and bulk temperatures), the surface tem-

Release 2020 R1 - © ANSYS, Inc.


993
Setting Up Boundary Conditions

perature, the bulk temperature, or the absolute value of the difference between surface and bulk temperat-
ures.

Note

If you change the units from Celsius to Fahrenheit, or Fahrenheit to Celsius, when the
convection coefficient type Difference between surface and bulk is in use, the displayed
temperature values indicate a temperature difference only. The addition or subtraction of
32o for each temperature in the conversion formula offset one another. In addition,
switching to or from the Difference between surface and bulk Coefficient Type option
from any other option, clears the values in the Convection Coefficient table. This helps
to ensure that you enter correct temperature values.

• Ambient Temperature: The ambient temperature is the temperature of the surrounding fluid. It is possible
to have a time or spatially dependent ambient temperature.

• Convection Matrix: Specifies whether to use a diagonal film coefficient matrix or a consistent film coefficient
matrix. The default setting, Program Controlled, allows the solver to determine whether to use a diagonal
or consistent film coefficient matrix.

• Edit Data For: This field allows you to select and edit Film Coefficient or Ambient Temperature. The
Tabular Data window, details view, graph and graphics view will change based on the selection in the Edit
Data For field. For example, when the Film Coefficient property is specified as Tabular or Function and
Edit Data For is Film Coefficient, you will actively edit data for the Film Coefficient in the appropriate
details view and Tabular Data fields.

• Fluid Flow (available for Steady-State Thermal and Transient Thermal analyses only): Setting this property
to Yes, the default is No, activates convection on one or more thermal fluid line bodies (p. 498). This convection
is input using the Fluid Flow Edge (s) property that defines a Named Selection that is scoped to the edge
or edges of a fluid line body. Convection is accounted for with surface elements SURF151 and SURF152,
which are mapped to the fluid elements using a distance based algorithm.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant.

• Tabular (Time Varying).

• Tabular (Spatially Varying).

• Tabular (Temperature Varying): for Film Coefficient.

• Function (Time Varying).

• Function (Spatially Varying).

Release 2020 R1 - © ANSYS, Inc.


994
Types of Boundary Conditions

You can vary the magnitude of film coefficient and ambient temperature in a single coordinate direction
using either tabular data or a function. See the Defining Boundary Condition Magnitude (p. 1150) section
for the specific steps to apply tabular and/or function loads.

Note

• Scaling based on time is not supported for convection.

• The activate/deactivate (p. 875) option is only available when the Independent Variable property
of the Tabular Data category is set to Time.

Boundary Condition Application


To apply a Convection:

1. On the Environment context toolbar: click Loads>Convection. Or, right-click the Environment tree object
or the Geometry window and select Insert>Convection.

2. Define the Scoping Method.

3. Enter a Film Coefficient for the Convection.

4. Modify the Ambient Temperature as needed.

5. Define the Convection Matrix as Program Controlled (default), Diagonal, or Consistent.

6. Set the Fluid Flow property to Yes if applicable. Select a corresponding Named Selection from the option
or options in the Fluid Flow Edge (s) property drop-down list.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary condition


is applied to a geometry or geometries, which are chosen using a graphical
selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of
geometric entities (for example: 1 Body, 2 Faces) to which the boundary
has been applied using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Se-
lection. This field provides a drop-down list of available user–defined Named
Selections.

Release 2020 R1 - © ANSYS, Inc.


995
Setting Up Boundary Conditions

Category Fields/Options/Description
Definition Type: Read-only field that displays boundary condition type - Convection.

Film Coefficient

Coefficient Type (visible only for temperature dependent Film Coefficient)

Ambient Temperature (not visible if the Fluid Flow property is set to


Yes.)

Convection Matrix:

• Program Controlled (default)

• Diagonal

• Consistent

Edit Data For: this property displays when the Film Coefficient and/or
Ambient Temperature properties are set to Tabular or Function.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Fluid Flow (Steady-State Thermal and Transient Thermal analyses only):


Yes or No.

Fluid Flow Edge (s): drop-down list of edge-based Named Selections.


Function This category displays when the Film Coefficient and/or Ambient Temperature
properties are set to Function. See the Spatial Load and Displacement Function
Data (p. 1155) section of the Help for additional information.
Tabular Data This category displays when the Film Coefficient and/or Ambient Temperature
properties are set to Tabular. See the Spatial Load Tabular Data (p. 1154) section
of the Help for additional information.
Graph Controls This category displays when based upon the specifications made in the
Function and/or Tabular categories. As applicable, see the Spatial Load and
Displacement Function Data (p. 1155) section or the Spatial Load Tabular
Data (p. 1154) section of the Help for additional information.

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Convection loading is applied using the element types SURF152 (3D thermal analyses) and SURF151 (2D
thermal analyses).

• Film Coefficient and Ambient Temperature are applied using the SF command.

• Film Coefficient and Ambient Temperature (constant, tabular, and function) are always represented as
tables in the input file.

Release 2020 R1 - © ANSYS, Inc.


996
Types of Boundary Conditions

• Fluid Flow activates the Mechanical APDL element FLUID116 and specifics TEMP (Temperature) as the degree
of freedom.

Radiation
Applies thermal radiation to a surface of a model (an edge in a 2D model). You can define the exchange
of radiation between a body and the ambient temperature, or between two surfaces.

For thermal related analyses that use the ANSYS solver, the actual calculation of the radiation exchange
between two surfaces is performed using the Radiosity Solver method. The Radiosity Solver method
accounts for the heat exchange between radiating bodies by solving for the outgoing radiative flux for
each surface, when the surface temperatures for all surfaces are known. The surface fluxes provide
boundary conditions to the finite element model for the conduction process analysis in Workbench.
When new surface temperatures are computed, due to either a new time step or iteration cycle, new
surface flux conditions are found by repeating the process. The surface temperatures used in the com-
putation must be uniform over each surface facet to satisfy the conditions of the radiation model.

For models that are entirely symmetrical, you can account for symmetry using Symmetry Regions or
Cyclic Regions. The Radiosity Solver method respects plane or cyclic symmetries. Using a model's sym-
metry can significantly reduce the size of the model. The Radiosity Solver method will take symmetry
into account and the Radiation Probe solution results will be valid for the full model.

Settings for the Radiosity Solver method are available under the Analysis Settings object in the Radi-
osity Controls (p. 889) category.

Related References
See the sections of the Mechanical APDL help listed below for further information related to using the
Radiation load in thermal related analyses that employ the ANSYS solver.

Analysis Types
Radiation is available for the following analysis types:

• Steady-State Thermal Analysis (p. 344)

• Thermal-Electric Analysis (p. 348)

• Transient Thermal Analysis (p. 397)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Radiation boundary condition include:

• Solid: Supported.

Release 2020 R1 - © ANSYS, Inc.


997
Setting Up Boundary Conditions

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Radiation.

• Body: Not Supported.

• Face: Supported - 3D Only.

• Edge: Supported - 2D Only.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying) - for Ambient Temperature: Supported.

• Tabular (Spatially Varying): Not Supported.

• Tabular (Temperature Varying): Supported for Emissivity if Correlation = Surface To Surface.

• Function (Time Varying): Supported.

• Function: Not Supported.

Loading Types and Loading Definition


The unique loading characteristics and definitions for the Radiation boundary condition are described
below.

Ambient Temperature Radiation

When the Correlation property is specified as To Ambient in the Details view of a Radiation object,
all of the radiation energy is assumed to be exchanged with the surroundings at ambient temperature,
1 (p. 1000)
that is, the Form Factor is assumed to be 1.0.

You can set the following additional radiation properties in the Details view:

• Emissivity: The ratio of the radiation emitted by a surface to the radiation emitted by a black body at the
same temperature.

• Ambient Temperature: The temperature of the surrounding space.

Note
1 (p. 1000)
Radiation exchange between surfaces is restricted to gray-diffuse surfaces. Gray implies
that emissivity and absorptivity of the surface do not depend on wavelength (either can
depend on temperature). Diffuse signifies that emissivity and absorptivity do not depend on

Release 2020 R1 - © ANSYS, Inc.


998
Types of Boundary Conditions

direction. For a gray-diffuse surface, emissivity = absorptivity; and emissivity + reflectivity =


1. Note that a black body surface has a unit emissivity.

Surface to Surface Radiation

When the Correlation property is specified as Surface to Surface in the Details view of a Radiation
object, the radiation energy is exchanged between surfaces. In this context, “surface” refers to a face
of a shell or solid body in a 3D model, or an edge in a 2D model. You can then specify Emissivity,
Ambient Temperature (defined above), Enclosure, and the Enclosure Type. Emissivity must be a
positive value that is not greater than 1. Emissivity can also be defined by Tabular Data.

You should assign the same Enclosure number to surfaces radiating to each other 1 (p. 1000) . Specify the
Enclosure Type as either Open (default) or Perfect as suited for a simulation of the closed radiation
problems. Furthermore, closed radiation problems have no dependence on Ambient Temperature so
that property is removed from the Details view during closed problems.

Caution

You cannot apply a Surface to Surface Radiation load to a geometric entity that is already
attached to another Radiation load.

When using the Surface to Surface correlation with shell bodies, the Details view also includes a Shell
Face setting that allows you the choice of applying the load to Both faces, to the Top face only, or to
the Bottom face only.

Boundary Condition Application


To apply a Radiation:

1. On the Environment context toolbar: click Loads>Radiation. Or, right-click the Environment tree object
or the Geometry window and select Insert>Radiation.

2. Define the Scoping Method.

3. Modify the Ambient Temperature as needed.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary condition


is applied to a geometry or geometries, which are chosen using a graphical
selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of
geometric entities (for example: 1 Body, 2 Edges) to which the boundary
has been applied using the selection tools.

Release 2020 R1 - © ANSYS, Inc.


999
Setting Up Boundary Conditions

Category Fields/Options/Description
• Named Selection: Indicates that the geometry selection is defined by a Named
Selection.

– Named Selection: Visible when the Scoping Method is set to Named Se-
lection. This field provides a drop-down list of available user-defined Named
Selections.

Definition Type: Read-only field that displays boundary condition type - Radiation.

Correlation

Emissivity

Ambient Temperature (not visible if Correlation property = Surface to


Surface and the Enclosure Type property = Perfect)

Enclosure (only visible if the Correlation property = Surface to Surface)

Enclosure Type (only visible if the Correlation property = Surface to


Surface)

Note

If a solver error occurs when the Enclosure Type is set to


Perfect, it is recommended that you change the setting
to Open.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


These help sections mention the underlying commands and elements used for implementation of the
feature in the Mechanical APDL application. They are presented for reference only. To implement the
feature in the Mechanical application, you do not need to interact directly with these commands and
elements.

• Thermal Analysis Guide:

– [1] - Definitions

– Using the Radiosity Solver Method

• Mechanical APDL Theory Reference:

– Radiation

– Radiosity Solution Method

• For a perfectly closed system, the VFSM command is employed. Mechanical performs the VFSM,,N,1 com-
mand for this boundary condition with Perfect enclosure number N.

Release 2020 R1 - © ANSYS, Inc.


1000
Types of Boundary Conditions

Heat Flow
Heat Flow is available for 3D simulations and 2D simulations for Plane Stress and Axisymmetric behaviors
only. See the 2D Analyses (p. 502) section of the Help for the required geometry settings for Plane Stress
and Axisymmetric behaviors.

Heat flow simulates the transmission of heat across flat or curved surfaces or edges or across a vertex
or vertices and as a result adds energy to a body over time.

Perfectly Insulated
For a selected face or faces, Heat Flow allows you to specify a Perfectly Insulated load wherein a "no
load" insulated condition is applied to the Face: that is, zero heat flow. An insulated face is a no load
condition meant to override any thermal loads scoped to a body. The heat flow rate is 0 across this
face. This load is useful in a case where most of a model is exposed to a given condition (such a free
air convection) and only a couple of faces do not share this condition (such as the base of a cup that
is grounded). This load overrides thermal loads scoped to a body only. See Resolving Thermal Boundary
Condition Conflicts (p. 1472) for a discussion on thermal load precedence.

Selecting multiple faces insulates all of the faces.

Analysis Types
Heat Flow is available for the following analysis types:

• Steady-State Thermal Analysis (p. 344)

• Thermal-Electric Analysis (p. 348)

• Transient Thermal Analysis (p. 397)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Heat Flow boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Heat Flow.

• Body: Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1001
Setting Up Boundary Conditions

• Face: Supported 3D Only. If you select multiple faces when defining the heat flow rate, the magnitude is ap-
portioned across all selected faces.

• Edge: Supported.

– If you select multiple edges when defining the heat flow rate, the magnitude is apportioned across all
selected edges.

– During 2D analyses, the application does not enable you to apply Heat Flow to edges that share topology.

• Vertex: Supported. If you select multiple vertices when defining the heat flow rate, the magnitude is appor-
tioned among all selected vertices.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying): Supported for face selections in 3D and edge selections in 2D.

• Tabular (Spatially Varying): Not Supported.

• Function (Time Varying): Supported for face selections in 3D and edge selections in 2D.

• Function (Spatially Varying): Not Supported.

Boundary Condition Application


To apply a Heat Flow:

1. On the Environment context toolbar: click Heat>Heat Flow. Or, right-click the Environment tree object
or the Geometry window and select Insert>Heat Flow.

2. Define the Scoping Method and a geometry selection.

3. Enter a Magnitude for the Heat Flow.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary condition is applied
to a geometry or geometries, which are chosen using a graphical selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection. Displays
the type of geometry (Body, Face, etc.) and the number of geometric entities (for
example: 1 Body, 2 Edges) to which the boundary has been applied using the selection
tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

Release 2020 R1 - © ANSYS, Inc.


1002
Types of Boundary Conditions

Category Fields/Options/Description
– Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available user-defined Named Selections.

Definition Type: Read-only field that displays boundary condition type - Heat Flow.

Define As: Heat Flow (default) or Perfectly Insulated. Perfectly Insulated indicates
zero heat flow.

Magnitude: Loading value.

Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Mechanical APDL References and Notes


Convection loading is applied using the element types SURF152 (3D thermal analyses) and SURF151
(2D thermal analyses).

• In a 3D analyses, Heat Flow on face selections are applied using the SF,,HFLUX command on SURF152 ele-
ments. Heat Flow is represented as a table in the input file. Heat Flow applied to a selected edge or vertex
use the F command.

• In a 2D analyses Heat Flow on edge selections are applied using the SF,,HFLUX command on SURF151
elements. Heat Flow is represented as a table in the input file. Heat Flow on vertex selections are applied
using the F command.

Heat Flux
Heat Flux is available for 3D simulations and 2D simulations for Plane Stress and Axisymmetric behaviors
only. See the 2D Analyses (p. 502) section of the Help for the required geometry settings for Plane Stress
and Axisymmetric behaviors.

The Heat Flux boundary condition applies a uniform heat flux to the selected geometry. A positive heat
flux acts into a face or edge, adding energy to a body. Heat flux is defined as energy per unit time per
unit area. If you select multiple faces or edges when defining the heat flux, the same value gets applied
to all selected faces.

Analysis Types
Heat Flux is available for the following analysis types:

• Steady-State Thermal Analysis (p. 344)

• Thermal-Electric Analysis (p. 348)

• Transient Thermal Analysis (p. 397)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

Release 2020 R1 - © ANSYS, Inc.


1003
Setting Up Boundary Conditions

• 3D Simulation: Supported. Body and Face selections only.

• 2D Simulation: Supported. Edge selections only.

Geometry Types: Geometry types supported for the Heat Flux boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Heat Flux.

• Body: Supported - 3D Only.

• Face: Supported.

• Edge: Supported - 2D Only.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying): Supported.

• Tabular (Spatially Varying): Not Supported.

• Function (Time Varying): Supported.

• Function (Spatially Varying): Not Supported.

Boundary Condition Application


To apply a Heat Flux:

1. On the Environment context toolbar: click Heat>Heat Flux. Or, right-click the Environment tree object
or the Geometry window and select Insert>Heat Flux.

2. Define the Scoping Method and a geometry selection.

3. Enter a Magnitude for the Heat Flux.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

Release 2020 R1 - © ANSYS, Inc.


1004
Types of Boundary Conditions

Category Fields/Options/Description
• Geometry Selection: Default setting, indicating that the boundary
condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Se-


lection. Displays the type of geometry (Body, Face, etc.) and the number
of geometric entities (for example: 1 Body, 2 Edges) to which the
boundary has been applied using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user-defined
Named Selections.

Definition Type: Read-only field that displays boundary condition type - Heat
Flux.

Magnitude: Heat flux density value.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Heat Flux is applied using the SF command and SURF152 (3D thermal analyses) and SURF151 (2D thermal
analyses) element types.

• Heat Flux (constant, tabular, and function) is always represented as a table in the input file.

Internal Heat Generation


Available for 3D simulations, and 2D simulations for Plane Stress and Axisymmetric behaviors only. See
the 2D Analyses (p. 502) section of the Help for the required geometry settings for Plane Stress and
Axisymmetric behaviors.

Applies a uniform generation rate internal to a body. A positive heat generation acts into a body, adding
energy to it. Heat generation is defined as energy per unit time per unit volume.

If you select multiple bodies when defining the heat generation, the same value gets applied to all se-
lected bodies. If a body enlarges due to a change in CAD parameters, the total load applied to the body
increases, but the heat generation remains constant.

Note

For each load step, if an Imported Heat Generation load and an Internal Heat Generation
load are applied on common geometry selections, the Imported Heat Generation load takes

Release 2020 R1 - © ANSYS, Inc.


1005
Setting Up Boundary Conditions

precedence. See Activation/Deactivation of Loads (p. 875) for additional rules when multiple
load objects of the same type exist on common geometry selections.

Analysis Types
Internal Heat Generation is available for the following analysis types:

• Steady-State Thermal Analysis (p. 344)

• Thermal-Electric Analysis (p. 348)

• Transient Thermal Analysis (p. 397)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Internal Heat Generation boundary condition
include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Internal Heat Generation.

• Body: Supported.

• Face: Not Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying): Supported.

• Tabular (Spatially Varying): Not Supported.

• Function (Time Varying): Supported.

Release 2020 R1 - © ANSYS, Inc.


1006
Types of Boundary Conditions

• Function (Spatially Varying): Not Supported.

Boundary Condition Application


To apply Internal Heat Generation:

1. On the Environment context toolbar: click Heat>Internal Heat Generation. Or, right-click the Environment
tree object or in the Geometry window and select Insert>Internal Heat Generation.

2. Define the Scoping Method and a geometry selection.

3. Enter a Magnitude value.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Se-


lection. Displays the type of geometry (Body, Face, etc.) and the number
of geometric entities (for example: 1 Body, 2 Edges) to which the
boundary has been applied using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections.

Definition Type: Read-only field that displays boundary condition type - Internal
Heat Generation.

Magnitude

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Heat Generation is applied using the BFE command.

• Heat Generation (constant, tabular, and function) is always represented as a table in the input file.

Release 2020 R1 - © ANSYS, Inc.


1007
Setting Up Boundary Conditions

Mass Flow Rate


Mass Flow Rate is available for 3D simulations and 2D simulations for Plane Stress and Axisymmetric be-
haviors only. See the 2D Analyses (p. 502) section of the Help for the required geometry settings for
Plane Stress and Axisymmetric behaviors.

You apply the Mass Flow Rate boundary condition on the edges of Line Bodies (p. 498) whose Model
Type property is specified as Thermal Fluid. This loading is needed to account for heat distribution
which occurred due to the mass transportation of the fluid (mass/time).

Analysis Types
Mass Flow Rate is available for the following analysis types:

• Steady-State Thermal Analysis (p. 344)

• Transient Thermal Analysis (p. 397)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Mass Flow Rate boundary condition include:

• Solid: Not Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Mass Flow Rate.

• Body: Not Supported.

• Face: Not Supported.

• Edge: Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying): Supported.

• Tabular (Spatially Varying): Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1008
Types of Boundary Conditions

• Function (Time Varying): Supported.

• Function (Spatially Varying): Not Supported.

Boundary Condition Application


To apply Mass Flow Rate:

1. On the Environment context toolbar: click Mass Flow Rate. Or, right-click the Environment tree object
or the Geometry window and select Insert>Mass Flow Rate.

2. Define the Scoping Method and a Geometry Selection or Named Selection.

3. Enter a Magnitude value.

Note

The positive direction for Mass Flow Rate corresponds to the direction of the scoped edge.
If you are scoping multiple edges, turn on the Display Edge Direction option via the View
Menu (p. 64) to display the fluid flow direction of the edges in the Graphics window.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry: Visible when the Scoping Method property is set to Geo-


metry Selection. Displays the type of geometry (Edge) and the number
of geometric entities (for example: 1 Edge, 2 Edges) to which the
boundary has been applied using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method property is set


to Named Selection. This field provides a drop-down list of edge-based
Named Selections that are based on the target line body or line bodies.

Definition Type: Read-only field that displays boundary condition type - Mass
Flow Rate.

Magnitude: speed of the flow.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Release 2020 R1 - © ANSYS, Inc.


1009
Setting Up Boundary Conditions

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Mass Flow Rate is applied using the SFE command directly on FLUID116 elements representing Thermal
Fluid line bodies.

• Mass Flow Rate (constant, tabular, and function) is always represented as a table in the input file.

Voltage
A voltage load simulates the application of an electric potential to a body.

Analysis Types
Voltage is available for the following analysis types:

• Electric Analysis (p. 199)

• Thermal-Electric Analysis (p. 348)

• Magnetostatic Analysis (p. 259)

For each analysis type, you define the voltage by magnitude and phase angle in the Details view, ac-
cording to the following equation.

V = Vocos(ωt+φ)

Vo is the magnitude of the voltage (input value Voltage), ω is the frequency, and φ is the phase angle.
For a static analysis, ωt = 0.

Magnetostatic Analysis Requirements

See Voltage Excitation for Solid Source Conductors (p. 1019).

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Voltage boundary condition include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1010
Types of Boundary Conditions

Topology: The following topology selection options are supported for Voltage.

• Body: Not Supported.

• Face: Supported.

• Edge: Supported.

• Vertex: Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying): Supported.

• Tabular (Spatially Varying): Not Supported.

• Function (Time Varying): Supported.

• Function (Spatially Varying): Not Supported.

Caution

During an Electric/Thermal-Electric Analysis, voltage loads cannot be applied to a face,


edge, or vertex that is shared with another voltage or current load or a Coupling (p. 1105).

Boundary Condition Application


To apply Voltage:

1. On the Environment context toolbar: click Loads>Voltage. Or, right-click the Environment tree object
or the Geometry window and select Insert>Voltage.

2. Define the Scoping Method and a geometry selection.

3. Enter a Magnitude value.

4. Enter a Phase Angle value.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection (default): Default setting, indicating that the


boundary condition is applied to a geometry or geometries, which are
chosen using a graphical selection tools.

Release 2020 R1 - © ANSYS, Inc.


1011
Setting Up Boundary Conditions

Category Fields/Options/Description
– Geometry: Visible when the Scoping Method is set to Geometry Se-
lection. Displays the type of geometry (Body, Face, etc.) and the number
of geometric entities (for example: 1 Body, 2 Edges) to which the
boundary has been applied using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections.

Definition Type: Read-only field that displays boundary condition type - Voltage.

Magnitude

Phase Angle

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Voltages are applied using the D command.

• Magnitude (constant, tabular, and function) is always represented as a table in the input file.

Current
A current load simulates the application of an electric current to a body.

Analysis Types
Current is available for the following analysis types:

• Electric Analysis (p. 199)

• Thermal-Electric Analysis (p. 348)

• Magnetostatic Analysis (p. 259)

For each analysis type, you define the current by magnitude and phase angle in the Details view, ac-
cording to the following equation.

I = Iocos(ωt+φ)

Io is the magnitude of the current (input value Current), ω is the frequency, and φ is the phase angle.
For a static analysis, ωt = 0.

Magnetostatic Analysis Requirements

Release 2020 R1 - © ANSYS, Inc.


1012
Types of Boundary Conditions

See Current Excitation for Solid Source Conductors (p. 1020) and Current Excitation for Stranded Source
Conductors (p. 1022).

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Current boundary condition include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Current.

• Body: Not Supported.

• Face: Supported. An applied current assumes that the body surfaces are equipotential.

• Edge: Supported. An applied current assumes that the edges are equipotential.

• Vertex: Supported.

• Nodes: Not Supported.

Note

• Current loads assume that the scoped entities are equipotential, meaning they behave as elec-
trodes where the voltage degrees of freedom are coupled and solve for a constant potential.

• During an Electric or Thermal Analysis, it is assumed that the material properties of the body
provide conductance. A positive current applied to a face, edge, or vertex flows into the body.
A negative current flows out of the body.

Caution

Current loads cannot be applied to a face, edge, or vertex that is shared with another voltage
or current load or a Coupling (p. 1105).

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying): Supported.

Release 2020 R1 - © ANSYS, Inc.


1013
Setting Up Boundary Conditions

• Tabular (Spatially Varying): Not Supported.

• Function (Time Varying): Supported.

• Function (Spatially Varying): Not Supported.

Boundary Condition Application


To apply Current:

1. On the Environment context toolbar: click Loads>Current. Or, right-click the Environment tree object
or the Geometry window and select Insert>Current.

2. Define the Scoping Method and a geometry selection.

3. Enter a Magnitude value.

4. Enter a Phase Angle value.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method - Options include:

• Geometry Selection (default): Default setting, indicating that the


boundary condition is applied to a geometry or geometries, which are
chosen using a graphical selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Se-


lection. Displays the type of geometry (Body, Face, etc.) and the number
of geometric entities (for example: 1 Body, 2 Edges) to which the
boundary has been applied using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user-defined
Named Selections.

Definition Type: Read-only field that displays boundary condition type - Current.

Magnitude

Phase Angle

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Release 2020 R1 - © ANSYS, Inc.


1014
Types of Boundary Conditions

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Currents are applied using a combination of F,,AMPS and CP,,VOLT commands when used in Magnetostatic
analyses.

• F,,AMPS and CE commands when used in Electric or Thermal-Electric analyses.

• Magnitude (constant, tabular, and function) is always represented as a table in the input file.

Electromagnetic Boundary Conditions and Excitations


You can apply electromagnetic excitations and boundary conditions when performing a Magnetostatic
analysis in the Mechanical application. A boundary condition is considered to be a constraint on the
field domain. An excitation is considered to be a non-zero boundary condition which causes an electric
or magnetic excitation to the system. Boundary conditions are applied to the field domain at exterior
faces. Excitations are applied to conductors.

• Magnetic Flux Boundary Conditions (p. 1015)

• Conductor (p. 1017)

– Solid Source Conductor Body (p. 1017)

→ Voltage Excitation for Solid Source Conductors (p. 1019)

→ Current Excitation for Solid Source Conductors (p. 1020)

– Stranded Source Conductor Body (p. 1021)

→ Current Excitation for Stranded Source Conductors (p. 1022)

Magnetic Flux Boundary Conditions


Available for 3D simulations only.

Magnetic flux boundary conditions impose constraints on the direction of the magnetic flux on a
model boundary. This boundary condition may only be applied to faces. By default, this feature constrains
the flux to be normal to all exterior faces.

Selecting Flux Parallel forces the magnetic flux in a model to flow parallel to the selected face. In the
figure below, the arrows indicate the direction of the magnetic flux. It can be seen that the flux flows
parallel to the xy plane (for any z coordinate).

Release 2020 R1 - © ANSYS, Inc.


1015
Setting Up Boundary Conditions

A flux parallel condition is required on at least one face of the simulation model. It is typically applied
on the outer faces of the air body to contain the magnetic flux inside the simulation domain or on
symmetry plane faces where the flux is known to flow parallel to the face.

To set this feature, right-click the Magnetostatic environment item in the tree and select Magnetic
Flux Parallel from the Insert context menu or click the Magnetic Flux Parallel button in the toolbar.
It can only be applied to geometry faces and Named Selections (faces).

Half-symmetry model of a keepered magnet system. Note that the XY-plane is a Flux Parallel boundary.
The flux arrows flow parallel to the plane.

Release 2020 R1 - © ANSYS, Inc.


1016
Types of Boundary Conditions

Half-symmetry model of a keepered magnet system. Note that the YZ-plane is a Flux Normal boundary.
The flux arrows flow normal to the plane. This is a natural boundary condition and requires no specific-
ation.

Note

Applying the flux parallel boundary conditions to the exterior faces of the air domain may
artificially capture more flux in the simulation domain than what physically occurs. This is
because the simulation model truncates the open air domain. To minimize the effect, ensure
the air domain extends far enough away from the physical structure. Alternatively, the exter-
ior faces of the air domain may be left with an unspecified face boundary condition. An un-
specified exposed exterior face imposes a condition whereby the flux flows normal to the
face. Keep in mind that at least one face in the model must have a flux parallel boundary
condition.

Conductor
Available for 3D simulations only.

A conductor body is characterized as a body that can carry current and possible excitation to the system.

Solid CAD geometry is used to model both solid source conductors and stranded source conductors.
In solid conductors, such as bus bars, rotor cages, etc., the current can distribute non-uniformly due to
geometry changes, hence the program performs a simulation that solves for the currents in the solid
conductor prior to computing the magnetic field.

Stranded source conductors can be used to represent wound coils. Wound coils are used most often
as sources of current excitation for rotating machines, actuators, sensors, etc. You may directly define
a current for each stranded source conductor body.

• Solid Source Conductor Body (p. 1017)

• Stranded Source Conductor Body (p. 1021)

Solid Source Conductor Body

This feature allows you to tag a solid body as a solid source conductor for modeling bus bars, rotor cages,
etc. When assigned as a solid source conductor, additional options are exposed for applying electrical
boundary conditions and excitations to the conductor. These include applying an electrical potential
(voltage) or current.

To set this condition, right-click the Magnetostatic environment object in the tree and select Source
Conductor from the Insert drop-down menu, or click the Source Conductor button in the toolbar.
Select the body you want to designate as a conductor body, then use the Details view to scope the
body to the conductor and set Conductor Type to Solid. The default Number of Turns is 1, representing
a true solid conductor.

A solid source conductor can be used to represent a stranded coil (p. 1021) by setting the Number of
Turns to > 1. The conductor still computes a current distribution according to the physics of a solid
conductor, but in many cases the resulting current density distribution will not significantly affect the
computed magnetic field results. This “shortcut” to modeling a stranded conductor allows you to cir-
cumvent the geometry restrictions imposed by the stranded conductor bodies and still obtain acceptable
results.

Release 2020 R1 - © ANSYS, Inc.


1017
Setting Up Boundary Conditions

After defining the conductor body, you may apply voltage and current conditions to arrive at the desired
state.

Note

Conductors require two material properties: relative permeability and resistivity. They also
must not terminate interior to the model with boundary conditions that would allow current
to enter or exit the conductor. Termination points of a conductor may only exist on a plane
of symmetry.

Only bodies can be scoped to a conductor. Solid conductor bodies must have at least one
voltage excitation and either a second voltage excitation or a current excitation. Also, two
solid conductor bodies may not 'touch' each other, i.e. they must not share vertices, edges,
or faces.

To establish current in the conductor, you must apply excitation to at least two locations on the con-
ductor, typically at terminals. For example, you could:

• apply a voltage drop at two terminals of a conductor body residing at symmetry planes.

Release 2020 R1 - © ANSYS, Inc.


1018
Types of Boundary Conditions

• ground one end of a conductor (set voltage to zero) and apply the net current at the terminal's other
end.

Voltage Excitation for Solid Source Conductors

This feature allows you to apply an electric potential (voltage) to a solid source conductor body. A
voltage excitation is required on a conductor body to establish a ground potential. You may also apply
one to apply a non-zero voltage excitation at another location to initiate current flow. Voltage excitations
may only be applied to faces of the solid source conductor body and can be defined as constant or
time-varying.

To apply a voltage excitation to a solid source conductor body, right-click the Conductor object under
the Magnetostatic environment object in the tree whose Conductor Type is set to Solid, and select
Voltage from the Insert drop-down menu, or click the Voltage button in the toolbar.

You define the voltage by magnitude and phase angle in the Details view, according to the equation
below.

V = Vocos(ωt+ϕ)

Vo is the magnitude of the voltage (input value Voltage), ω is the frequency, and ϕ is the phase angle.
For a static analysis, ωt = 0.

Note

Voltage excitations may only be applied to solid source conductor bodies and at symmetry
planes.

Release 2020 R1 - © ANSYS, Inc.


1019
Setting Up Boundary Conditions

An applied voltage drop across the terminals of a conductor body will induce a current. In this simple
example, the current in the conductor is related to the applied voltage drop, using the equations shown
below. ΔV = applied voltage drop, I = current, ρ = resistivity of the conductor (material property), L =
length of the conductor, and Area = cross section area of the conductor.

ΔV = IR

R = (ρ*L)/Area

Current Excitation for Solid Source Conductors

This feature allows you to apply a current to a solid source conductor (p. 1017) or stranded source con-
ductor (p. 1021) body. Use this feature when you know the amount of current in the conductor.

To apply a current excitation to a conductor body, right-click the Conductor object under the Magneto-
static environment object in the tree whose Conductor Type is set to Solid, and select Current from
the Insert drop-down menu, or click the Current button in the toolbar. A positive current applied to
a face flows into the conductor body. A negative current applied to a face flows out of the conductor
body. For a stranded source conductor, positive current is determined by the y-direction of a local co-
ordinate system assigned to each solid body segment that makes up the conductor.

You define the current by magnitude and phase angle in the Details view, according to the equation
below.

I = Iocos(ωt+ϕ)

Io is the magnitude of the current (input value Current), ω is the frequency, and ϕ is the phase angle.
For a static analysis, ωt = 0.

Note

Current excitations may only be applied to a face of a solid source conductor body at sym-
metry planes. An excitation must be accompanied by a ground potential set at another ter-
mination point of the conductor body on another symmetry plane. No current may be applied
to a conductor body face that is interior to the model domain. The symmetry plane on which
the current excitation is applied must also have a magnetic flux-parallel boundary condition.

Release 2020 R1 - © ANSYS, Inc.


1020
Types of Boundary Conditions

An applied current to a conductor face will calculate and distribute the current within the conductor
body. A ground potential (voltage = 0) must be applied to a termination point of the conductor body.

Both the applied current and voltage constraints must be applied at a symmetry plane.

Stranded Source Conductor Body

This feature allows you to tag solid multiple bodies as a stranded source conductor for modeling wound
coils. When assigned as a stranded source conductor, additional options are exposed for applying
electric boundary conditions and current excitation to the conductor.

Model a stranded source conductor using only isotropic materials and multiple solid bodies. Local co-
ordinate systems assigned to these bodies (via the Details view) are the basis for determining the direction
of the current that you later apply to a stranded source conductor. The model should include a separate
solid body to represent each directional “turn” of the conductor. Assign a local coordinate system to
each body with the positive current direction as the y-direction for each of the local coordinate systems.
An illustration is shown below.

Release 2020 R1 - © ANSYS, Inc.


1021
Setting Up Boundary Conditions

After creating the body segments and assigning coordinate systems, right-click the Magnetostatic en-
vironment object in the tree and select Source Conductor from the Insert drop-down menu, or click
the Source Conductor button in the toolbar. Select all body segments, then scope the bodies to the
conductor and, in the Details view, set Conductor Type to Stranded, then enter the Number of Turns
and the Conducting Area (cross section area of conductor). The stranded conductor is now ready for
you to apply a current. A step-by-step example is presented in the Current Excitation for Stranded
Source Conductors (p. 1022) section.

Note

Conductors require two material properties: relative permeability and resistivity. They also
must not terminate interior to the model with boundary conditions that would allow current
to enter or exit the conductor. Termination points of a conductor may only exist on a plane
of symmetry.

Current Excitation for Stranded Source Conductors

Stranded source conductor bodies are applicable to any magnetic field problem where the source of
excitation comes from a coil. The coil must have a defined number of coil "turns." Stranded source body
geometry is limited to straight geometry or circular arc geometry sections with constant cross-section
(see below)

Source loading for a coil is by a defined current (per turn) and a phase angle according to the equation
below.

Release 2020 R1 - © ANSYS, Inc.


1022
Types of Boundary Conditions

Io is the magnitude of the current (input value Current), ω is the frequency, and ϕ is the phase angle.
For a static analysis, ωt = 0. The direction of the current is determined by the local coordinate systems
you assign to each of the solid bodies that make up the stranded source conductor. A positive or neg-
ative assigned value of current will be with respect to that orientation.

Use the following overall procedure to set up a Stranded Source Conductor and apply a current to
the conductor:

1. Define local coordinate systems that have the y-direction point in the direction of positive current flow.

• Use Cartesian coordinate systems for straight geometry sections and cylindrical coordinate systems for
“arc” geometry sections.

2. Assign a local coordinate system to each stranded source conductor body in the Details view of the body
under the Geometry folder.

3. Right-click the Magnetostatic environment object in the tree and select Source Conductor from the Insert
drop down menu, or click the Source Conductor button in the toolbar.

• Scope the Source Conductor to all of the solid bodies.

• Set Conductor Type to Stranded.

• Enter the Number of Turns and Conducting Area for the conductor.

Release 2020 R1 - © ANSYS, Inc.


1023
Setting Up Boundary Conditions

For the Conducting Area, select a face that represents the conductor's cross-sectional area and
read the surface area that displays in the Status Bar (p. 5) located at the bottom of the screen
display.

The Source Conductor graphic and Details view listing is shown below.

4. Right-click the Conductor object in the tree and select Current from the Insert drop-down menu, or click
the Current button in the toolbar.

• Set Magnitude as constant or time-varying.

• Set Phase Angle.

The Current automatically is scoped to the same bodies as the Source Conductor.

The displayed current arrows give you visual validation that the current direction has been properly
defined by the assigned local coordinate systems for each conductor body.

Changing either the Type of Source Conductor or any coordinate system will invalidate the
setup.

Release 2020 R1 - © ANSYS, Inc.


1024
Types of Boundary Conditions

Motion Load
The application interacts with motion simulation software such as Dynamic Designer™ from MSC, and
MotionWorks from Solid Dynamics. This is not the motion feature that is built into the Mechanical ap-
plication. See the Rigid Dynamics Analysis (p. 263) and Transient Structural Analysis (p. 384) sections for
information on the motion features built into the Mechanical application.

Motion simulation software allows you to define and analyze the motion in an assembly of bodies. One
set of computed results from the motion simulation is forces and moments at the joints between the
bodies in the assembly. See Inserting Motion Loads (p. 1026) for the procedure on inserting these loads.
These loads are available for static structural analyses.

Single Body Capability


Insert Motion Loads is intended to work only with a single body from an assembly. If more than one
body is unsuppressed in the Model during Import, you will receive an error message stating that only
one body should be unsuppressed.

Frame Loads File


The application reads a text file produced by the motion simulation software. This file contains the load
information for a single frame (time step) in the motion simulation. To study multiple frames, create
multiple environment objects for the Model and import each frame to a separate environment. The
frame loads file includes joint forces and inertial forces which "balance" the joint forces and gravity.

Inertial State
If the part of interest is a moving part in the assembly, the frame loads file gives the inertial state of
the body. This includes gravitational acceleration, translational velocity and acceleration, and rotational
velocity and acceleration. Of these inertial "loads" only the rotational velocity is applied in the environ-
ment. The remaining loads are accounted for by solving with inertia relief (see below).

If the part of interest is grounded (not allowed to move) in the motion simulation, corresponding supports
need to be added in the environment before solving.

Joint Loads
For each joint in the motion simulation, the frame loads file reports the force data - moment, force, and
3D location - for the frame. Features are also identified so that the load can be applied to the appropriate
faces, edges, or vertices within the application. These features are identified by the user in the motion
simulation software before exporting the frame loads file. For all non-zero moments and forces, a cor-
responding "Moment" and "Remote Force" are attached to the face(s), edge(s) or vertex(ices) identified
in the frame loads file.

The Remote Force takes into account the moment arm of the force applied to the joint.

Solving with Inertia Relief


Inertia relief is enabled when solving an environment with motion loads. Inertia relief balances the applied
forces and moments by computing the equivalent translational and rotational velocities and accelerations.
Inertia relief gives a more accurate balance than simply applying the inertia loads computed in the
motion simulation.

If Weak Springs are enabled, the computed reaction forces in the weak springs should be negligible.

Release 2020 R1 - © ANSYS, Inc.


1025
Setting Up Boundary Conditions

This option will automatically be turned on if you import any motion loads.

Note

Material properties have to be manually set to match density used in motion analysis.

Modifying Parts with Motion Loads


If you modify a part having a motion load, you should rerun the solution in the motion simulator software
(e.g., Dynamic Designer) and re-export the loads to the Mechanical application. Then, in the Mechanical
application, you must update the geometry, delete the load (from the Environment object) and re-insert
the motion load.

Modifying Loads
You can modify loads that have been inserted, but you should only do so with great care. Modifying
loads in the Mechanical application after importing from the motion simulation software will nullify the
original loading conditions sets in the motion simulation software. Therefore, you need to examine your
results in the Mechanical application carefully.

Inserting Motion Loads


You must make sure the files and data are up to date and consistent when analyzing motion loads. Use
the following procedure to ensure that the correct loads are applied for a given time frame.

To insert motion loads after solving the motion simulation:

1. Advance the motion simulation to the frame of interest.

2. Export the frame loads file from the motion software.

3. Attach the desired geometry.

4. Choose any structural New Analysis type except Rigid Dynamics and Random Vibration.

5. Suppress all bodies except the one of interest.

6. Click the environment object in the tree, then right-click and select Insert> Motion Loads.

7. Select the Frame Load file that you exported from Dynamic Designer.

8. Click Solve. If more than one body is unsuppressed in the Model corresponding to the environment object,
you will receive an error message at the time of solution stating that only one body should be unsuppressed.

9. View the results.

The exported loads depend on the part geometry, the part material properties, and the part's location
relative to the coordinate system in the part document. When any of these factors change, you must
solve the motion simulation again by repeating the full procedure. Verify that material properties such
as density are consistent in the motion simulation and in the material properties.

Insert Motion Loads is intended to work with a single body only. Results with grounded bodies (bodies
not in motion in the mechanism) are not currently supported.

Release 2020 R1 - © ANSYS, Inc.


1026
Types of Boundary Conditions

If an assembly feature (such as a hole) is added after Dynamic Designer generates its Joint attachments
for FEA, the attachments may become invalid. These attachments can be verified by opening the
Properties dialog box for a Joint and selecting the FEA tab. An invalid attachment will have a red "X"
through the icon. To correct this problem, manually redefine the joint attachments using the FEA tab
in the Joint Properties dialog.

A .log file is created when motion loads are imported. This troubleshooting file has the same name
(with an .log extension) and file location as the load file. If the .log file already exists, it is overwritten
by the new file.

Fluid Solid Interface


A Fluid Solid Interface boundary condition is used to identify the interface where the transfer of loads
to and from external fluid solvers CFX or Fluent occur.

Analysis Types
Fluid Solid Interface is available for the following analysis types:

• Harmonic Acoustics (p. 247)

• Modal Acoustics (p. 253)

• Static Structural (p. 339)

• Transient Structural (p. 384)

• Steady-State Thermal Analysis (p. 344)

• Transient Thermal Analysis (p. 397)

Note

• A Static Structural (p. 339) analysis coupled with other physics is intended to work with one substep
(specified in the Analysis Settings). When a Fluid Solid Interface is present, program controlled
sub-stepping will always use one substep regardless of any nonlinearities present. See Steps and
Step Controls for Static and Transient Analyses (p. 914) under the Configuring Analysis Set-
tings (p. 873) section of the Help.

• When one or more FSI loads are present, any components defined in the Mechanical APDL input
file are exported using the CMWRITE command to the file, file.cm, before the solution is
completed. This aids the post-processing of results in CFD-Post.

• There is currently a limitation associated with making a name change to your Fluid Solid Interface
object in Mechanical. The Setup cell on the Project Schematic for System Coupling is not auto-
matically updated. You need to perform an action in the application in order to update the Setup
cell so that it receives the new name.

Mechanical - CFX
Once Fluid Solid Interfaces are identified, loads are transferred to and from body faces in the Mechan-
ical APDL model using the MFX variant of the ANSYS Multi-field solver (see “Chapter 4. Multi-field Ana-
lysis Using Code Coupling” in the Coupled-Field Analysis Guide for details). This solver is accessed from

Release 2020 R1 - © ANSYS, Inc.


1027
Setting Up Boundary Conditions

either the Mechanical APDL Product Launcher or CFX-Solver Manager, and requires both the Mechanical
APDL and CFX input files. To generate the Mechanical APDL input file, select the Solution object folder
in the Mechanical Outline View, and then select Tools> Write Input File. To generate the CFX input
file, use the CFX preprocessor, CFX-Pre.

Run time-monitoring is available in both the Mechanical APDL Product Launcher and CFX-Solver Manager.
Postprocessing of the Mechanical APDL results is available in the Mechanical application, and simultan-
eous postprocessing of both the Mechanical APDL and CFX results is available in the CFX postprocessor,
CFD-Post.

Mechanical Structural - Fluent


Fluid-solid interfaces define the interfaces between the solid or shell elements in the Mechanical system
and the fluid in the Fluent system. These interfaces are defined on faces in the Mechanical model. Data
is exchanged across these interfaces during the execution of the simulation using the System Coup-
ling (p. 445) component of Workbench. System Coupling is the mechanism allowing the Mechanical
application and Fluent to send boundary condition results back and forth to one another (one or two-
way communication is available).

Mechanical’s Static Structural and Transient Structural systems can be coupled with Fluent for a fluid
force and structural displacement analysis, or a fluid-thermal-structural analysis. For more information
about settings and elements needed for the thermal-structural analysis, see Thermal-Fluid-Structural
Analyses using System Coupling.

The integer Interface Number, found in the Details view, is incremented by default each time a new
interface is added. This value can be overridden if desired.

Mechanical Acoustics
Fluid-solid interfaces define the interfaces between the acoustic and the structural regions. These inter-
faces are defined on acoustic regions faces. You can use the contextual (right-click) menu option Create
Automatic > FSI on the environment object to automatically identify fluid solid interfaces.

Mechanical Thermal - Fluent


Fluid-solid interfaces define the interfaces between the thermal solid or shell elements in the Mechan-
ical system and the fluid in the Fluent system. These interfaces are defined on faces in the Mechanical
model. Data is exchanged across these interfaces during the execution of the simulation as described
in Fluid-Structure Interaction (FSI) - One-Way Transfer Using System Coupling (p. 450).

For transferring temperature and heat flows from Mechanical, interfaces may only be defined on the
following types of faces:

• On faces having heat fluxes.

• On faces having convections.

• On faces with a temperature load.

• On faces without any loads specified (adiabatic). In this case, only temperatures are exchanged.

Release 2020 R1 - © ANSYS, Inc.


1028
Types of Boundary Conditions

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Fluid Solid Interface boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Fluid Solid Interface.

• Body: Not Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Boundary Condition Application


To apply a Fluid Solid Interface:

1. On the Environment context toolbar: click Loads>Fluid Solid Interface. Or, right-click the Environment
tree object or the Geometry window and select Insert>Fluid Solid Interface.

2. Define the Scoping Method.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method: Options include:

• Geometry Selection: Default setting, indicating that the boundary condition is applied
to a geometry or geometries, which are chosen using a graphical selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection. Displays
the type of geometry (Body, Face, etc.) and the number of geometric entities (for
example: 1 Body, 2 Edges) to which the boundary has been applied using the selection
tools.

Release 2020 R1 - © ANSYS, Inc.


1029
Setting Up Boundary Conditions

Category Fields/Options/Description
• Named Selection: Indicates that the geometry selection is defined by a Named
Selection.

– Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available user-defined Named Selections.

Definition Type: Read-only field that displays boundary condition type - Fluid Solid Interface.

Interface Number: Incremental value for each new interface. This value can be
overridden if desired.

Export Results: Thermal analyses only. The default value for this property is No.
When this property is set to Yes, thermal data is written to .axdt files for use with
External Data and System Coupling (p. 445), which can connect to Fluent to transfer
thermal data to a CFD analysis for a one-way transfer of static data. The file format
for an External Data File (.axdt) is described in the External Data File Format Help
section in the Workbench User Guide.

Data to Transfer [Expert]: The default for this property is Program Controlled.
When set to All System Coupling Data Transfers, the fluid solid interface regions
can participate in force, displacement, and thermal coupling through System
Coupling. You need to set All System Coupling Data Transfers for Mechanical to
participate in a thermal-structural analysis.

Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Rotating Force
The Rotating Force boundary condition is available for a Full Harmonic Response analysis when the
Coriolis Effect property in the Rotodynamics Controls category of the Analysis Setting is set to On.
The default setting is Off. If the analysis does not specify the Solution Method as Full and the Coriolis
Effect property is not turned on, the boundary condition is not valid.

You specify a Rotating Force as a force rotating synchronously or asynchronously.

The application applies a Rotating Force synchronously with rotational velocity, resulting from mass
magnitude, by setting the Calculated From property to Unbalanced Mass. The application calculates
rotating force by multiplying the unbalanced mass's magnitude to the rotating radius and then mul-
tiplying that value with the rotational velocity.

When you set the Calculated From property to Direct Input, the force is a general harmonic rotating
forces and it can be applied synchronously or asynchronously based on the value of the Synchronous
Ratio property.

See the General Asynchronous Rotating Force and Specific Synchronous Forces: Mass Unbalance topics
of the Harmonic Analysis with Rotating Forces on Rotating Structures section in the Mechanical APDL
Theory Reference for specific technical information.

Tips and Hints


Note the following:

Release 2020 R1 - © ANSYS, Inc.


1030
Types of Boundary Conditions

• The axis of the Rotating Force should coincide with or be aligned with one of the Global Coordinate
(X, Y, or Z) axes.

• You can create either a specific synchronous configuration or a general rotating asynchronous config-
uration, but not a combination of the two. A combination would require that two SYNCHRO commands
be issued on two different components. The Mechanical ANSYS Parametric Design Language
(MAPDL) Solver does not support the use of multiple SYNCHRO commands. The solver overwrites
any existing SYNCHRO definitions when the command is issued.

• A node Hit Point Coordinate (via Graphics Toolbar (p. 70)) is the location where you apply the rotating
force.

• The Hit Point is calculated by projecting the location vector of an unbalanced mass onto the axis of
rotation.

• If the application does not find a Hit Point when you set the Hit Point Selection property to Mesh Node,
try the Remote Point option. That option enables you to define a Remote Point at the desired location.

Note

By default, the application scopes the Rotating Force boundary condition to All Bodies.
This includes connections (i.e., bearings, springs, beams, etc.).

Important

The Rotating Force boundary condition does not support multiple spool or rotor/stator
problems.

Analysis Types
This boundary condition is only available for Harmonic Response (p. 211) analyses using the Full Solution
Method.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types. Geometry types supported for the Rotating Force boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Rotating Force.

Release 2020 R1 - © ANSYS, Inc.


1031
Setting Up Boundary Conditions

• Body: Supported.

• Face: Supported.

• Edge: Supported.

• Vertex: Supported.

• Nodes: Supported (node-based Named Selections only).

Loading Data Definition (p. 1150). The Rotating Force boundary condition is defined as a constant.

Boundary Condition Application


To apply a Rotating Force:

1. On the Environment context toolbar: click Loads>Rotating Force. Or, right-click the Environment tree
object or within the Geometry window and select Insert>Rotating Force.

Note

By default, the application scopes the Rotating Force boundary condition to All Bodies.

2. Define the Rotating Force using Calculated From property. Options include Unbalanced Mass and Direct
Input. The default setting is Unbalanced Mass.

3. Using the properties of the Location category to specify the location of the unbalanced mass or rotating
force.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Define By: a read-only field displaying how the object is scoped - Geometry Se-
lection.

Geometry: a read-only field displaying the geometries that the object is scoped
to - All Bodies.

Axis: specify the rotating axis of the scoped geometry and its direction of rotation.
Location Define By: specify as Coordinates, Geometry Selection, Named Selection, or
Remote Point.

Note

These selections specify the Location property data.

Based on the selection made, the next property is:

• Coordinate System: A drop-down list of available coordinate systems when the Define
By property is set to Coordinates. Otherwise it is read-only.

Release 2020 R1 - © ANSYS, Inc.


1032
Types of Boundary Conditions

Category Fields/Options/Description
• Geometry: Visible when the Define By property is set to Geometry Selection. Displays
the type of geometry and the number of geometric entities (for example: 1 Face, 2
Edges) based on specified Location.

• Named Selection: Visible when the Define By property is set to Named Selection.
This field provides a drop-down list of available user-defined Named Selections.

• Remote Points: Visible when the Define By property is set to Remote Point. This field
provides a drop-down list of available user-defined Remote Points.

X Coordinate: Input field when the Define By property is set to Coordinates.


Otherwise it is read-only.

Y Coordinate: Input field when the Define By property is set to Coordinates.


Otherwise it is read-only.

Z Coordinate: Input field when the Define By property is set to Coordinates.


Otherwise it is read-only.

Location: By default, this property is at the centroid of the scoping specified by


the Define By property.
Definition Type: Read-only field that describes the object - Rotating Force.

Calculated From: Options include Unbalanced Mass (default) and Direct Input.

Mass: Input field when the Calculated From property is set to Unbalanced Mass.

Rotating Radius: This property displays when you set the Calculated From property
to Unbalanced Mass. The Location property automatically updates based on this
field's entries and this field automatically updates based on Location property
entries. This field becomes read-only when the Defined By property is set to
Remote Point.

Unbalanced Force: Visible and read-only when the Calculated From property is
set to Unbalanced Mass. Unbalanced Force = Mass * Rotating Radius.

Synchronous Ratio: Input field when the Calculated From property is set to Direct
Input. The default value is 1.

Magnitude: Input field when the Calculated From property is set to Direct Input.

Phase Angle: Specify a phase shift angle that defines how the load can be out of
phase with another load.

Boundary conditions supported with the Phase Angle property allow you to specify
a phase shift that defines how the loads can be out of phase with one another.
You can specify the preferred unit for phase angle (in fact all angular inputs) to be
degrees or radians using the Units toolbar.

Hit Point Selection: options include Mesh Node (default) and Remote Point.

Remote Point for Hit Point: Visible when the Hit Point Selection property is set
to Remote Point. This field provides a drop-down list of available Remote Points.

Release 2020 R1 - © ANSYS, Inc.


1033
Setting Up Boundary Conditions

Category Fields/Options/Description
Suppressed: Include (No - default) or exclude (Yes) the boundary condition.
Information This category provides read-only information for the following properties:

Hit Points
Hit Point represents a point on the axis where the Rotating Force (F Command)
will be applied. Hit Point coordinates are always coordinates with respect to
Global Coordinate System.

• Hit Point: Node Id: this information property displays the node identifier
at the Hit Point location. It has certain requirements and conditions,
including:

– The Hit Point Selection property needs to be set to Mesh Node

– A valid mesh must be generated.

– A valid node needs to exist at the Hit Point location. If no node is


found, then no information is displayed.

– When the Hit Point Selection property is set to the Remote Point
option, this property requires a valid Remote Point and then displays
the Named Selection created in ds.dat file.

• Hit Point: Location X

• Hit Point: Location Y

• Hit Point: Location Z

Axis Locations
Axis Location coordinates are always with respect to Global Coordinate System.

• Axis Location X

• Axis Location Y

• Axis Location Z

Axis Components
Axis coordinates and Components gives information of where and how the axis
is oriented. Axis Components are always unit vectors with respect to Global
Coordinate System.

• Axis Component X

• Axis Component Y

• Axis Component Z

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

Release 2020 R1 - © ANSYS, Inc.


1034
Types of Boundary Conditions

• The CORIOLIS command is issued to account for gyroscopic damping effect resulted from rotational velocity
defined via CMOMEGA.

• The SYNCHRO command is issued based on specific synchronous/general asynchronous definition of all of
the Rotating Forces.

• The CMOMEGA command is issued based on axis definition of all of the Rotating Forces.

• The F command is applied at Hit Point location based on specific synchronous/general asynchronous
definition of Rotating Force.

Mass Source
A Mass Source excitation is used to create a sound wave.

Guidelines
See Acoustic Mass Source for guidelines in using a Mass Source in an acoustic simulation.

Analysis Types
The Mass Source excitation is only available for a Harmonic Acoustics analysis.

Common Characteristics
This section describes the characteristics of the excitation, including the application requirements,
support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Mass Source excitation include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Mass Source.

• Body: Supported.

• Face: Supported.

• Edge: Supported.

• Vertex: Supported.

• Nodes: Not Supported.

Loading Types: The Mass Source boundary condition’s loading is defined by Magnitude only.

Release 2020 R1 - © ANSYS, Inc.


1035
Setting Up Boundary Conditions

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant

• Tabular (Frequency Varying)

Boundary Condition Application


To apply a Mass Source:

1. On the Environment context toolbar: click Acoustic Excitations>Mass Source. Or, right-click the Envir-
onment tree object or the Geometry window and select Insert>Acoustic>Mass Source.

2. Define the Scoping Method. Options include Geometry Selection (default) and Named Selection. For
either scoping type, you must use the Body selection filter (on the Graphics Toolbar (p. 70)) for geometry
selection or Named Selection definition. Only bodies specified in the acoustics Physics Region(s) can be
selected or defined.

3. Define the Magnitude.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry: Visible when the Scoping Method property is set to


Geometry Selection. Geometry selections must be made on bodies
specified in the acoustic Physics Region (p. 1787).

Use the selection filter to pick your geometry, click in the Geo-
metry field, and then click the Apply button that displays. After
you select the geometry, this property displays the geometric
entities (1 Body, 3 Bodies, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (body-based only).

Definition Type: Read-only field that describes the object - Mass Source.

Release 2020 R1 - © ANSYS, Inc.


1036
Types of Boundary Conditions

Category Fields/Options/Description
Magnitude

Important

Changing the geometry scoping may change the Unit


system used for the Magnitude. For example, the Unit
system for the Magnitude of a Face is whereas
the Unit for an Edge selection is .

Phase Angle

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

MAPDL References and Notes


Acoustic Mass Source is applied using the MASS label of BF command.

Surface Velocity
A Surface Velocity loading condition applies a velocity to a surface on your model.

Guidelines
See Acoustic Surface Velocity for guidelines in using a Surface Velocity in an acoustic simulation.

Analysis Types
The Surface Velocity excitation condition is only available for a Harmonic Acoustics analysis.

Common Characteristics
This section describes the characteristics of the excitation condition, including the application require-
ments, support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Surface Velocity boundary condition include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Surface Velocity.

• Body: Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1037
Setting Up Boundary Conditions

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Types: The boundary condition’s loading is defined using one of the following options.

• Normal To

• Components

Loading Data Definition (p. 1150): Enter loading data as:

• Constant

• Tabular (Frequency Varying)

Boundary Condition Application


To apply a Surface Velocity:

1. On the Environment context toolbar: click Acoustic Excitations>Surface Velocity. Or, right-click the
Environment tree object or the Geometry window and select Insert>Acoustic>Surface Velocity.

2. Define the Scoping Method. Options include Geometry Selection (default) and Named Selection. For
either scoping type, you must use the Body selection filter (on the Graphics Toolbar (p. 70)) for geometry
selection or Named Selection definition. Only bodies specified in the acoustics Physics Region(s) can be
selected or defined.

3. Select the method used to define the load: Normal To (default) or Components.

4. Define the Magnitude.

Note

When you define multiple Surface Velocities there is no cumulative loading effect. Therefore,
if you define multiple Surface Velocities on the same face, only the last Surface Velocity, as
defined in the input file, is used to calculate results.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

Release 2020 R1 - © ANSYS, Inc.


1038
Types of Boundary Conditions

Category Fields/Options/Description
– Geometry (Face selection only): Visible when the Scoping Method
property is set to Geometry Selection. Geometry (Face only) selections
must be made on faces specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.
After you select the geometry, this property displays the
geometric entities (1 Face, 3 Faces, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (body-based only).

Definition Type: Read-only field that describes the object - Surface Velocity.

Define By, options include:

• Normal To: This option requires Magnitude and Phase Angle entries.

• Components: this option defines the loading type as components in the


world coordinate system or a user-defined local coordinate system.
Requires the specification of at least one of the following inputs:

– X Component: Defines magnitude in the X direction.

– Y Component: Defines magnitude in the Y direction.

– Z Component: Defines magnitude in the Z direction.

– X Phase Angle

– Y Phase Angle

– Z Phase Angle

Magnitude

Phase Angle:

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

MAPDL References and Notes


Application of Acoustic Surface Velocity is based on how you define it:

• If Define By = Normal To, the application uses the SHLD label of SF command. This defines surface
normal velocity.

• If Define By = Components, the application uses the VELO label of BF command.

Release 2020 R1 - © ANSYS, Inc.


1039
Setting Up Boundary Conditions

For more information, refer to the Outward Normal Velocity and the Arbitrary Velocity sections in the
Mechanical APDL Acoustic Analysis Guide.

Diffuse Sound Field


You use the Diffuse Sound Field excitation condition to create random excitation waves. The diffuse
sound field is approached by the asymptotic model summing a high number of uncorrelated plane
waves with random phases from all directions in free space. For additional information, see the DFSWAVE
section in the Mechanical APDL Command Reference.

Guidelines
See Diffuse Sound Field for guidelines in using a Diffuse Sound Field in an acoustic simulation.

Analysis Types
The Diffuse Sound Field excitation condition is only available for a Harmonic Acoustics (p. 247) analysis.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Diffuse Sound Field excitation condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Diffuse Sound Field.

• Body: Not Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): The Diffuse Sound Field excitation condition is defined as a constant.

Boundary Condition Application


To apply a Diffuse Sound Field:

Release 2020 R1 - © ANSYS, Inc.


1040
Types of Boundary Conditions

1. On the Environment context toolbar: select Acoustic Excitations > Diffuse Sound Field. Or, right-
click the Environment tree object or click in the Geometry window and select Insert > Acoustics >
Diffuse Sound Field.

2. Define the Scoping Method: options include Geometry Selection (default) and Named Selection.
For either scoping type, you must use the Face selection filter (on the Graphics Toolbar (p. 70)) for
geometry selection or Named Selection definition. Only faces specified in the structural Physics Re-
gion(s) can be selected or defined.

3. Define Coordinate System such that, the +Z axis of the Cartesian coordinate system must be consistent
with the panel’s outward normal unit vector on the panel’s incident diffuse sound field side.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method - Options include:

• Geometry Selection: This is the default setting and indicates that the boundary
condition is applied to a geometry or geometries, you select using a graphical
selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection: This option Indicates that the geometry selection is defined
by a Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available user-defined Named Selections.

Definition Type: Read-only field that displays boundary condition type - Diffuse Sound Field.

Coordinate System: Drop-down list of available coordinate systems. Global


Coordinate System is the default.

Radius of Reference Sphere Define By, the options for this property include:

• Program Controlled: The application selects the Radius automatically.

• User Defined: This option enables you to specify the Radius.

Reference Power Spectral Density: Entry field. The default value is 1 W/Hz.

Maximum Incident Angle: Entry field. The default value is 0°.

Suppressed - Include (No - default) or exclude (Yes) the boundary condition.


Base Medium Material Assignment: Select a material to define material properties (Mass Density
and Speed of Sound) of the Base Medium.

Release 2020 R1 - © ANSYS, Inc.


1041
Setting Up Boundary Conditions

Category Fields/Options/Description
Mass Density: Read-only field whose value is updated based on the selected Ma-
terial Assignment.

Speed of Sound: Read-only field whose value is updates based on the selected
Material Assignment.
Advanced Number of Divisions on the Reference Sphere: Entry field. The default value is
20.

Random Sampling Type: the options for this property include All (default),
Multiple, and Single.

Number of Samplings: Entry field. The default value is 1.

Norm Convergence Tolerance: Entry field. The default value is 0.05.

Frequency of Norm Convergence Check: Entry field. The default value is 5.

Mechanical APDL References and Notes


The Mechanical APDL command DFSWAVE is used to apply the acoustic Diffuse Sound Field excitation
condition. For more information, refer to the Random Excitation with Diffuse Sound Field section in the
Mechanical APDL Acoustic Analysis Guide.

Incident Wave Source


An acoustic Incident Wave Source excitation condition is used to create an incident wave.

Guidelines
See Incident Wave Source for guidelines in using an Incident Wave Source in an acoustic simulation.

Analysis Types
The acoustic Incident Wave Source excitation condition is only available for a Harmonic Acoustics (p. 247)
analysis.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Topology: No topology selection is made for the Incident Wave Source. Its location is defined using
the Source Origin X/Y/Z coordinates.

Loading Data Definition (p. 1150): The Incident Wave Source excitation condition is defined as a constant.

Release 2020 R1 - © ANSYS, Inc.


1042
Types of Boundary Conditions

Boundary Condition Application


To apply an Incident Wave Source:

1. On the Environment context toolbar: select Acoustic Excitations > Incident Wave Source. Or, right-
click the Environment tree object or click in the Geometry window and select Insert > Acoustics >
Incident Wave Source.

2. Define Wave Type, Excitation Type.

3. Define Incident Wave Location. Options include Wave Type other than Planar Wave.

4. Define Pressure Amplitude for Excitation Type = Pressure.

5. Define Velocity Amplitude for Excitation Type = Velocity.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Definition Type: Read-only field that describes the object - Incident Wave Source.

Wave Type: This property provides the following options.

• Planar Wave

• Monopole

• Dipole

• Back Enclosed Loudspeaker

• Bare Loudspeaker

Incident Wave Location: This property provides the following options.

• Outside The Model

• Inside The Model

• Read-only for Wave Type = Planar Wave and selects the Outside The Model
option.

Excitation Type: This property provides the following options.

• Pressure

• Velocity

Specification of the following inputs are required based on Wave Type and Excit-
ation Type.

• Pressure Amplitude: Input available for Excitation Type = Pressure to specify


excitation pressure amplitude.

Release 2020 R1 - © ANSYS, Inc.


1043
Setting Up Boundary Conditions

Category Fields/Options/Description
• Velocity Amplitude: Input available for Excitation Type = Velocity to specify
excitation velocity amplitude.

• Phase Angle: Input to specify the phase angle

• Angle Phi (From X Axis Toward Y Axis): Input available for Wave Type = Planar
Wave.

• Angle Theta (From Z Axis Toward X Axis): Input available for Wave Type =
Planar Wave.

• Radius of Pulsating Sphere: Input available for Wave Type = Monopole, Dipole,
Back Enclosed Loudspeaker, and Bare Loudspeaker

Specification of the following inputs are required for Wave Type = Dipole and
Bare Loudspeaker.

• Dipole Length

• X Component of Unit Dipole Vector

• Y Component of Unit Dipole Vector

• Z Component of Unit Dipole Vector

Calculate Incident Power: This property provides the options No and Yes.

Port Selection: Select a port from drop-down list of available valid ports.

Suppressed: Include (No - default) or exclude (Yes) the boundary condition.


Base Medium Material Assignment: Select a material to define material properties (Mass Density
and Speed of Sound) of the Base Medium.

Mass Density: Read-only field whose value is updated based on the selected Ma-
terial Assignment.

Speed of Sound: Read-only field whose value is updates based on the selected
Material Assignment.
Location When you set Wave Type to either Monopole, Dipole, Back Enclosed
Loudspeaker, and Bare Loudspeaker, define location of wave source using the
following properties:

• Source Origin X: Input field

• Source Origin Y: Input field

• Source Origin Z: Input field

• Source Location: Geometry Selection button

Release 2020 R1 - © ANSYS, Inc.


1044
Types of Boundary Conditions

Mechanical APDL References and Notes


The Mechanical APDL command AWAVE is used to apply the Incident Wave Source excitation condition.
Refer to the Analytic Incident Wave Sources section in the Mechanical APDL Acoustic Analysis Guide for
more information.

Port In Duct
You use the Port In Duct excitation condition is used to create an incident wave and acoustic duct
ports.

Guidelines
See Port In Duct for guidelines in using a Port In Duct in an acoustic simulation.

Analysis Types
The Port In Duct loading condition is available for the Harmonic Acoustics (p. 247) analysis type.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Scoping

The Port In Duct excitation scoped using the Port (p. 1071) object.

Loading Data Definition (p. 1150)

The Port In Duct excitation condition is defined as a constant only.

Boundary Condition Application


To apply a Port In Duct:

1. On the Environment context toolbar: select Acoustic Excitations > Port In Duct. Or, right-click the
Environment tree object or click in the Geometry window and select Insert > Acoustics > Port In
Duct.

2. Define Port Attribution, Wave Type, Coordinate System.

3. Define Pressure Amplitude & Phase Angle

4. Define Width, Height, and Mode indices along width and height for Wave Type = Rectangular Duct

5. Define Radius, and Mode indices along azimuth and radii for Wave Type = Circular Duct

6. Select a Port from the available Ports

Release 2020 R1 - © ANSYS, Inc.


1045
Setting Up Boundary Conditions

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Definition Type: Read-only field that describes the object – Port In Duct.

Port Attribution: This property provides the options Inlet and Outlet.

Wave Type: This property provides the following options.

• Planar Wave

• Rectangular Duct

• Circular Duct

Coordinate System: Drop-down list of available coordinate systems. Global


Coordinate System is the default. The Local Coordinate System should be chosen
such that the cross section of Port in Duct lies in X-Y Plane.

Specification of the following inputs are required based on Wave Type.

• Pressure Amplitude: Input specify excitation pressure amplitude. Only available


for Port Attribution Inlet.

• Phase Angle: Input to specify the phase angle.

• Angle Phi (From X Axis Toward Y Axis): Input available for Wave Type = Planar
Wave.

• Angle Theta (From Z Axis Toward X Axis): Input available for Wave Type =
Planar Wave.

For Wave Type = Rectangular Duct, define the following rectangular duct
properties:

• Width

• Height

• Mode index for pressure variation along the width

• Mode index for pressure variation along the height

For Wave Type = Circular Duct, define the following circular duct properties:

• Radius

• Mode index for pressure variation along the azimuth

• Mode index for pressure variation along the radii

Port Selection: Select a port from drop-down list of available valid ports (The Vibro
option for Port Behavior is supported.

Release 2020 R1 - © ANSYS, Inc.


1046
Types of Boundary Conditions

Category Fields/Options/Description
Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Mechanical APDL References and Notes


The command APORT is used to apply the Acoustic Port In Duct excitation condition. For more inform-
ation, refer to the Specified Mode Excitation in an Acoustic Duct section in the Mechanical APDL
Acoustic Analysis Guide.

Temperature
This boundary condition applies a constant or spatially varying temperature. Geometry selections for
this load must be made on bodies specified in the acoustic Physics Region(s) (p. 1787).

Note

The application does not support data transfer (p. 1879) for this loading condition.

Guidelines
See Temperature for guidelines in using a Temperature in an acoustic simulation.

Analysis Types
The Temperature loading condition is available for the Harmonic Acoustics (p. 247) and Modal Acous-
tics (p. 253) analysis types.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Temperature boundary condition include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Temperature.

• Body: Supported.

• Face: Not Supported.

• Edge: Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1047
Setting Up Boundary Conditions

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Types: The Temperature boundary condition’s loading is defined by Magnitude only.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Spatially Varying): Supported.

• Function (Spatially Varying): Supported.

Boundary Condition Application


To apply a Temperature:

1. On the Environment context toolbar: select Acoustic Loads>Temperature. Or, right-click the Environment
tree object or the Geometry window and select Insert>Acoustics>Temperature.

2. Define the Scoping Method. Options include Geometry Selection (default) and Named Selection. For
either scoping type, you must use the Body selection filter (on the Graphics Toolbar (p. 70)) for geometry
selection or Named Selection definition. Only bodies specified in the acoustics Physics Region(s) can be
selected or defined.

3. Define the Magnitude, Coordinate System, and/or Direction of the thermal boundary condition based
on the above selections.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Body selection only): Visible when the Scoping Method


property is set to Geometry Selection. Geometry (Body only) selections
must be made on bodies specified in the acoustic Physics
Region(s) (p. 1787).

Use the Body selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.
After you select the geometry, this property displays the
geometric entities (1 Body, 3 Bodies, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

Release 2020 R1 - © ANSYS, Inc.


1048
Types of Boundary Conditions

Category Fields/Options/Description
– Named Selection: Visible when the Scoping Method is set to Named
Selection. This field provides a drop-down list of available user–defined
Named Selections (body-based only).

Definition Type: Read-only field that describes the object - Temperature.

Magnitude: Enter a temperature value. The default value is 22°C.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Temperatures are applied using the BF command.

• Magnitude (constant, tabular, and function) is always represented as a table in the input file.

Also see the Non-Uniform Ideal Gas Material section section in the Mechanical APDL Acoustic Analysis
Guide for more information.

Impedance Sheet
You can specify the 2 x 2 transfer admittance matrix with continuous pressure and discontinuous normal
velocity across an acoustic impedance sheet using this object. For additional details, refer to Impedance
Sheet topic in the Mechanical APDL Acoustic Analysis Guide.

Guidelines
See Impedance Sheet for guidelines in using an Impedance Sheet in an acoustic simulation.

Analysis Types
The Impedance Sheet loading condition is available for the Harmonic Acoustics (p. 247) and Modal
Acoustics (p. 253) analysis types.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Impedance Sheet boundary condition include:

• Solid: Supported.

Release 2020 R1 - © ANSYS, Inc.


1049
Setting Up Boundary Conditions

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Impedance Sheet.

• Body: Not Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Types: This boundary condition’s loading is applied as a constant only.

Loading Data Definition (p. 1150): Loading data specified as a constant only.

Boundary Condition Application


To apply a Impedance Sheet:

1. On the Environment context toolbar: click Acoustic Loads>Impedance Sheet. Or, right-click the Envir-
onment tree object or the Geometry window and select Insert>Acoustics>Impedance Sheet.

2. Define the Scoping Method. Options include Geometry Selection (default) and Named Selection. For
either scoping type, you must use the Face selection filter (on the Graphics Toolbar (p. 70)) for geometry
selection or Named Selection definition. Only faces specified in the acoustics Physics Region can be selected
or defined.

3. Define Resistance and Reactance based on the above selections.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Face selection only): Visible when the Scoping Method


property is set to Geometry Selection.

You use this property to specify the face or faces of bodies


specified in the acoustic Physics Region (p. 1787). Use the Face
selection filter to pick your geometry, click in the Geometry
field, and then click the Apply button that displays. After you
select the geometry, this property displays the geometric entities
(1 Face, 3 Faces, etc.).

Release 2020 R1 - © ANSYS, Inc.


1050
Types of Boundary Conditions

Category Fields/Options/Description
• Named Selection: Indicates that the geometry selection is defined by a
Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (face-based only).

Definition Type: Read-only field that describes the object - Impedance Sheet.

Resistance: Specify the resistance. This property can be designated as a


parameter.

Reactance: Specify the reactance. This property can be designated as a


parameter.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

MAPDL References and Notes


The application applies Impedance Sheet using the IMPD label of BF command.

Static Pressure
An Static Pressure load applies a constant pressure to one or more bodies in the acoustic fluid regions.

Note

If both Static Pressure and Temperature are defined, the ideal gas model is activated.

Guidelines
See Static Pressure for guidelines in using a Static Pressure in an acoustic simulation.

Analysis Types
The Static Pressure loading condition is available for the Harmonic Acoustics (p. 247) and Modal
Acoustics (p. 253) analysis types.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Static Pressure boundary condition include:

Release 2020 R1 - © ANSYS, Inc.


1051
Setting Up Boundary Conditions

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Static Pressure.

• Body: Supported.

• Face: Not Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Types: This boundary condition’s loading is only applied to the volume of the selected topology.

Loading Data Definition (p. 1150): Loading data specified as a constant only.

Boundary Condition Application


To apply a Static Pressure:

1. On the Environment context toolbar: click Acoustic Loads>Static Pressure. Or, right-click the Environment
tree object or the Geometry window and select Insert>Acoustics>Static Pressure.

2. Define the Scoping Method. Options include Geometry Selection (default) and Named Selection. For
either scoping type, you must use the Body selection filter (on the Graphics Toolbar (p. 70)) for geometry
selection or Named Selection definition. Only bodies specified in the acoustics Physics Region(s) can be
selected or defined.

3. Define the Magnitude of the pressure.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Body selection only): Visible when the Scoping Method


property is set to Geometry Selection. Geometry (Body only) selections
must be made on bodies specified in the acoustic Physics
Region (p. 1787).

Use the Body selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.

Release 2020 R1 - © ANSYS, Inc.


1052
Types of Boundary Conditions

Category Fields/Options/Description
After you select the geometry, this property displays the
geometric entities (1 Body, 3 Bodies, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (body-based only).

Definition Type: Read-only field that describes the object - Static Pressure.

Magnitude: Enter a constant pressure value.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


Static Pressure is applied using the SPRE label of BF command. Also see the Non-Uniform Ideal Gas
Material section section in the Mechanical APDL Acoustic Analysis Guide for more information.

Pressure
You can specify pressure on desired fluid regions in an acoustic analysis by inserting an Pressure object.

This boundary condition can be scoped only to face/edge/vertex of a body in acoustic domain. Refer
to Pressure Boundary section of Mechanical APDL Acoustic Analysis Guide for more information.

Guidelines
See Pressure for guidelines in using a Pressure in an acoustic simulation.

Analysis Types
The Pressure loading condition is available for the Harmonic Acoustics (p. 247) and Modal Acoustics (p. 253)
analysis types.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Pressure boundary condition include:

• Solid: Supported.

Release 2020 R1 - © ANSYS, Inc.


1053
Setting Up Boundary Conditions

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Pressure.

• Body: Not Supported.

• Face: Supported.

• Edge: Supported.

• Vertex: Supported.

• Nodes: Not Supported.

Loading Types: This boundary condition’s loading is only applied to a vertex, edge, or area of the se-
lected topology.

Loading Data Definition (p. 1150): Loading data specified as a constant only.

Boundary Condition Application


To apply a Pressure:

1. On the Environment context toolbar: click Acoustic Boundary Conditions>Pressure. Or, right-click the
Environment tree object or the Geometry window and select Insert>Acoustics>Pressure.

2. Define the Scoping Method.

3. Define the Magnitude of the pressure.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry: Visible when the Scoping Method property is set to


Geometry Selection. Specified geometric entities must be in the
acoustic Physics Region (p. 1787).

Use the selection filter to pick your geometry, click in the Geo-
metry field, and then click the Apply button that displays. This
property displays the type of geometry (Face, Edge, etc.) and
the number geometric entities (1 Face, 3 Faces, etc.) to which
you have applied the boundary condition.

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

Release 2020 R1 - © ANSYS, Inc.


1054
Types of Boundary Conditions

Category Fields/Options/Description
– Named Selection: Visible when the Scoping Method is set to Named
Selection. This field provides a drop-down list of available user–defined
Named Selections.

Definition Type: Read-only field that describes the object - Pressure.

Magnitude: Enter a constant pressure value.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

MAPDL References and Notes


The Pressure boundary condition is applied using the PRES label of D command.

Impedance Boundary
This boundary condition enables you to specify a complex form of impedance on an acoustic surface.
It requires Resistance, Reactance, and Frequency entries. Refer to the Surface Impedance Boundary
section in the Mechanical APDL Acoustic Analysis Guide for more information.

The application defines complex impedance on a selected surface based on the inputs to the Acoustic
Impedance Boundary using the command: SF,Nlist,IMPD,VALUE,VALUE2.

The application calculates VALUE and VALUE2 using the following impedance and admittance definitions:

Impedance
The equation for Impedance:

where:

Admittance
The equation for Admittance (Y) = Inverse of Impedance:

where:

Release 2020 R1 - © ANSYS, Inc.


1055
Setting Up Boundary Conditions

In Mechanical, you can use Impedance Boundary to define impedance or admittance (Modal Acoustics).
The VALUE and VALUE2 fields for the SF command are based upon the Resistance and Reactance
entries.

Harmonic Acoustics
VALUE = Resistance

VALUE2 = Reactance

Modal Acoustics
If Reactance = 0 (Impedance):

VALUE = Resistance
VALUE2 = 0

If Reactance != 0 (Admittance):

Guidelines
See Impedance Boundary for guidelines in using an Impedance Boundary in an acoustic simulation.

Analysis Types
The Impedance Boundary loading condition is available for the Harmonic Acoustics (p. 247) and Modal
Acoustics (p. 253) analysis types.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Impedance Boundary include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1056
Types of Boundary Conditions

Topology: The following topology selection options are supported for Impedance Boundary.

• Body: Not Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant

• Tabular (Frequency Varying): Supported for Harmonic Acoustics only.

Boundary Condition Application


To apply a Impedance Boundary:

1. On the Environment context toolbar: click Acoustic Boundary Conditions> Impedance Boundary . Or,
right-click the Environment tree object or the Geometry window and select Insert>Acoustics>Impedance
Boundary.

2. Define the Scoping Method.

3. Define the Resistance, Reactance, and Frequency of the Acoustic Impedance Boundary based on the
above selections.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Face selection only): Visible when the Scoping Method


property is set to Geometry Selection. Geometry selections must be
made on bodies specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.
After you select the geometry, this property displays the
geometric entities (1 Face, 3 Faces, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

Release 2020 R1 - © ANSYS, Inc.


1057
Setting Up Boundary Conditions

Category Fields/Options/Description
– Named Selection: Visible when the Scoping Method is set to Named
Selection. This field provides a drop-down list of available user–defined
Named Selections (face-based only).

Definition Type: Read-only field that describes the object - Impedance Boundary.

Resistance: Specify the resistance. This property can be designated as a


parameter.

Reactance: Specify the reactance. This property can be designated as a


parameter.

Frequency (Modal Acoustics): Specify a frequency value. This property is


displayed for Modal Acoustics analyses when the Reactance property is
specified as greater than zero or if it is parameterized. This property can
be designated as a parameter.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

MAPDL References and Notes


Impedance Boundary is applied using the IMPD label of SF command.

Absorption Surface
The Absorption Surface boundary condition enables you to dampen the effect of sound pressure on
the impedance boundary as well as to approximate infinity.

Guidelines
See Absorption Surface for guidelines in using an Absorption Surface in an acoustic simulation.

Analysis Types
The Absorption Surface loading condition is available for the Harmonic Acoustics (p. 247) and Modal
Acoustics (p. 253) analysis types.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Absorption Surface boundary condition include:

• Solid: Supported.

Release 2020 R1 - © ANSYS, Inc.


1058
Types of Boundary Conditions

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Absorption Surface.

• Body: Not Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant

• Tabular (Frequency Varying): Supported for Harmonic Acoustics only.

Boundary Condition Application


To apply a Absorption Surface:

1. On the Environment context toolbar: click Acoustic Boundary Conditions>Absorption Surface. Or,
right-click the Environment tree object or the Geometry window and select Insert>Acoustics Absorption
Surface.

2. Define the Scoping Method.

3. Define an Absorption Coefficient.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Face selection only): Visible when the Scoping Method


property is set to Geometry Selection. Geometry selections must be
made on bodies specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.
After you select the geometry, this property displays the
geometric entities (1 Face, 3 Faces, etc.).

Release 2020 R1 - © ANSYS, Inc.


1059
Setting Up Boundary Conditions

Category Fields/Options/Description
• Named Selection: Indicates that the geometry selection is defined by a
Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (face-based only).

Definition Type: Read-only field that describes the object - Absorption Surface.

Absorption Coefficient

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

MAPDL References and Notes


This boundary condition is applied using the SF command. Refer to the Boundary with Absorption
Coefficient description in the Mechanical APDL Acoustic Analysis Guide for more information.

Radiation Boundary
The Radiation Boundary boundary condition enables you to dampen the effect of sound pressure on
the impedance boundary as well as to approximate infinity.

Guidelines
See Radiation Boundary for guidelines in using a Radiation Boundary in an acoustic simulation.

Analysis Types
The Radiation Boundary loading condition is available for the Harmonic Acoustics (p. 247) and Modal
Acoustics (p. 253) analysis types.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Radiation Boundary boundary condition include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Radiation Boundary.

Release 2020 R1 - © ANSYS, Inc.


1060
Types of Boundary Conditions

• Body: Not Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Boundary Condition Application


To apply a Radiation Boundary:

1. On the Environment context toolbar: click Acoustic Boundary Conditions>Radiation Boundary. Or,
right-click the Environment tree object or the Geometry window and select Insert>Acoustics>Radiation
Boundary.

2. Define the Scoping Method.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Face selection only): Visible when the Scoping Method


property is set to Geometry Selection. Geometry selections must be
made on bodies specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.
After you select the geometry, this property displays the
geometric entities (1 Face, 3 Faces, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (face-based only).

Definition Type: Read-only field that describes the object - Radiation Boundary.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Release 2020 R1 - © ANSYS, Inc.


1061
Setting Up Boundary Conditions

MAPDL References and Notes


This boundary condition is applied using the INF label of SF command. Refer to the Surface Impedance
Boundary section in the Mechanical APDL Acoustic Analysis Guide for more information.

Absorption Element
An exterior acoustics problem typically involves an infinite, homogenous, inviscid fluid surrounding a
given geometric entity. The pressure waves generated by this geometric entity must satisfy the radiation
condition on the surrounding space. To simulate this infinite fluid, you enclose your model with the
Absorption Element boundary condition. This approach truncates the unbounded domain by introducing
a second-order absorbing boundary condition so that an outgoing pressure wave reaching the
boundary of the model is "absorbed" with minimal reflections back into the fluid domain.

Note

• For a 3-D acoustic analysis, the absorbing element must be scoped to an entity that belongs to
a spherical body (whole or partial). For more information, refer to Absorbing Boundary Condition
(ABC) section in the Mechanical APDL Acoustic Analysis Guide.

• Currently, the Absorption Element boundary condition is not supported if you wish to scope it
to an Acoustic region that is defined using frequency dependent material properties. However,
you can resolve this issue by specifying the TBCOPY command using a Commands (p. 1475) object
at the Solution level.

Guidelines
See Absorption Element for guidelines in using an Absorption Element in an acoustic simulation.

Analysis Types
The Absorption Element boundary condition is available for the Harmonic Acoustics (p. 247) and
Modal Acoustics (p. 253) analysis types.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Absorption Element boundary condition include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1062
Types of Boundary Conditions

Topology: The following topology selection options are supported for Absorption Element.

• Body: Not supported.

• Face: Supported (spherical face only).

• Edge: Not supported.

• Vertex: Not supported.

• Nodes: Not supported

Boundary Condition Application


To apply an Absorbing Element:

1. On the Environment context toolbar: click Acoustic Boundary Conditions>Absorption Element. Or,
right-click the Environment tree object or the Geometry window and select Insert>Acoustics>Absorption
Element.

2. Define the Scoping Method.

Note

The application calculates the radius of the sphere internally based upon the geometry
you have selected. Material property requirements are derived based on the assigned
material using the MPCOPY command.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry


Selection. Displays the type of geometry (Face, Edge, etc.) and the
number of geometric entities (for example: 1 Face, 2 Edges) to which
the boundary has been applied using the selection tools.

These geometry selections must be made on bodies specified


in one of the acoustic Physics Regions (p. 1787).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections.

Release 2020 R1 - © ANSYS, Inc.


1063
Setting Up Boundary Conditions

Category Fields/Options/Description
Definition Type: Read-only field that describes the object - Absorption Element.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

MAPDL References and Notes


The Absorption Element is applied using the FLUID130 element.

Free Surface
This boundary condition enables you to specify a plane as a free surface in order to consider sloshing
effects on your model. You should define an Acceleration (p. 923) load as well with Gravitational Accel-
eration values to properly define the sloshing problem.

Note

The free surface must be aligned with the coordinate plane in the Global Cartesian Coordinate
System. The gravitational acceleration input should always be positive regardless of how the
model is set up.

Guidelines
See Free Surface for guidelines in using a Free Surface in an acoustic simulation.

Analysis Types
The Free Surface loading condition is available for the Harmonic Acoustics (p. 247) and Modal Acous-
tics (p. 253) analysis types.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Types Supported

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Free Surface boundary condition include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Free Surface.

• Body: Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1064
Types of Boundary Conditions

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Not applicable.

Boundary Condition Application


To apply a Acoustic Free Surface:

1. On the Environment context toolbar: click Acoustic Boundary Conditions>Free Surface. Or, right-click
the Environment tree object or the Geometry window and select Insert>Acoustics>Free Surface.

2. Define the Scoping Method.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Face selection only): Visible when the Scoping Method


property is set to Geometry Selection. Geometry selections must be
made on bodies specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.
After you select the geometry, this property displays the
geometric entities (1 Face, 3 Faces, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (face-based only).

Definition Type: Read-only field that describes the object - Free Surface.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Release 2020 R1 - © ANSYS, Inc.


1065
Setting Up Boundary Conditions

MAPDL References and Notes


This boundary condition is applied using the FREE label of the SF command. Refer to the Free Surface
(Sloshing Effect) Sources section in the Mechanical APDL Acoustic Analysis Guide for more information.

Thermo-Viscous BLI Boundary


Acoustic waves propagating in viscous-thermal media include a complex propagating constant in the
frequency domain. The attenuation of the acoustic wave is proportional to the shear and bulk viscosity
and the thermal conduction coefficient of the media. The interaction between the viscous fluid and rigid
walls is taken into account using the Thermo-Viscous BLI Boundary condition.

Guidelines
See Thermo-Viscous BLI Boundary for guidelines in using a Thermo-Viscous BLI Boundary in an
acoustic simulation.

Analysis Types
The Thermo-Viscous BLI Boundary loading condition is available for the Harmonic Acoustics (p. 247)
analysis type.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Thermo-Viscous BLI Boundary boundary condition
include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Thermo-Viscous BLI Boundary.

• Body: Not Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Not applicable.

Release 2020 R1 - © ANSYS, Inc.


1066
Types of Boundary Conditions

Boundary Condition Application


To apply an Thermo-Viscous BLI Boundary:

1. On the Environment context toolbar: select Acoustic Boundary Conditions > Thermo-Viscous BLI
Boundary. Or, right-click the Environment tree object or click in the Geometry window and select
Insert > Acoustics > Thermo-Viscous BLI Boundary.

2. Define the Scoping Method.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Face selection only): Visible when the Scoping Method


property is set to Geometry Selection. Geometry selections must be
made on bodies specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.
After you select the geometry, this property displays the
geometric entities (1 Face, 3 Faces, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (face-based only).

Definition Type: Read-only field that describes the object - Thermo-Viscous BLI
Boundary.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


This boundary condition is applied using the BLI label of SF command. For additional information, see
the Boundary Layer Impedance (BLI) Model topic in the Mechanical APDL Acoustic Analysis Guide.

Rigid Wall
This boundary condition enables you to specify a face as rigid wall (Neumann boundary).

Release 2020 R1 - © ANSYS, Inc.


1067
Setting Up Boundary Conditions

Guidelines
See Rigid Wall for guidelines in using a Rigid Wall in an acoustic simulation.

Analysis Types
The Acoustic Rigid Wall loading condition is available for the Harmonic Acoustics (p. 247) analysis type.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Acoustic Rigid Wall boundary condition include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Acoustic Rigid Wall.

• Body: Not Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Not applicable.

Boundary Condition Application


To apply an Rigid Wall:

1. On the Environment context toolbar: select Acoustic Boundary Conditions > Rigid Wall. Or, right-
click the Environment tree object or click in the Geometry window and select Insert > Acoustics >
Rigid Wall.

2. Define the Scoping Method.

Details View Properties


The selections available in the Details view are described below.

Release 2020 R1 - © ANSYS, Inc.


1068
Types of Boundary Conditions

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Face selection only): Visible when the Scoping Method


property is set to Geometry Selection. Geometry selections must be
made on bodies specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.
After you select the geometry, this property displays the
geometric entities (1 Face, 3 Faces, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (face-based only).

Definition Type: Read-only field that describes the object - Acoustic Rigid Wall.

Coordinate System: Drop-down list of available coordinate systems.


Global Coordinate System is the default.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


This excitation condition is applied using RIGW label of the SF command. For more information, refer
to the Rigid Wall Boundary section in the Mechanical APDL Acoustic Analysis Guide.

Symmetry Plane
This boundary condition enables you to define the symmetry plane (Neumann boundary).

Guidelines
See Symmetry Plane for guidelines in using a Symmetry Plane in an acoustic simulation.

Analysis Types
The Acoustic Symmetry Plane loading condition is available for the Harmonic Acoustics (p. 247) analysis
type.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Release 2020 R1 - © ANSYS, Inc.


1069
Setting Up Boundary Conditions

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Symmetry Plane boundary condition include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Symmetry Plane.

• Body: Not Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Not applicable.

Boundary Condition Application


To apply a Symmetry Plane:

1. On the Environment context toolbar: select Acoustic Boundary Conditions > Symmetry Plane. Or,
right-click the Environment tree object or click in the Geometry window and select Insert > Acoustics
> Symmetry Plane.

2. Define the Scoping Method.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Face selection only): Visible when the Scoping Method


property is set to Geometry Selection. Geometry selections must be
made on bodies specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.

Release 2020 R1 - © ANSYS, Inc.


1070
Types of Boundary Conditions

Category Fields/Options/Description
After you select the geometry, this property displays the
geometric entities (1 Face, 3 Faces, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (face-based only).

Definition Type: Read-only field that describes the object - Symmetry Plane.

Coordinate System: Drop-down list of available coordinate systems.


Global Coordinate System is the default.

Symmetry Axis: Read-only field with the setting Normal to Selected


Faces.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


This boundary condition is consumed for far field result calculations. You will not see any change to
the input file if the HFSYM command is used for the Far Field calculation.

Port
An acoustic Port enables you to define an exterior or interior acoustic surface in order to reuse this
surface as an excitation location, a boundary, or a surface on which result are evaluated. For example,
a Port can be used to launch acoustic modes or define transfer admittance (p. 1076) connections.

Guidelines
See Port for guidelines in using a Port in an acoustic simulation.

Analysis Types
The Port loading condition is available for the Harmonic Acoustics (p. 247) analysis type only.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Port boundary condition include:

Release 2020 R1 - © ANSYS, Inc.


1071
Setting Up Boundary Conditions

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Port.

• Body: Not Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): The Port boundary condition is defined as a constant only.

Boundary Condition Application


To apply a Port:

1. On the Environment context toolbar: select Acoustic Boundary Conditions > Port. Or, right-click
the Environment tree object or click in the Geometry window and select Insert > Acoustics > Port.

2. Define the attributes of the Port.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Port Surfaces Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry (Face selection only): Visible when the Scoping Method property is
set to Geometry Selection. Geometry selections must be made on bodies
specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the Geometry
field, and then click the Apply button that displays. After you select the
geometry, this property displays the geometric entities (1 Face, 3 Faces,
etc.).

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available user–defined Named Selections
(face-based only).

Release 2020 R1 - © ANSYS, Inc.


1072
Types of Boundary Conditions

Category Fields/Options/Description
Port Position: Options include On Exterior Face (default) and On Interior Face.
Inside Surface Scoping Method, options include:
Bodies
• Geometry Selection: Default setting, indicating that the boundary condition is
applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry (Body selection only): Visible when the Scoping Method property
is set to Geometry Selection. Geometry selections must be made on bodies
specified in the acoustic Physics Region (p. 1787).

Use the Body selection filter to pick your geometry, click in the Geometry
field, and then click the Apply button that displays. After you select the
geometry, this property displays the geometric entities (1 Body, 3 Bodies,
etc.).

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available user–defined Named Selections
(body-based only).

Definition Type: Read-only field that describes the object – Port.

Port Behavior: Options include Transparent (default) and Vibro.

Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Mechanical APDL References and Notes


This boundary condition is applied using the PORT label of SF (Exterior port) or BF (Interior port)
commands. Refer to the Surface Port section in the Mechanical APDL Acoustic Analysis Guide for more
information.

Far-field Radiation Surface


This boundary condition enables you to define the Maxwell surface for far field parameters.

Guidelines
See Far-field Radiation Surface for guidelines in using a Far-field Radiation Surface in an acoustic
simulation.

Analysis Types
The Acoustic Far-field Radiation Surface loading condition is available for the Harmonic Acoustics (p. 247)
analysis type.

Release 2020 R1 - © ANSYS, Inc.


1073
Setting Up Boundary Conditions

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Far-field Radiation Surface boundary condition
include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Far-field Radiation Surface.

• Body: Supported.

• Face: Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Loading Data Definition (p. 1150): Not applicable.

Boundary Condition Application


To apply an Far-field Radiation Surface:

1. On the Environment context toolbar: select Acoustic Boundary Conditions > Far-field Radiation
Surface. Or, right-click the Environment tree object or click in the Geometry window and select Insert
> Acoustics > Far-field Radiation Surface.

2. Define the Scoping Method.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Equivalent Surface Se- Scoping Method, options include:
lection
• Geometry Selection: Default setting, indicating that the boundary
condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

Release 2020 R1 - © ANSYS, Inc.


1074
Types of Boundary Conditions

Category Fields/Options/Description
– Geometry (Face selection only): Visible when the Scoping Method
property is set to Geometry Selection. Geometry selections must be
made on bodies specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.
After you select the geometry, this property displays the
geometric entities (1 Face, 3 Faces, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (face-based only).

Inside Surface Bodies Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the boundary


condition is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

– Geometry (Face selection only): Visible when the Scoping Method


property is set to Geometry Selection. Geometry selections must be
made on bodies specified in the acoustic Physics Region (p. 1787).

Use the Face selection filter to pick your geometry, click in the
Geometry field, and then click the Apply button that displays.
After you select the geometry, this property displays the
geometric entities (1 Face, 3 Faces, etc.).

• Named Selection: Indicates that the geometry selection is defined by a


Named Selection.

– Named Selection: Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user–defined
Named Selections (face-based only).

Definition Type: Read-only field that describes the object - Far-field Radiation
Surface.

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


This boundary condition is applied using MXWF label of the SF command. For more information, refer
to the Equivalent Surface Source section in the Mechanical APDL Acoustic Analysis Guide.

Release 2020 R1 - © ANSYS, Inc.


1075
Setting Up Boundary Conditions

Transfer Admittance Matrix


This acoustic model enables you to specify a transfer admittance matrix to trim complex perforated
structures. The connection at the interface between the two entities is between two acoustic regions
or a structural and uncoupled acoustic region. The transfer admittance matrix can be specified using
two Ports and if one interface is an FSI interface, then Port 1 is assigned to that interface. For additional
information, see the Trim Element with Transfer Admittance Matrix topic in the Mechanical APDL
Acoustic Analysis Guide.

Guidelines
See Transfer Admittance Matrix for guidelines in using a Transfer Admittance Matrix in an acoustic
simulation.

Analysis Types
Transfer Admittance Matrix is an Acoustics Model that is only available for the Harmonic Acous-
tics (p. 247) analysis type.

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Note

Only Transparent Ports on Exterior Face are allowed in Transfer Admittance Matrix.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Scoping: The Transfer Admittance Matrix is scoped using Port (p. 1071) objects.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant

• Tabular (Frequency Varying): Supported for Harmonic Acoustics only.

Boundary Condition Application


To apply a Transfer Admittance Matrix:

1. On the Environment context toolbar: select Acoustic Models > Transfer Admittance Matrix. Or,
right-click the Environment tree object or click in the Geometry window and select Insert > Acoustics
> Transfer Admittance Matrix.

2. Define the Port1 and Port2 properties.

Release 2020 R1 - © ANSYS, Inc.


1076
Types of Boundary Conditions

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Definition Type: Read-only field that describes the object - Transfer Admittance
Matrix.

Port1

Y11 [Real]

Y11 [Imag]

Y12 [Real]

Y12 [Imag]

Alpha1 [Real]

Alpha1 [Imag]

Port2

Y21 [Real]

Y21 [Imag]

Y22 [Real]

Y22 [Imag]

Alpha2 [Real]

Alpha2 [Imag]

Suppressed: Include (No - default) or exclude (Yes) the boundary


condition.

Mechanical APDL References and Notes


This model is applied using the YMAT label of TB command.

Support Type Boundary Conditions


The boundary conditions contained under the Support heading are listed below.

Fixed Support (p. 1078)

Displacement (p. 1080)

Remote Displacement (p. 1086)

Velocity (p. 1091)

Release 2020 R1 - © ANSYS, Inc.


1077
Setting Up Boundary Conditions

Impedance Boundary - Explicit Dynamics only

Frictionless Face (p. 1093)

Compression Only Support (p. 1095)

Cylindrical Support (p. 1098)

Simply Supported (p. 1099)

Fixed Rotation (p. 1101)

Elastic Support (p. 1103)

Fixed Support
This boundary condition prevents one or more:

• Flat or curved faces from moving or deforming

• Straight or curved edges from moving or deforming.

• Vertices from moving.

Analysis Types
A Fixed Support is available for the following analysis types:

• Explicit Dynamics

• Harmonic Acoustics (p. 247)

• Harmonic Response (p. 211)

• Modal Acoustics (p. 253)

• Modal (p. 227)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported. Fixes one or more faces, edges, or vertices.

• 2D Simulation: Supported. Fixes one or more edges or vertices.

Geometry Types: Geometry types supported for the Fixed Support boundary condition include:

• Solid: Supported.

Release 2020 R1 - © ANSYS, Inc.


1078
Types of Boundary Conditions

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Fixed Support.

• Body: Supported for rigid bodies in an Explicit Analysis.

• Face: Supported.

• Edge: Supported. A fixed edge is not realistic and leads to singular stresses (that is, stresses that approach
infinity near the fixed edge). You should disregard stress and elastic strain values in the vicinity of the fixed
edge.

• Vertex: Supported.

– A fixed vertex fixes both translations and rotations on faces or line bodies.

– A fixed vertex is not realistic and leads to singular stresses (that is, stresses that approach infinity near the
fixed vertex). You should disregard stress and elastic strain values in the vicinity of the fixed vertex.

– This boundary condition cannot be applied to a vertex scoped to an end release (p. 828).

• Nodes: Not Supported.

Note

If you are using a surface body model, see the Simply Supported (p. 1099) boundary condition
section.

Scoping Types: The boundary condition does not require a scoping type because no loading data is
required.

Loading Data Definition (p. 1150): Fixed supports do not have loading data.

Boundary Condition Application


To apply a Fixed Support:

1. On the Environment context toolbar: click Supports>Fixed Support. Or, right-click the Environment
tree object or the Geometry window and select Insert>Fixed Support.

2. Define the Scoping Method.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method: Options include:

• Geometry Selection: Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

Release 2020 R1 - © ANSYS, Inc.


1079
Setting Up Boundary Conditions

Category Fields/Options/Description
– Geometry: Visible when the Scoping Method is set to Geometry Selection.
Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available user-defined Named Selections.

Definition Type: Read-only field that describes the object - Fixed Support.

Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Displacement
Displacements are applied at the geometry level. They require that one or more flat or curved faces or
edges or one or more vertices to displace relative to their original location by one or more components
of a displacement vector in the world coordinate system or local coordinate system, if applied (p. 671).

Displacement as a Base Excitation

Displacement can also be defined as a base excitation during a Mode-Superposition Transient analysis
or a Mode Superposition Harmonic Response analyses. You scope base excitations to a boundary con-
dition. You can scope multiple base excitations to the same boundary condition, but the base excitations
cannot have same direction specified (via the Direction property).

Analysis Types
A Displacement is available for the following analysis types:

• Explicit Dynamics

• Harmonic Acoustics (p. 247)

• Harmonic Response (p. 211)

Note

Full Harmonic Response analyses support non-zero displacements for Component/Com-


ponents: Real - Imaginary loading types.

• Modal (p. 227)

• Modal Acoustics (p. 253)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Release 2020 R1 - © ANSYS, Inc.


1080
Types of Boundary Conditions

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported. Displaces one or more faces, edges, or vertices.

• 2D Simulation: Supported. Displaces one or more edge or vertices.

Geometry Types: Geometry types supported for the Displacement boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Displacement.

• Body: Supported for rigid bodies in an Explicit Analysis.

• Face: Supported.

– Non-zero X-, Y-, and Z-components. The face retains its original shape but moves relative to its original
location by the specified displacement vector. The enforced displacement of the face causes a model to
deform.

– For Zero Y-component, no part of the face can move, rotate, or deform in the Y-direction.

– For blank (undefined) X- and Z-components, the surface is free to move, rotate, and deform in the XZ
plane.

• Edge: Supported.

– Enforced displacement of an edge is not realistic and leads to singular stresses (that is, stresses that ap-
proach infinity near the loaded edge). You should disregard stress and elastic strain values in the vicinity
of the loaded edge.

– Non-zero X-, Y-, and Z-components. The edge retains its original shape but moves relative to its original
location by the specified displacement vector. The enforced displacement of the edge causes a model to
deform.

– For Zero Y-component, no part of the edge can move, rotate, or deform in the Y-direction.

– For blank (undefined) X- and Z-components, the edge is free to move, rotate, and deform in the XZ plane.

• Vertex: Supported.

– Non-zero X-, Y-, and Z-components. The vertex moves relative to its original location by the specified
displacement vector. The enforced displacement of the vertex causes a model to deform.

– For Zero Y-component, the vertex cannot move in the Y-direction.

– For blank (undefined) X- and Z-components, the vertex is free to move in the XZ plane.

Release 2020 R1 - © ANSYS, Inc.


1081
Setting Up Boundary Conditions

– This boundary condition cannot be applied to a vertex scoped to an End Release (p. 828).

• Nodes: Not Supported.

Note

• Multiple surfaces, edges, or vertices can be selected.

• Avoid using multiple Displacements on the same face/edge/vertex and on faces/edges/vertices


having shared faces/edges/vertices.

Loading Types: The boundary condition’s loading is defined using one of the following options.

• Components: Supported.

– Entering a zero for a component prevents deformation in that direction.

– Entering a blank for a component allows free deformation in that direction.

– In a cylindrical coordinate system X, Y, and Z are used for R, Θ, and Z directions. When using a cylindrical
coordinate system, non-zero Y displacements are interpreted as translational displacement quantities,
ΔY = RΔΘ. Since they are treated as linear displacements it is a reasonable approximation only, for small
values of angular motion ΔΘ.

– For Explicit Dynamics analyses, when using a cylindrical coordinate system, the Y component (that is, Θ
direction) of a displacement constraint is defined as a rotation.

• Components: Real - Imaginary. Supported for Harmonic Response Analysis only. Define direct loading
without Phase Angle.

• Normal To: Supported (3D Faces Only).

• Normal To: Real - Imaginary. Supported for Harmonic Response Analysis only. Define direct loading without
Phase Angle.

• Magnitude - Phase. Supported for Displacement as a Base Excitation during Harmonic Response analysis
only.

• Real - Imaginary. Supported for Displacement as a Base Excitation during Harmonic Response analysis only.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying): Supported. (Not supported for Harmonic Response analysis).

• Tabular (Step Varying): Supported for Static Structural analysis only.

• Tabular (Frequency Varying): Supported for Harmonic Response analysis only.

• Tabular (Spatially Varying): Supported (Not Supported for Explicit Dynamics and Harmonic Response
analyses).

• Function (Time Varying): Supported (Not Supported for Harmonic Response analyses).

Release 2020 R1 - © ANSYS, Inc.


1082
Types of Boundary Conditions

• Function (Spatially Varying): Supported (Not Supported for Explicit Dynamics and Harmonic Response
analyses).

• Free: Supported. (Not Supported for Displacement as a Base Excitation).

Note

Solution Restarts (p. 1385) are only supported for Tabular data modifications.

Boundary Condition Application


To apply a Displacement:

1. On the Environment context toolbar: click Supports>Displacement. Or, right-click the Environment tree
object or the Geometry window and select Insert>Displacement.

2. Define the Scoping Method.

3. Select the method used to define the Displacement: Components (default), Components: Real - Imaginary,
Normal To, or Normal To: Real - Imaginary.

4. Define the Coordinate System and displacements or the Distance, of the Displacement based on the
above selections.

5. For Harmonic analyses, specify a Phase Angle as needed.

To apply Displacement as a Base Excitation when the Solver Type property is defined as Mode-Su-
perposition during a Transient (default setting for a Transient configured to a Modal solution) or a
Mode-Superposition Harmonic Response analysis:

1. In the Definition category of the Details view, set the Base Excitation property to Yes.

2. The Boundary Condition property provides a drop-down list of the boundary conditions that corres-
pond to the Displacement. Make a selection from this list. Valid boundary condition option for excit-
ations include:

• Fixed Support

• All Fixed Supports

• Displacement

• Remote Displacement

• Nodal Displacement

• Spring: Body-to-Ground

Release 2020 R1 - © ANSYS, Inc.


1083
Setting Up Boundary Conditions

3. The Absolute Result property is set to Yes by default. As needed, change the value to No if you do
not want to include enforced motion.

Note

If you apply more than one base excitation (either Displacement or Acceleration),
the Absolute Result property needs to have the same setting, either Yes or No.

4. To use complex definition entries, change the Define By property setting to Real - Imaginary from
Magnitude - Phase (default).

5. Define the loading inputs: Magnitude, Phase Angle (only in MSUP Harmonic Response), and Direction.

Note

You can scope Acceleration or Displacement as a base excitation to the same


boundary condition, but the base excitations cannot have same direction spe-
cified (via the Direction property).

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method: options include:

• Geometry Selection: default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry: visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection: indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: visible when the Scoping Method is set to Named Selec-
tion. This field provides a drop-down list of available user-defined Named
Selections.

Boundary Condition (Displacement as a Base Excitation only): drop-down list of


available boundary condition options for application.
Definition Type: read-only field that describes the object - Displacement.

Base Excitation (Displacement as a Base Excitation only): No is the default setting.


Set to Yes to specify the Displacement as a Base Excitation.

Release 2020 R1 - © ANSYS, Inc.


1084
Types of Boundary Conditions

Category Fields/Options/Description
Absolute Result (Displacement as a Base Excitation only): This option allows you
to include enforced motion with (Yes - default) or without (No) base motion.

Define By. options include:

• Normal To: Requires entries for the following:

– Distance. This is the distance of displacement, that is, a magnitude.

– Phase Angle (Harmonic Analysis (p. 211) only)

• Normal To: Real - Imaginary (Harmonic Analysis (p. 211) only): real and imaginary
distance. Requires the specification of the following inputs:

– Distance - Real

– Distance - Imag

• Components: option to define the loading type as Components (in the world
coordinate system or local coordinate system, if applied). Requires the specification
of at least one of the following inputs:

– Coordinate System: drop-down list of available coordinate systems. Global


Coordinate System is the default.

– X Component: Defines magnitude in the X direction.

– Y Component: Defines magnitude in the Y direction.

– Z Component: Defines magnitude in the Z direction.

– X Phase Angle (Harmonic Analysis (p. 211) only)

– Y Phase Angle (Harmonic Analysis (p. 211) only)

– Z Phase Angle (Harmonic Analysis (p. 211) only)

Note

Selection of a Coordinate System rotated out of the global


Cartesian X-Y plane is not supported in a 2D analysis.

• Components: Real - Imaginary (Harmonic Analysis (p. 211) only): option to define
the loading type as real and imaginary components (in the world coordinate
system or local coordinate system, if applied). Requires the specification of at
least one of the following inputs:

– Coordinate System: Drop-down list of available coordinate systems. Global


Coordinate System is the default.

– X Component - Real: Defines magnitude (Real) in the X direction.

Release 2020 R1 - © ANSYS, Inc.


1085
Setting Up Boundary Conditions

Category Fields/Options/Description
– X Component - Imaginary: Defines magnitude (Imaginary) in the X direction.

– Y Component - Real: Defines magnitude (Real) in the Y direction.

– Y Component - Imaginary: Defines magnitude (Imaginary) in the Y direction.

– Z Component - Real: Defines magnitude (Real) in the Z direction.

– Z Component - Imaginary: Defines (Imaginary) magnitude in the Z direction.

• Magnitude - Phase (Displacement as a Base Excitation for Harmonic Response


only): Requires entries for the following:

– Magnitude

– Phase Angle (Harmonic Analysis only)

• Real - Imaginary (Displacement as a Base Excitation for Harmonic Response


only): real and imaginary magnitude. Requires the specification of the following
inputs:

– Magnitude - Real

– Magnitude - Imag

Suppressed: include (No - default) or exclude (Yes) the boundary condition.

Mechanical APDL References and Notes


The following Mechanical APDL commands and considerations are applicable when Displacement is
defined as a base excitation in a Mode Superposition Transient analysis or a Mode Superposition Har-
monic Response analysis.

• Magnitude (constant or tabular) is always represented as a table in the input file.

• Base excitation is defined using the D command under the Modal restart analysis (under Modal analysis
in case of standalone Harmonic Response analysis).

• Base excitation is applied using the DVAL command during a Mode Superposition Transient analysis
or Mode Superposition Harmonic Response analysis.

Note

Displacement can be defined as base excitation in a Modal linked Harmonic Response


and Modal linked Transient analysis only when the upstream Modal analysis Solver
Type (p. 877) is set to Program Controlled (provided program sets solver type internally
to Direct or Supernode) or Direct or Supernode.

Remote Displacement
A Remote Displacement enables you to apply both displacements and rotations at an arbitrary remote
location in space. You specify the origin of the remote location under Scope in the Details view by

Release 2020 R1 - © ANSYS, Inc.


1086
Types of Boundary Conditions

picking, or by entering the XYZ coordinates directly. The default location is at the centroid of the geo-
metry. You specify the displacement and rotation under Definition.

A Remote Displacement is classified as a remote boundary condition. Refer to the Remote Boundary
Conditions (p. 1132) section for a listing of all remote boundary conditions and their characteristics.

Analysis Types
A Remote Displacement is available for the following analysis types:

• Explicit Dynamics

• Harmonic Acoustics (p. 247)

• Harmonic Response (p. 211)

• Modal (p. 227). For a Modal analysis, only zero magnitude Remote Displacement values are valid. These
function as supports. If non-zero magnitude remote displacements are needed for a Pre-Stress Modal ana-
lysis, apply the Remote Displacement in the static structural environment.

• Modal Acoustics (p. 253)

• Static Structural (p. 339)

• Transient Structural (p. 384)

• Rigid Dynamics (p. 263)

A common application is to apply a rotation on a model at a local coordinate system. An example is


shown below along with a plot of the resulting Total Deformation (p. 1226).

Total Deformation Result Example

Release 2020 R1 - © ANSYS, Inc.


1087
Setting Up Boundary Conditions

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Remote Displacement boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Remote Displacement.

• Body: Not Supported.

• Face: Supported.

• Edge: Supported.

• Vertex: Supported. This boundary condition cannot be applied to a vertex scoped to an end release (p. 828).

• Nodes: Not Supported

Loading: This boundary condition's loading in defined in one or more of the following directions.

• X Component

• Y Component

• Z Component

Release 2020 R1 - © ANSYS, Inc.


1088
Types of Boundary Conditions

• X Rotation

• Y Rotation

• Z Rotation

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported.

• Tabular (Time Varying): Supported.

• Tabular (Step Varying): Supported for Static Structural analysis only.

• Function (Time Varying): Supported.

• Free: Supported.

Note

Solution Restarts (p. 1385) are only supported for Tabular data modifications.

Boundary Condition Application


To apply a Remote Displacement:

1. On the Environment context toolbar: click Supports>Remote Displacement. Or, right-click the Environ-
ment tree object or the Geometry window and select Insert>Remote Displacement.

2. Define the Scoping Method.

3. Specify the origin of the remote location or enter the XYZ coordinates. The default location is at the centroid
of the geometry.

4. Specify the translational and rotational displacement components.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method - Options include:

• Geometry Selection: Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

Release 2020 R1 - © ANSYS, Inc.


1089
Setting Up Boundary Conditions

Category Fields/Options/Description
– Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available user-defined Named Selections.

• Remote Point: Indicates that the geometry selection is defined by a Remote


Point.

– Remote Points: Visible when the Scoping Method is set to Remote Point. This
field provides a drop-down list of available user-defined Remote Points.

Coordinate System: Drop-down list of available coordinate systems. Global


Coordinate System is the default.

Z Coordinate

Y Coordinate

X Coordinate

Note

Selection of a Coordinate System rotated out of the global Cartesian


X-Y plane is not supported in a 2D analysis.

Location - The location of a Remote Displacement can be defined in the global


coordinate system or in a local Cartesian coordinate system (p. 671). It is by default
at the centroid of selected geometry.
Definition Type: Read-only field that describes the object - Remote Displacement.

X Component: Defines distance (+/-) in the X direction.

Y Component: Defines distance (+/-) in the Y direction.

Z Component: Defines distance (+/-) in the Z direction.

X Rotation: Defines rotational distance (+/-) in the X direction.

Y Rotation: Defines rotational distance (+/-) in the Y direction.

Z Rotation: Defines rotational distance (+/-) in the Z direction.

Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Behavior (p. 614): Rigid, Deformable, Coupled, or Beam. The Beam option specifies
a connection from the remote load to the model using linear massless beam
elements. If the Scope Method property is set to Remote Point, the boundary
condition will then assume the Behavior defined in the referenced Remote Point
as well as other related properties.

Material: This property is available when the Behavior property is set to Beam.
Select a material to define material properties for the beams used in the connection.
Density is excluded from the material definition.

Release 2020 R1 - © ANSYS, Inc.


1090
Types of Boundary Conditions

Category Fields/Options/Description
Radius: This property is available when the Behavior property is set to Beam.
Specify a radius to define the cross section dimension of the circular beam used
for the connection.
Advanced Pinball Region: Specify the radius of the pinball (length unit). The displacement is
applied to the elements that are within the pinball region.

Velocity
Analysis Types
Velocity is available for the following analysis types:

• Explicit Dynamics - For Explicit Dynamics analyses, the Y Component (that is, Θ direction) of a velocity con-
straint defined with a cylindrical coordinate system has units of angular velocity.

• Transient Structural (p. 384)

Common Characteristics
This section describes the characteristics of the boundary condition, including the application require-
ments, support limitations, and loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Velocity boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Velocity.

• Body: Supported.

• Face: Supported.

• Edge: Supported.

• Vertex: Supported.

– Avoid using multiple velocities on the same vertex.

– This boundary condition cannot be applied to a vertex scoped to an end release (p. 828).

• Nodes: Not Supported.

Loading Types: The boundary condition’s loading is defined using one of the following options.

Release 2020 R1 - © ANSYS, Inc.


1091
Setting Up Boundary Conditions

• Normal To: Supported (3D Faces Only).

• Components: Supported.

– Entering a zero for a component sets the velocity to zero.

– Entering a blank for a component allows free velocity in that direction.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant

• Tabular (Time Varying)

• Function (Time Varying)

• Free

Boundary Condition Application


To apply a Velocity:

1. On the Environment context toolbar: click Supports>Velocity. Or, right-click the Environment tree object
or the Geometry window and select Insert>Velocity.

2. Define the Scoping Method.

3. Select the method used to define the Velocity: Components (default) or Normal To.

4. Define the loading data based on the above selections.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method: Options include:

• Geometry Selection: Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available user-defined Named Selections.

Definition Type: Read-only field that describes the object - Velocity.

Release 2020 R1 - © ANSYS, Inc.


1092
Types of Boundary Conditions

Category Fields/Options/Description
Define By: Options include:

• Normal To: Requires a Magnitude entry.

• Components: Option to define the loading type as Components (in the world
coordinate system or local coordinate system, if applied). Requires the specification
of at least one of the following inputs:

– Coordinate System: Drop-down list of available coordinate systems. Global


Coordinate System is the default.

– X Component: Defines magnitude in the X direction.

– Y Component: Defines magnitude in the Y direction.

– Z Component: Defines magnitude in the Z direction.

Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Frictionless Face
You use this boundary condition to prevent one or more flat or curved faces from moving or deforming
in the normal direction. The normal direction is relative to the selected geometry face. No portion of
the surface body can move, rotate, or deform normal to the face.

For tangential directions, the surface body is free to move, rotate, and deform tangential to the face.

For a flat surface body, the frictionless support is equivalent to a symmetry condition.

Analysis Types
A Frictionless Support is available for the following analysis types:

• Harmonic Acoustics (p. 247)

• Harmonic Response (p. 211)

• Modal (p. 227)

• Modal Acoustics (p. 253)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

Release 2020 R1 - © ANSYS, Inc.


1093
Setting Up Boundary Conditions

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Frictionless Support boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Frictionless Support.

• Body: Not Supported.

• Face: Supported - 3D Only.

• Edge: Supported - 2D Only.

• Vertex: Not Supported.

• Nodes: Not Supported.

Boundary Condition Application


To apply a Frictionless Support:

1. On the Environment context toolbar: click Supports>Frictionless Support. Or, right-click the Environment
tree object or the Geometry window and select Insert>Frictionless Support.

2. Specify Scoping Method and Geometry or Named Selection.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method: Options include:

• Geometry Selection: Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available user-defined Named Selections.

Definition Type: Read-only field that describes the object - Frictionless Support.

Release 2020 R1 - © ANSYS, Inc.


1094
Types of Boundary Conditions

Category Fields/Options/Description
Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Compression Only Support


Applies a compression only constraint normal to one or more faces. It is modeled internally using
Asymmetric rigid-flexible contact. A rigid target surface is constructed and/or mirrored from the scoped
faces/edges of the Compression Only Support. Therefore, the following points should be kept in mind:

• The underlying technology is using penalty-based formulations. As a result, normal contact stiffness can be
an important parameter if nonlinear convergence issues arise. Control normal contact stiffness using the
Normal Stiffness property of the Compression Only Support object.

• Because source and target topologies are perfect mirrors of one another, be careful during nonlinear analyses
to make that contact doesn't "fall off" the target face. Be sure that the contacting area on the rigid body is
large enough to accommodate any potential sliding taking place during the analysis. To avoid this, consider
using a fully fixed rigid body and a nonlinear contact to replace the compression only support.

Consider the following model with a bearing load and supports as shown.

Note the effect of the compression only support in the animation of total deformation.

The following demo is presented as an animated GIF. View online if you are reading the PDF version of the
help. Interface names and other components shown in the demo may differ from those in the released
product.

Release 2020 R1 - © ANSYS, Inc.


1095
Setting Up Boundary Conditions

Since the region of the face in compression is not initially known, a nonlinear solution is required and
may involve a substantial increase in solution time.

Analysis Types
A Compression Only Support is available for the following analysis types:

• Harmonic Acoustics (p. 247)

• Harmonic Response (p. 211)

• Modal (p. 227)

• Modal Acoustics (p. 253)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Compression Only Support boundary condition
include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Compression Only Support.

• Body: Not Supported.

• Face: Supported - 3D Only.

• Edge: Supported - 2D Only.

• Vertex: Not Supported.

• Nodes: Not Supported.

Boundary Condition Application


To apply a Compression Only Support:

Release 2020 R1 - © ANSYS, Inc.


1096
Types of Boundary Conditions

1. On the Environment context toolbar: click Supports>Compression Only Support. Or, right-click the
Environment tree object or the Geometry window and select Insert>Compression Only Support.

2. Specify Scoping Method and Geometry or Named Selection.

3. Specify Normal Stiffness property. If set to Manual, enter a Normal Stiffness Factor value.

4. Specify Update Stiffness property.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method: Options include:

• Geometry Selection: Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Selec-
tion. This field provides a drop-down list of available user-defined Named
Selections.

Definition Type: Read-only field that describes the object - Compression Only Support.

Normal Stiffness: Defines a contact Normal Stiffness factor. Options include:

• Program Controlled: This is the default setting. The Normal Stiffness Factor is
calculated by the program.

• Manual: The Normal Stiffness Factor is input directly by the user. The Normal
Stiffness Factor property displays for this setting.

Update Stiffness: Specify if the program should update (change) the contact
stiffness during the solution. Options include:

• Never: This is the default setting. Turns off the program's automatic Update Stiffness
feature.

• Each Iteration: Sets the program to update stiffness at the end of each equilibrium
iteration.

• Each Iteration, Aggressive: Sets the program to update stiffness at the end of each
equilibrium iteration, but compared to the option, Each Iteration, this option allows
for a more aggressive changing of the value range.

Release 2020 R1 - © ANSYS, Inc.


1097
Setting Up Boundary Conditions

Category Fields/Options/Description
Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Cylindrical Support
For 3D simulations, this boundary condition prevents one or more cylindrical faces from moving or
deforming in combinations of radial, axial, or tangential directions. Any combination of fixed and free
radial, axial, and tangential settings are allowed.

Analysis Types
A Cylindrical Support is available for the following analysis types:

• Harmonic Acoustics (p. 247)

• Harmonic Response (p. 211)

• Modal (p. 227)

• Modal Acoustics (p. 253)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported. Cylindrical supports can only be applied to circular edges

Geometry Types: Geometry types supported for the Cylindrical Support boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Cylindrical Support.

• Body: Not Supported.

• Face: Supported - 3D Cylindrical Face Only.

• Edge: Supported - 2D Circular Edge Only.

• Vertex: Not Supported.

• Nodes: Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1098
Types of Boundary Conditions

Boundary Condition Application


To apply a Cylindrical Support:

1. On the Environment context toolbar: click Supports>Cylindrical Support. Or, right-click the Environment
tree object or the Geometry window and select Insert>Cylindrical Support.

2. Specify Scoping Method and Geometry or Named Selection.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method: Options include:

• Geometry Selection: Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available user-defined Named Selections.

Definition Type: Read-only field that describes the object - Cylindrical Support.

Radial: Fixed (default) or Free.

Axial (3D Only): Fixed (default) or Free.

Tangential: Fixed (default) or Free.

Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Simply Supported
Available for 3D simulations only.

This boundary condition prevents one or more straight or curved edges or a vertex or vertices from
moving or deforming. However, rotations are allowed. If you want to fix the rotations as well, use the
Fixed Support (p. 1078) boundary condition. It is applicable for surface body models or line models only.

Analysis Types
A Simply Supported is available for the following analysis types:

• Harmonic Response (p. 211)

Release 2020 R1 - © ANSYS, Inc.


1099
Setting Up Boundary Conditions

• Modal (p. 227)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Simply Supported boundary condition include:

• Solid: Not Supported.

• Surface/Shell: Supported - Surface Only.

• Wire Body/Line Body/Beam: Supported - Line Only.

Topology: The following topology selection options are supported for Simply Supported.

• Body: Not Supported.

• Face: Not Supported.

• Edge: Supported.

• Vertex: Supported. This boundary condition cannot be applied to a vertex scoped to an End Release (p. 828).
In addition, a simply supported vertex is not realistic and leads to singular stresses (that is, stresses that ap-
proach infinity near the simply supported vertex). You should disregard stress and elastic strain values in
the vicinity of the simply supported vertex.

• Nodes: Not Supported.

Boundary Condition Application


To apply a Simply Supported:

1. On the Environment context toolbar: click Supports>Simply Supported. Or, right-click the Environment
tree object or the Geometry window and select Insert>Simply Supported.

2. Specify Scoping Method and Geometry or Named Selection.

Details View Properties


The selections available in the Details view are described below.

Release 2020 R1 - © ANSYS, Inc.


1100
Types of Boundary Conditions

Category Fields/Options/Description
Scope Scoping Method: Options include:

• Geometry Selection: Default setting, indicating that the boundary condition


is applied to a geometry or geometries, which are chosen using a graphical
selection tools.

– Geometry: Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection: Visible when the Scoping Method is set to Named Selec-
tion. This field provides a drop-down list of available user-defined Named
Selections.

Definition Type: Read-only field that describes the object - Simply Supported.

Suppressed: Include (No - default) or exclude (Yes) the boundary condition.

Fixed Rotation
You can apply a Fixed Rotation boundary condition to faces, edges, and vertices of a surface body.
When you only apply a fixed rotation support to a surface body, the geometry is free in all translational
directions. However, by default, the rotation of the geometry is fixed about the axes of the corresponding
coordinate system.

Note

• Rotation constraints are combined with other constraints that produce rotational DOF as-
signments to determine which values to apply. They are combined with all other constraints
to determine the Nodal Coordinate System orientation (frictionless supports, cylindrical
supports, given displacements, etc.).

• There may be circumstances in which the rotational support and other constraints cannot
resolve a discrepancy for preference of a particular node’s coordinate system.

Analysis Types
A Fixed Rotation is available for the following analysis types:

• Harmonic Response (p. 211)

• Explicit Dynamics

• Modal (p. 227)

• Static Structural (p. 339)

Release 2020 R1 - © ANSYS, Inc.


1101
Setting Up Boundary Conditions

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Fixed Rotation boundary condition include:

• Solid: Not Supported.

• Surface/Shell: Supported - Surface Body only.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Fixed Rotation.

• Body: Not Supported.

• Face: Supported.

• Edge: Supported.

• Vertex: Supported.

– A fixed vertex rotation support is not realistic and leads to singular stresses (that is, stresses that approach
infinity near the fixed vertex rotation support). You should disregard stress and elastic strain values in the
vicinity of the fixed vertex rotation support.

– This boundary condition cannot be applied to a vertex scoped to an end release (p. 828).

• Nodes: Not Supported.

Boundary Condition Application


To apply a Fixed Rotation:

• In the Details view, select Free or Fixed for Rotation X, Rotation Y, and Rotation Z to define the fixed
rotation support.

1. On the Environment context toolbar: click Supports>Fixed Rotation. Or, right-click the Environment
tree object or the Geometry window and select Insert>Fixed Rotation.

2. Specify Scoping Method and Geometry or Named Selection.

3. As needed, specify the coordinate system for the corresponding rotational constraint.

4. Define the rotational axes as Fixed (default) or Free.

Release 2020 R1 - © ANSYS, Inc.


1102
Types of Boundary Conditions

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method - Options include:

• Geometry Selection - Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry - Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection - Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection - Visible when the Scoping Method is set to Named Selec-
tion. This field provides a drop-down list of available user-defined Named
Selections.

Definition Type - Read-only field that describes the object - Fixed Rotation.

Coordinate System - Drop-down list of available coordinate systems. Global


Coordinate System is the default.

Rotation X - Fixed (default) or Free.

Rotation Y - Fixed (default) or Free.

Rotation Z - Fixed (default) or Free.

Suppressed - Include (No - default) or exclude (Yes) the boundary condition.

Caution

When parameterizing this boundary condition, a Free axis of rotation


is represented by a one (1) and Fixed with a value of zero (0) inside the
Parameter tab in ANSYS Workbench (outside of Mechanical). Entering
any value other than 0 or 1 causes the application to produce
unexpected results.

Elastic Support
Allows one or more faces (3D) or edges (2D) to move or deform according to a spring behavior. The
Elastic Support is based on a Foundation Stiffness set in the Details view, which is defined as the
pressure required to produce a unit normal deflection of the foundation.

Release 2020 R1 - © ANSYS, Inc.


1103
Setting Up Boundary Conditions

Analysis Types
An Elastic Support is available for the following analysis types:

• Harmonic Acoustics (p. 247)

• Harmonic Response (p. 211)

• Modal (p. 227)

• Modal Acoustics (p. 253)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Elastic Support boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Not Supported

Topology: The following topology selection options are supported for Elastic Support.

• Body: Not Supported.

• Face: Supported.

• Edge: Supported - 2D Only.

• Vertex: Not Supported.

• Nodes: Not Supported.

Boundary Condition Application


To apply an Elastic Support:

1. On the Environment context toolbar: click Supports>Elastic Support. Or, right-click the Environment
tree object or the Geometry window and select Insert>Elastic Support.

2. Specify Scoping Method and Geometry or Named Selection.

Release 2020 R1 - © ANSYS, Inc.


1104
Types of Boundary Conditions

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method - Options include:

• Geometry Selection - Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry - Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection - Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection - Visible when the Scoping Method is set to Named Selec-
tion. This field provides a drop-down list of available user–defined Named
Selections.

Definition Type - Read-only field that describes the object - Elastic Support.

Suppressed - Include (No - default) or exclude (Yes) the boundary condition.

Foundation Stiffness

Conditions Type Boundary Conditions


The boundary conditions contained under the Conditions heading are listed below.

• Coupling (p. 1105)

• Constraint Equation (p. 1107)

• Pipe Idealization (p. 1109)

• Nonlinear Adaptive Region (p. 1112)

Coupling
While setting up a model for analysis, you can establish relationships among the different degrees of
freedom of the model by physically modeling the part or a contact condition. However, sometimes
there is a need to be able to model distinctive features of a geometry (for example, models that have
equipotential surfaces) which cannot be adequately described with the physical part or contact. In this
instance, you can create a set of surfaces/edges/vertices which have a coupled degree of freedom by
using the Coupling boundary condition.

Coupling the degrees of freedom of a set of geometric entity constrains the results calculated for one
member of the set to be the same for all members of the set.

Release 2020 R1 - © ANSYS, Inc.


1105
Setting Up Boundary Conditions

Analysis Types
Coupling is available for the following analysis types:

• Electric Analysis (p. 199)

• Steady-State Thermal Analysis (p. 344)

• Transient Thermal Analysis (p. 397)

• Thermal-Electric Analysis (p. 348)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported. Apply to one or more faces or edges or at least two vertices.

• 2D Simulation: Supported. Apply to one or more edges or at least two vertices.

Geometry Types: Geometry types supported for the Coupling boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The following topology selection options are supported for Coupling.

• Body: Not Supported.

• Face: Supported 3D Only.

• Edge: Supported.

• Vertex: Supported.

• Nodes: Not Supported.

Boundary Condition Application


To apply a Coupling boundary condition:

1. On the Environment context toolbar: click Conditions>Coupling. Or, right-click the Environment tree
object or the Geometry window and select Insert>Coupling.

2. Define the Scoping Method.

Restrictions

Make sure that you meet the following restrictions when scoping Coupling.

Release 2020 R1 - © ANSYS, Inc.


1106
Types of Boundary Conditions

• You cannot specify more than one Coupling (the same DOF) on the same geometric entity, such as two
edges sharing a common vertex or two faces sharing a common edge.

• Coupling should not be applied to a geometric entity that also has a constraint applied to it.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method - Options include:

• Geometry Selection - Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry - Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection - Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection - Visible when the Scoping Method is set to Named Selec-
tion. This field provides a drop-down list of available user–defined Named
Selections.

Definition DOF Selection - For a Thermal-Electric analysis, select either Temperature or


Voltage, otherwise this is a read-only field displaying the DOF selection type.

Suppressed - Include (No - default) or exclude (Yes) the boundary condition.

Mechanical APDL References and Notes


Coupling is achieved through the use of the CE command.

Constraint Equation
This feature allows you to relate the motion of different portions of a model through the use of an
equation. The equation relates the degrees of freedom (DOF) of one or more Remote Points (p. 609) for
Harmonic, Harmonic Acoustics, Modal, Modal (Samcef), Static Structural, Static Structural (Samcef),
or Transient Structural systems, or one or more joints for the ANSYS Rigid Dynamics solver.

For example, the motion along the X direction of one remote point (Remote Point A) could be made
to follow the motion of another remote point (Remote Point B) along the Z direction by:

0 = [1/mm ∙ Remote Point A (X Displacement)] - [1/mm ∙ Remote Point B (Z Displacement)]

The equation is a linear combination of the DOF values. Thus, each term in the equation is defined by
a coefficient followed by a node (Remote Point) and a degree of freedom label. Summation of the linear
combination may be set to a non-zero value. For example:

7 = [4.1/mm ∙ Remote Point A (X Displacement)] + [1/rad ∙ Remote Vertex(Rotation Z)]

Release 2020 R1 - © ANSYS, Inc.


1107
Setting Up Boundary Conditions

Similarly, for the ANSYS Rigid Dynamics solver, to make the rotational velocity of gear A (Revolute A)
to follow the rotational velocity of gear B (Revolute B), in the Z direction, the following constraint
equation should be written:

0 = [1/rad ∙ Revolute A (Omega Z)] - [1/rad ∙ Revolute B (Omega Z)]

This equation is a linear combination of the Joints DOF values. Thus, each term in the equation is defined
by a coefficient followed by a joint and a degree of freedom label. Summation of the linear combination
may be set to a non-zero value. For example:

7 = [4.1/mm ∙ Joint A (X Velocity)] + [1/rad ∙ Joint B (Omega Z)]

Note that the Joints DOF can be expressed in terms of velocities or accelerations. However, all terms
in the equation will be based on the same nature of degrees of freedom, that is, all velocities or all ac-
celerations.

To apply a constraint equation support:

1. Insert a Constraint Equation object by:

a. Selecting Constraint Equation from the Conditions drop-down menu.

Or...

b. Right-clicking on the environment object and selecting Insert> Constraint Equation.

2. In the Details view, enter a constant value that will represent one side of the constraint equation. The default
constant value is zero.

3. In the Worksheet, right-click in the first row and choose Add, then enter data to represent the opposite
side of the equation. For the first term of the equation, enter a value for the Coefficient, then select entries
for Remote Point or Joint and DOF Selection. Add a row and enter similar data for each subsequent term
of the equation. The resulting equation displays as you enter the data.

Using the example presented above, a constant value of 7 is entered into the Details view, and the
data shown in the table is entered in the Worksheet.

Note

For Harmonic, Modal, Static Structural, and Transient Structural systems, the first unique
degree of freedom in the equation is eliminated in terms of all other degrees of freedom in
the equation. A unique degree of freedom is one which is not specified in any other constraint
equation, coupled node set, specified displacement set, or master degree of freedom set.
You should make the first term of the equation be the degree of freedom to be eliminated.

Release 2020 R1 - © ANSYS, Inc.


1108
Types of Boundary Conditions

Although you may, in theory, specify the same degree of freedom in more than one equation,
you must be careful to avoid over-specification.

Constraint Equation Characteristics


• In the Worksheet, you can insert rows, modify an existing row, or delete a row.

• A local coordinate system is defined in each remote point that is used.

• The constant term is treated as a value with no unit of measure.

• Coefficients for X Displacement, Y Displacement, Z Displacement, X Velocity, Y Velocity, Z Velocity, X Accel-


eration, Y Acceleration, and Z Acceleration have a unit of 1/length.

• Coefficients for Rotation X, Rotation Y, Rotation Z, Omega X, Omega Y, Omega Z, Omega Dot X, Omega Dot
Y, and Omega Dot Z have a unit of 1/angle. Note that in a velocity based constraint equation, coefficients
use angle units and not rotational velocity units.

• If you change a DOF such that the unit type of a coefficient also changes (for example, rotation to displace-
ment, or vice versa), then the coefficient resets to 0.

• You can parameterize the constant value entered in the Details view.

• The state for the Constraint Equation object will be under-defined (? in the tree) under the following cir-
cumstances:

– There are no rows with valid selections.

– Remote Points being used are underdefined or suppressed.

– Joints being used are underdefined or suppressed.

– The analysis type does not support this feature.

– The selected DOFs are invalid for the analysis (2D versus 3D, or remote point versus joints DOFs).

• The graphic user interface does not check for overconstraint.

Pipe Idealization
Pipe Idealization is a (boundary) condition used to model pipes that have cross-section distortion. This
is common for curved pipe structures under loading. It is related to the mesh and acts much like a mesh
control. Pipe elements are created by meshing lines or curves.

Prerequisites
1. In the Line Body’s (Geometry Object) Details view Definition category, the Model Type option must be set
to Pipe.

2. The scoped line-body must be meshed with higher order elements. This means that the Element Order
option under the Defaults group of the Mesh Object must be set to Quadratic. If not, the solver reports
an error.

Release 2020 R1 - © ANSYS, Inc.


1109
Setting Up Boundary Conditions

Extend Elbow Elements


You can extend the elbow elements to adjacent edges within the same body in order to reduce the
boundary effects caused by the incompatible section deformation between edges modeled as straight
pipes and high deformation pipes (elbows). If you do not want to extend the elements, under the Extend
to Adjacent Elements section of the Details panel set Extend to No. To extend the elements, set Extend
to Factor. You can then enter a Factor value, which will extend the elements to the adjacent edge up
to a length of factor times selected pipe diameter. If the length calculated by factor times pipe diameter
is less than the length of one element, it will still be extended by one element.

Support Limitations
Note the following limitations for this condition.

• If one or more of the elbow elements has a subtended angle of more than 45 degrees, a warning is reported.
The solution can proceed, or you may want to use a finer mesh for better results.

• Pipe Idealization cannot be use with symmetry.

• Although the solution will account for cross section distortions, the graphics rendering for the results will
display the cross sections in their original shape.

• Given elbow elements (ELBOW290) with inner pipe temperature specifications only, the application will, by
default, specify this inner temperature as outer temperature as well.

Analysis Types
Pipe Idealization is available for the following analysis types:

• Modal (p. 227)

• Harmonic Response (p. 211)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported - Line Bodies Only. Apply to one or more edges or at least two vertices.

• 2D Simulation: Not Supported.

Geometry Types: Geometry types supported for the Pipe Idealization boundary condition include:

• Solid: Not Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Supported.

Release 2020 R1 - © ANSYS, Inc.


1110
Types of Boundary Conditions

Topology: The following topology selection options are supported for Pipe Idealization.

• Body: Not Supported.

• Face: Not Supported.

• Edge: Supported. It can only be scoped to edges that have been modeled as pipes. It can be scoped directly
to the geometry or to a Named Selection containing edges that are modeled as pipes.

• Vertex: Not Supported.

• Nodes: Supported - for node-based Named Selections

Boundary Condition Application


To apply a Pipe Idealization:

1. On the Environment context toolbar: click Conditions>Pipe Idealization. Or, right-click the Environment
tree object or the Geometry window and select Insert>Pipe Idealization.

2. Verify that in the Details panel for the Mesh object, Element Order in the Defaults group is set to Quad-
ratic.

3. If you choose to Extend to Adjacent Elements, enter a Factor.

4. Define the Scoping Method.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method - Options include:

• Geometry Selection - Default setting, indicating that the boundary condition is


applied to a geometry or geometries, which are chosen using a graphical selection
tools.

– Geometry - Visible when the Scoping Method is set to Geometry Selection.


Displays the type of geometry (Body, Face, etc.) and the number of geometric
entities (for example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection - Indicates that the geometry selection is defined by a Named


Selection.

– Named Selection - Visible when the Scoping Method is set to Named Selec-
tion. This field provides a drop-down list of available user–defined Named
Selections.

Definition Suppressed - Include (No - default) or exclude (Yes) the boundary condition.

Formulation - Read-only field defined as Curved/Deformed.

Release 2020 R1 - © ANSYS, Inc.


1111
Setting Up Boundary Conditions

Category Fields/Options/Description
Extend to Ad- Extend - Do not extend to adjacent elements (No) or specify as Factor (default).
jacent Ele-
ments Factor

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
boundary condition.

• Pipe element types include PIPE288 (3D two-node pipe) and PIPE289 (3D three-node pipe).

• If a pipe idealization is scoped to a pipe, the underneath PIPE289 elements of the pipe are modified to EL-
BOW290 elements.

Nonlinear Adaptive Region


The Nonlinear Adaptive Region condition enables you to change the mesh during the solution phase
to improve precision without incurring a great deal of computational penalties. The Nonlinear Adaptive
Region feature is completely automatic. It does not require any user input during the solution phase.
It acts as a remesh controller based on certain criteria. The criteria determine whether or not the mesh
requires modification and, if so, which parts need to be modified. This feature is based on load stepping,
requiring you to define a number of steps for your analysis, while also allowing you to activate and/or
deactivate the feature on a per step basis.

This condition may be useful for nonlinear problems that experience convergence difficulties or accuracy
issues because of elemental distortions. Large deformation problems are best suited to the use of the
condition.

Requirements
The Nonlinear Adaptive Region condition requires the following settings.

• The Large Deflection property must be set to On in the Solver Controls category of the Analysis
Settings.

• The Store Results At property must be set to All Time Points in the Output Controls category of the
Analysis Settings.

Preprocessing Support Limitations


Note the following limitations for this condition.

• Is not supported for:

– Distributed ANSYS Solver

– Convergence

• Cannot be used in combination with the following features/conditions on the same part:

– Cyclic Symmetry

– Contact Formulations: Normal Lagrange (3D), MPC, and Beam

Release 2020 R1 - © ANSYS, Inc.


1112
Types of Boundary Conditions

– Contact Behaviors: Auto Asymmetric

– Point Mass, Beam Connection, Joints, Spring, and Bearing

– Remote Force, Remote Displacement, Moment, Thermal Condition, and Remote Point

– Spatially varying boundary conditions

• Cannot be used in combination with the following boundary conditions:

– Coupling

– Constraint Equation

• The following materials properties are not supported:

– Cast Iron

– Concrete

– Cohesive Zone

– Damage

– Microplane

– Shape Memory Alloy

– Swelling

• When linking analyses, you cannot apply the solution phase modified mesh to the linked system.

• When using the Nonlinear Adaptive Region during the restart of an analysis, the Nonlinear Adaptive
Region object does not support Named Selections if your model contains a mesh change prior to the restart
point.

• If your analysis failed to converge and you are adding a new Nonlinear Adaptive Region object, it is necessary
that the contact object property, Behavior, was set to either Symmetric or Asymmetric for the initial
solution that was processed.

• When the Mesh option is specified for the Criterion property:

– does not support high order elements for 2D analyses.

– does not support self-contact for 3D analyses.

– cannot be used in the combination with Weak Springs (p. 881) (COMBIN14 element type).

Post Processing Support Limitations


Because this condition causes mesh changes during the course of the solution process, there are result
scoping limitations.

• Only Body scoping is permitted (for bodies whose meshes will change). Therefore, if you scope any
result or probe on a vertex, edge, or face of a body that experiences a mesh change, the analysis will

Release 2020 R1 - © ANSYS, Inc.


1113
Setting Up Boundary Conditions

not solve. This limitation is a result of the base mesh of the body being represented by nodes only. This
limitation also applies to probes scoped to boundary conditions (via Location Method property).

• Element selection on a result is not supported.

• Does not support the multiple result set options (p. 1209) of the By property: Maximum Over Time/Time
of Maximum or Minimum Over Time/Time of Minimum.

• Penetration plot following remesh may show the curve discontinuity.

• Is not supported when transferring the deformed geometry (p. 575) and mesh of a Deformation result.

• When using the Deformation result tracker (p. 1408) to graph displacement, note there is a display limit-
ation for the graph. The tracker reads and displays data contained in the jobname.nlh file. This file
contains incremental displacement data collected after re-meshing occurs. That is, the re-meshed
model is considered as a new reference.

Analysis Types
Nonlinear Adaptive Region is available for Static Structural (p. 339) analyses.

Common Characteristics
The following section outlines the common characteristics that include application requirements of the
condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported for linear tetrahedral elements.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Nonlinear Adaptive Region condition include:

• Solid: Supported.

• Surface/Shell: Not Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The following topology selection options are supported for Nonlinear Adaptive Region.

• Body: Supported.

• Face: Not Supported.

• Edge: Not Supported.

• Vertex: Not Supported.

• Nodes: Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1114
Types of Boundary Conditions

• Elements: Supported - for element-based Named Selections only.

Note

– Elements must be of the same element type, material, nodal orientation, and element
orientation.

– If two regions with different element or material attributes require re-meshing, you must
impose nonlinear adaptive regions separately.

Condition Application
To apply a Nonlinear Adaptive Region:

1. On the Environment context toolbar: click Conditions>Nonlinear Adaptive Region. Or, right-click the
Environment tree object or the Geometry window and select Insert>Nonlinear Adaptive Region.

2. Specify the Scoping.

Note

You can scope multiple Nonlinear Adaptive Regions to the same entity to give yourself
more control on multiple load step settings that are local to the Nonlinear Adaptive Region
condition.

3. Specify the Criterion: options include Energy, Box, and Mesh.

If Energy... If Box... If Mesh...


Define an En- Define the following properties. Nonlinear Adaptivity
ergy Coeffi- The origin of Coordinate System Controls (p. 887) become available
cient value. gives the minimum values of the in the Analysis Settings.
The Energy box, and the Length property
Coefficient provides the diagonal length of The Mesh Criterion is
must be box. Length values must be recommended.
non-negative. positive numbers.
Default For 3D Analyses
numeric • Coordinate System (default is Define a Skewness Value for the
value is 1. Global Coordinate System) mesh elements. The value must be
between 0 (equilateral) and 1
If you select a local (degenerate). A larger value reduces
coordinate system, it must the chance of a remesh to take
be a Cartesian coordinate place. The default value is 0.9.
system and may not
include rotation angles. For 2D Analyses
Specify a Maximum Corner Angle
• Length X for the mesh elements. The value
must be between 0° - 180°. The
• Length Y default setting is 160°.
• Length Z (for 3D)

Release 2020 R1 - © ANSYS, Inc.


1115
Setting Up Boundary Conditions

If Energy... If Box... If Mesh...


The Box option defines a region on the
model

4. Specify the Check At property as either Equally Spaced Points or Specified Recurrence Rate.

5. Enter the Value property based on the Check At property selection. This value must be an integer. Default
integer value is 1.

6. Specify the Time Range property as Entire Load Step or Manual. If Manual, specify Start Time and End
Time values. The start and end time values regulate the effective range of possible remeshing. No
remeshing will occur at a time outside of this range.

7. When the condition is defined, the Graph and Tabular Data windows provide a right-mouse click option
to Deactivate (or Activate) the condition for a desired load step. No remeshing will occur at the deactivated
load step as the NLADAPTIVE command is set to OFF. The default setting is Activated. For a restart analysis,
the application sets the newly added Nonlinear Adaptive Region to Deactivated.

Note

You may wish to review the Activation/Deactivation of Loads topic in the Step Con-
trols (p. 873) section of the Help. The Nonlinear Adaptive Region condition is displayed
in the graph for the Analysis Settings object.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that the condition is applied to


a geometry or geometries, which are chosen using a graphical selection tools.

– Geometry: Visible when the Scoping Method property is set to Geometry


Selection. Displays the type of geometry (Body) and the number of geometric
entities (1 Body, 2 Bodies) to which the condition has been applied using the
selection tools.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

Release 2020 R1 - © ANSYS, Inc.


1116
Types of Boundary Conditions

Category Fields/Options/Description
– Named Selection: Visible when the Scoping Method property is set to Named
Selection. This field provides a drop-down list of available user–defined
element-based (only) Named Selections.

You may wish to review the Mechanical APDL References and Notes at the
bottom of the page for specific command execution information regarding these
selections.
Definition Criterion: options included Energy, Box, or Mesh.

Energy
If Energy is selected, you need to enter an Energy Coefficient.

Energy Coefficient: This criterion checks the strain energy of any element that
is part of the defined component using the following calculation. A component
is defined as the assembly of all scoped elements.

where:

• Ee = strain energy of single target element.

• c1 = user input energy coefficient.

• Etotal = total strain energy of the component.

• NUME = number of elements of the component.

If this criterion is satisfied at an element, the program refines the element. A


smaller Energy Coefficient improves the potential to trigger the mesh
regeneration for the same loads.

Box
If Box is selected, the following additional properties require entries:

• Coordinate System (default is Global Coordinate System): defines the minimum


values of the box.

• Length X: defines the diagonal length on global X axis.

• Length Y: defines the diagonal length on global Y axis.

• Length Z (for 3D): defines the diagonal length on global Z axis

Mesh
If Mesh is selected, the Options property displays and based on your analysis, whether
it is 3D or 2D, the option is read-only and either Skewness (3D only) or Shape (2D
only).

For 3D analyses, you need to enter a Skewness Value for the mesh elements.
The element skewness is defined as:

Release 2020 R1 - © ANSYS, Inc.


1117
Setting Up Boundary Conditions

Category Fields/Options/Description
Skewness = (Vreg - Vel) / Vreg

Where:

Vel is the volume of the element under calculation and Vreg is the volume of
the standard tetrahedral linear element located in the same sphere as the
element under calculation. When the element under calculation has an ideal
shape (that of a standard tetrahedral element), Vreg = Vel and Skewness Value
= 0.

When the element under calculation has the least ideal shape (that of a flat
element), Vel = 0 and Skewness Value = 1.

Therefore, for the linear tetrahedral element, Skewness Value is always between
0 and 1, with 1 being a flat element. The default value is 0.9. The recommended
Skewness Value is approximately 0.85 to 0.9.

For 2D analyses, the Shape setting also includes the Maximum Corner Angle
property. The entry range for this property is 0° - 180°. The default setting
of 160° is recommended. An element is remeshed when any of its corner
angles reach the specified value.

Check At: options included Equally Spaced Points or Specified Recurrence Rate.

Value: This property further defines the Check At property. The default value is 1.

Time Range: options included Entire Load Step or Manual. When specified as
Manual, you need to enter a Start Time and End Time. The End Time value must
be larger than the Start Time value.

Suppressed: Include (No - default) or exclude (Yes) the condition.

View Changed Mesh Results


Following the solution process, to determine if the mesh was changed:

• Select the Solution object or a Result object, the Tabular Data window displays the substeps with a
changed mesh (Changed Mesh column = Yes).

• Select the Solution Information object and set the Solution Output property to Force Convergence.
A chart displays. Remesh Points are shown by solid orange vertical lines.

• Create a User Defined Result (p. 1342) (using the PNUMELEM Expression) to view the new elements
that have relatively larger element identities than the original element identities. You can duplicate
this result and specify a Result Set (By property) for a result prior to a remesh and one at a remesh
point, and using the Viewports (p. 150) feature, directly compare the (before and after) elements in
the graphics window.

Mechanical APDL References and Notes


The following Mechanical APDL commands, element types, and considerations are applicable for this
condition.

Release 2020 R1 - © ANSYS, Inc.


1118
Types of Boundary Conditions

• The Nonlinear Adaptive Region is applied with the NLADAPTIVE command.

• When the Scoping property is defined as Geometry, the Nonlinear Adaptive Region condition uses the
CM command to create the Nonlinear Adaptive Region component.

• When the Scoping property is defined as a Named Selection, the Nonlinear Adaptive Region condition
uses the CMBLOCK command to create the Nonlinear Adaptive Region component.

• The CMSEL,ALL command and the ESEL,ALL command are issued at beginning of the NLADAPTIVE com-
mand.

• During a Structural Analysis, the Nonlinear Adaptive Region is applied using the PLANE182 (2-D Low Order),
PLANE183 (2-D High Order), and SOLID285 (3-D Linear Tetrahedral) element types.

• When a Nonlinear Adaptive Region is scoped to a body/element, the associated part is meshed with
SOLID285 element type if they are linear tetrahedral.

• When a Nonlinear Adaptive Region is deactivated for certain steps, the NLADAPTIVE command is set to
be OFF in the corresponding load steps. Relatively, an activated Nonlinear Adaptive Region sets the
NLADAPTIVE command to be ON.

• When a Nonlinear Adaptive Region is applied, the ETCONTROL ,SET command is not issued.

Nonlinear Adaptive Region Solving Limitations


The purpose of nonlinear adaptive region is to repair a distorted mesh in order to overcome convergence
problems caused by the distortion. It is effective only when the mesh distortion is caused by a large,
nonuniform deformation. Nonlinear adaptive region cannot help if divergence occurs for any other
reason such as unstable material, unstable structures, or numerical instabilities.

Unstable Material

Most nonlinear material models, especially those employing hyperelastic materials, have their own ap-
plicable ranges. When a deformation is too large or a stress state exceeds the applicable range, the
material may become unstable. The instability can manifest itself as a mesh distortion, but nonlinear
adaptive region cannot help in such cases. While it is sometimes difficult to determine when material
is unstable, you can check the strain values, stress states, and convergence patterns. A sudden conver-
gence difficulty could mean that material is no longer stable. The program also issues a warning at the
beginning of the solution indicating when hyperelastic material could be unstable, although such a
warning is very preliminary and applies only to cases involving simple stress states.

Unstable Structures

For some geometries and loads, a deformation may cause a "snap-through," or local buckling. Such
behavior can also manifest itself as a mesh distortion, but one that nonlinear adaptive region cannot
repair. The effect is usually easy to detect by closely checking the deformed region or the load-versus-
time (displacement) curve.

Numerical Instabilities

A condition of numerical instability can occur when a problem is nearly overconstrained. The constraints
can include kinematic constraints such as applied displacements, couplings, and constraint equations,
and volumetric constraints introduced by fully incompressible material in mixed u-P elements. In many
cases, numerical instability is apparent even in the early stages of an analysis.

Release 2020 R1 - © ANSYS, Inc.


1119
Setting Up Boundary Conditions

Direct FE Type Boundary Conditions


The Direct Finite Element (FE) menu contains options that allow you to apply boundary conditions directly
to the nodes on the finite element mesh of a model. These boundary conditions are scoped via node-
based Named Selections (p. 583). They differ from geometry based boundary conditions in the fact that
they are applied directly to the nodes during solution calculations whereas geometry-based boundary
conditions are applied through special loading elements such as SURF, CONTAC, or FOLLW201 elements.

These boundary conditions are applied in the Nodal Coordinate System (except Nodal Pressure). Direct
FE boundary conditions cannot be applied to nodes that are already scoped with geometry-based
constraints which may modify the Nodal Coordinate system.

The boundary conditions contained under the Direct FE heading are listed below.
Nodal Orientation
Nodal Force
Nodal Pressure
Nodal Displacement
Nodal Rotation
EM (Electro-Mechanical) Transducer

Nodal Orientation
Nodal Orientation objects are meant to rotate the nodes to a given coordinate system that you select
in the GUI. By inserting a Nodal Orientation object and scoping it to a subset of nodes, you can create
a Nodal Coordinate System and apply nodal rotations to the scoped nodes. Later, other node based
boundary conditions (Nodal Force, Nodal Displacements, and Nodal Rotations) can use these Nodal
Coordinate Systems.

When two or more Nodal Orientations prescribe different Nodal Coordinate Systems at a single node,
the object that is added last (in the tree) is applied.

Analysis Types
Nodal Orientation is available for the following analysis types:

• Modal (p. 227)

• Harmonic Response (p. 211)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Release 2020 R1 - © ANSYS, Inc.


1120
Types of Boundary Conditions

Geometry Types: Geometry types supported for the Nodal Orientation boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The Nodal Orientation boundary condition is scoped via node-based Named Selections
only. See the Specifying Named Selections by Direct Node Selection (p. 142) Help section for more in-
formation.

Boundary Condition Application


To define Nodal Orientation and apply it to nodes:

1. On the Environment context toolbar, click Direct FE > Nodal Orientation. Or, right-click the Environment
tree object or the Geometry window and select Insert>Nodal Orientation.

2. Click the Named Selection drop-down list and then select the node-based Named Selection to prescribe
the scope of the boundary conditions.

3. Select the coordinate system that you want to use to define nodal orientation.

Details View Properties


The Details View selections are described below.

Category Fields/Options/Description
Scope Scoping Method: read-only field that displays scoping method – Named
Selection (p. 583).

Named Selection: drop-down list of available node-based Named Selections.

Coordinate System: drop-down list of available coordinate systems. The


selected system is used to orientate the nodes in the Named Selection.
Definition Suppressed: includes or excludes the boundary condition in the analysis.

Nodal Force
Using a Nodal Force, you can apply a force to an individual node or a set of nodes. You must create a
node-based Named Selection before you can apply a Nodal Force. The Nodal Force that you apply in
Mechanical is represented as an F Command in the Mechanical APDL application.

Note

A Nodal Force object may be added during Solution Restart (p. 1385) without losing the restart
points.

Analysis Types
Nodal Force is available for the following analysis types:

Release 2020 R1 - © ANSYS, Inc.


1121
Setting Up Boundary Conditions

• Eigenvalue Buckling (p. 203) (for Nonlinear-based Eigenvalue Buckling Analysis only)

• Explicit Dynamics

• Harmonic Response (p. 211)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Nodal Force boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The Nodal Force boundary condition is scoped via node-based Named Selections only.
See the Specifying Named Selections by Direct Node Selection (p. 142) Help section for more information.

Note

The Nodal Force boundary condition supports spatially varying loading on the scoped nodes
for Static and Transient analyses only. For Harmonic Response and Eigenvalue Buckling
analyses, only constant loading conditions are supported.

Boundary Condition Application


To apply a Nodal Force:

1. On the Environment toolbar, click Direct FE > Nodal Force. Or, right-click the Environment tree object
or the Geometry window and select Insert>Nodal Force.

2. Click the Named Selection drop-down list and then select the node-based Named Section to prescribe
the scope of the Nodal Force.

3. Enter a magnitude for the X, Y, and Z component to define the load.

Tip

Define a Nodal Orientation for the Named Selection to control the Nodal Coordinate System.

Release 2020 R1 - © ANSYS, Inc.


1122
Types of Boundary Conditions

Details View Properties


The Details View selections are described below.

Category Fields/Options/Description
Scope Scoping Method: a read-only field that displays scoping method - Named
Selection (p. 583).

Named Selection: a drop-down list of available node-based Named Selec-


tion.
Definition Type: a read-only field that describes the node-based object - Force.

Coordinate System: a read-only field that displays the coordinate system


- Nodal Coordinate System. The Nodal Coordinate System can be modified
by applying Nodal Orientation (p. 1120) objects.

X Component: defines force in the X direction

Y Component: defines force in the Y direction

Z Component: defines force in the Z direction

You can define the Component values as a Constant, in Tabular form


as a function of varying Time or varying Step (Static Structural only), or
as a Function.

Divide Load by Nodes: options include:

• Yes: (default) the load value is normalized: it is divided by number of scoped


nodes before application.

• No: the load value applied directly to every scoped node.

Suppressed: includes or excludes the boundary condition in the analysis.

Note

• When Divide Load by Nodes is set to Yes, the forces are evenly distributed across the nodes
and do not result in a constant traction.

• Two Nodal Force objects that have same scoping do not produce a cumulative loading effect.
The Nodal Force that was specified last takes priority and is applied, and as a result, the other
Nodal Force is ignored. For Explicit Dynamics analyses, a resultant effect is always calculated if
multiple loads are applied to a node (either by geometric entity or as a nodal force).

• A load applied to a geometric entity and a Nodal Force produce a resultant effect.

Nodal Pressure
Using Nodal Pressure, you can apply pressure on element faces. You must create a node based named
selection before you can apply a Nodal Pressure. It is applicable for solid and surface bodies only.
Specifically, an elemental face pressure is created only if all of the nodes of a given element face (includ-

Release 2020 R1 - © ANSYS, Inc.


1123
Setting Up Boundary Conditions

ing midside) are included. If all nodes defining a face are shared by an adjacent face of another selected
element, the face is not free and will not have a load applied.

Warning

For application to surface bodies, the Mechanical APDL solver logic for this load is such that
if all of the nodes of a shell element are specified, then the load is applied to the whole
element face. However, if only some nodes are specified on an element and those nodes
constitute a complete external edge, then an edge pressure is created. Therefore, it is critical
that you make sure that you have not selected nodes that constitute only a free shell edge.
This is because shell edge pressures are input on a per-unit-length basis, and Mechanical
treats this load always as a per-unit-area quantity. See the SHELL181 Element Description
for more information.

Nodal Pressures applied to shell bodies act in the opposite direction of geometry-based
pressures.

Note

A Nodal Pressure may be added during Solution Restart (p. 1385) without losing the restart
points.

Analysis Types
Nodal Pressure is available for the following analysis types:

• Eigenvalue Buckling (p. 203) (for Nonlinear-based Eigenvalue Buckling Analysis only)

• Harmonic Response (Full) Analysis Using Pre-Stressed Structural System (p. 223)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Nodal Pressure boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1124
Types of Boundary Conditions

Topology: The Nodal Pressure boundary condition is scoped via node-based Named Selections only.
See the Specifying Named Selections by Direct Node Selection (p. 142) Help section for more information.

Note

The Nodal Pressure boundary condition supports spatially varying loading on the scoped
nodes for Static and Transient analyses only. For Eigenvalue Buckling and Harmonic Response
analyses, only constant loading conditions are supported.

Boundary Condition Application


To apply a Nodal Pressure:

1. On the Environment toolbar, click Direct FE > Nodal Pressure. Or, right-click the Environment tree object
or the Geometry window and select Insert>Nodal Pressure.

2. Click the Named Selection drop-down list, and then select the node-based Named Selection to prescribe
the scope of the Nodal Pressure.

3. Enter a magnitude for the load.

Details View Properties


The Details View selections are described below.

Category Fields/Options/Description
Scope Scoping Method: Read-only field that displays scoping method - Named
Selection (p. 583).

Named Selection: Drop-down list of available node-based Named


Selections.
Definition Type: Read-only field that displays boundary condition type - Pressure.

Define By: Read-only field that displays that the boundary condition is
acting Normal To the surface to which it is attached.

Magnitude: Input field to define the magnitude of the boundary


condition. This value can be defined as a Constant, in Tabular form as
a function of Time or Step (Static Structural only), or as a Function.

Note

Spatially varying loading (Tabular/Function) is supported


for Static and Transient analyses only. For Eigenvalue
Buckling and Harmonic Response analyses, only constant
loading conditions are supported.

Release 2020 R1 - © ANSYS, Inc.


1125
Setting Up Boundary Conditions

Category Fields/Options/Description
Suppressed: Includes or excludes the boundary condition in the analysis.

Note

• To apply a node-based pressure, the named selections that you create must include nodes such
that they define an element face.

• Two Nodal Pressure objects that have same scoping do not produce a cumulative loading effect.
The Nodal Pressure object that was specified last takes priority and is applied, and as a result,
the other Nodal Pressure object is ignored.

• A load applied to a geometric entity and a Nodal Pressure produce a resultant effect.

• You can apply a spatially varying Nodal Pressure to scoped nodes.

• If a Nodal Pressure and a Direct Pressure share the same scoping, the Nodal Pressure always
takes priority regardless of insertion order: Mechanical will ignore the Direct Pressure.

Mechanical APDL References and Notes


For more information on the solver representation of this load, reference the SF command in the
Mechanical APDL Command Reference.

Nodal Displacement
Using Nodal Displacement, you can apply a displacement to an individual node or a set of nodes. You
must create a node based named selection before you can apply a Nodal Displacement.

Analysis Types
Nodal Displacement is available for the following analysis types:

• Eigenvalue Buckling (p. 203) (for Nonlinear-based Eigenvalue Buckling Analysis only)

• Explicit Dynamics

• Modal (p. 227)

• Harmonic Response (p. 211)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported.

Release 2020 R1 - © ANSYS, Inc.


1126
Types of Boundary Conditions

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Nodal Displacement boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The Nodal Displacement boundary condition is scoped via node-based Named Selections
only. See the Specifying Named Selections by Direct Node Selection (p. 142) Help section for more in-
formation.

Note

The Nodal Displacement boundary condition supports spatially varying loading on the
scoped nodes for Static and Transient analyses only. For Eigenvalue Buckling, Harmonic Re-
sponse, and Modal analyses, only constant loading conditions are supported.

Boundary Condition Application


To apply a Nodal Displacement:

1. On the Environment toolbar, click Direct FE>Nodal Displacement. Or, right-click the Environment tree
object or right-click within the Geometry window and select Insert>Nodal Displacement.

2. Click the Named Selection drop-down list and then select the node-based Named Section to prescribe
the scope of the Nodal Displacement.

3. Define loads in the X, Y, and/or Z directions.

Tip

Define a Nodal Orientation for the Named Selection to control the Nodal Coordinate System.

Details View Properties


The Details View selections are described below.

Category Fields/Options/Description
Scope Scoping Method: read-only field that displays scoping method - Named
Selection (p. 583).

Named Selection: drop-down list of available node-based Named


Selections.
Definition Type: read-only field that displays boundary condition type -
Displacement.

Coordinate System: read-only field that displays the coordinate system


- Nodal Coordinate System.

Release 2020 R1 - © ANSYS, Inc.


1127
Setting Up Boundary Conditions

Category Fields/Options/Description
X Component: specify a displacement value in the X direction. The
default value is Free (no Displacement constraint applied).

Y Component: specify a displacement value in the Y direction. The


default value is Free (no Displacement constraint applied).

Z Component: specify a displacement value in the Z direction. The


default value is Free (no Displacement constraint applied).

You can define the Component values as a Constant, in Tabular form


as a function of varying Time or varying Step (Static Structural only), or
as a Function.

Suppressed: includes or excludes the boundary condition in the analysis.

Note

• Solution Restarts (p. 1385) are only supported for Tabular data modifications.

• If a Component property is set to Function, all other Components properties automatically


default to the Free setting and become read-only.

• Two Nodal Displacement objects that have same scoping do not produce a cumulative loading
effect. The Nodal Displacement object that was specified last takes priority and is applied, and
as a result, the other Nodal Displacement object is ignored. For Explicit Dynamics analyses, the
compatibility of multiple Nodal Displacements applied to a node must be respected. The solver
will attempt to combine the constraints, but if this is not possible, the solve will fail with an ap-
propriate error message.

Nodal Rotation
Using Nodal Rotation, you can apply a fixed rotation to an individual node or a set of nodes that have
rotational degrees of freedom (DOFs).

Analysis Types
Nodal Rotation is available for the following analysis types:

• Modal (p. 227)

• Harmonic Response (p. 211)

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Release 2020 R1 - © ANSYS, Inc.


1128
Types of Boundary Conditions

Dimensional Types

• 3D Simulation: Supported.

• 2D Simulation: Supported.

Geometry Types: Geometry types supported for the Nodal Rotation boundary condition include:

• Solid: Not Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Supported.

Topology: The Nodal Rotation boundary condition is scoped via node-based Named Selections only.
See the Specifying Named Selections by Direct Node Selection (p. 142) Help section for more information.

Boundary Condition Application


To apply a Nodal Rotation:

1. On the Environment toolbar, click Direct FE>Nodal Rotation. Or, right-click the Environment tree object
or the Geometry window and select Insert>Nodal Rotation.

2. Click the Named Selection drop-down list and then select the node-based Named Section to prescribe
the scope of the Nodal Rotation.

3. Define the X, Y, and/or Z axis as Fixed or Free. At least one Component must be defined as Fixed.

Tip

Define a Nodal Orientation for the Named Selection to control the Nodal Coordinate System.

Details View Properties


The Details View selections are described below.

Category Fields/Options/Description
Scope Scoping Method: read-only field that displays scoping method - Named
Selection (p. 583).

Named Selection: drop-down list of available node-based Named


Selections.
Definition Type: read-only field that displays boundary condition type - Fixed
Rotation.

Coordinate System: read-only field that displays the coordinate system


- Nodal Coordinate System.

X Component: define the x-axis of rotation as Fixed (default) or Free.

Y Component: define the y-axis of rotation as Fixed (default) or Free.

Z Component: define the z-axis of rotation as Fixed (default) or Free.

Release 2020 R1 - © ANSYS, Inc.


1129
Setting Up Boundary Conditions

Category Fields/Options/Description
Suppressed: includes or excludes the boundary condition in the analysis.

Note

When parameterizing this boundary condition, a Free axis of rotation is represented by a


zero (0) and Fixed with a value of one (1) inside the Parameter tab in ANSYS Workbench
(outside of Mechanical).

EM (Electro-Mechanical) Transducer
Using the EM Transducer boundary condition, you can model simple Micro-Electro-Mechanical Systems
(MEMS) devices.

Analysis Types
EM Transducer is available for the following analysis types:

• Static Structural (p. 339)

• Transient Structural (p. 384)

Common Characteristics
The following section outlines the common boundary condition characteristics that include application
requirements of the boundary condition, support limitations, as well as loading definitions and values.

Dimensional Types

• 3D Simulation: Supported. Node-based Named Selections only support face node selection.

• 2D Simulation: Supported. Node-based Named Selection only support edge node selection.

Geometry Types: Geometry types supported for the EM Transducer boundary condition include:

• Solid: Supported.

• Surface/Shell: Supported.

• Wire Body/Line Body/Beam: Not Supported.

Topology: The EM Transducer boundary condition is scoped via node-based Named Selections only.
See the Specifying Named Selections by Direct Node Selection (p. 142) Help section for more information.

Loading Types: The loading for this boundary condition is always defined as a Voltage Difference.

Loading Data Definition (p. 1150): Enter loading data using one of the following options.

• Constant: Supported. This value can be Parameterized.

• Tabular (Time Varying): Supported. This value cannot be Parameterized.

• Tabular (Spatially Varying): Not Supported.

Release 2020 R1 - © ANSYS, Inc.


1130
Types of Boundary Conditions

• Tabular (Step Varying): Supported (Static Structural only). This value cannot be Parameterized.

• Function (Time Varying): Supported. This value cannot be Parameterized.

• Function (Spatially Varying): Not Supported.

Boundary Condition Application


To apply EM Transducer:

1. On the Environment toolbar, click Direct FE>EM Transducer. Or, right-click the Environment tree object
or the Geometry window and select Insert>EM Transducer.

2. Enter a Voltage Difference value.

3. Specify a GAP Direction, either X, Y, or Z based on the default Nodal Coordinate System or a user-defined
nodal coordinate system.

4. Enter Initial Gap and Minimal Gap values.

Details View Properties


The selections available in the Details view are described below.

Category Fields/Options/Description
Scope Scoping Method: Read-only field that displays scoping method - Named Selection
(p. 583).

Named Selection: Drop-down list of available node-based Named Selections.


Definition Type: Read-only field that describes the node-based object - EM Transducer.

Voltage Difference: Input field for Voltage value.

Suppressed: Include (No - default) or exclude (Yes) the boundary condition.


Voltage Sur- Coordinate System: Read-only field that displays the coordinate system - Nodal
face Location Coordinate System.

GAP Direction: Specify the structural DOF used, X, Y, or Z based on the Nodal
Coordinate System. This is used with the Volt DOF.

Initial Gap: Input field for initial range of motion (in GAP Direction). Can be
Parameterized.

Minimal Gap: Input field for minimal range of motion (in GAP Direction). Can be
Parameterized.
Function Unit System: Read-only field displaying the unit of measure associated with the
[1] (p. 1132) Voltage.

Angular Measure: Read-only field displaying the unit of measure for the voltage’s
angle.
Graph Con- Number of Segments: The function is graphed with a default value of 200 line
trols segments. You can change this value to better visualize the function.
[1] (p. 1132)

Release 2020 R1 - © ANSYS, Inc.


1131
Setting Up Boundary Conditions

1. This category displays only when Voltage Difference is specified as a Function.

Mechanical APDL References and Notes


This boundary condition uses the EMTGEN command to generate a set of TRANS126 elements between
the surface nodes of a moveable structure and a plane of nodes, typically representing a ground plane.

Note

The newly created (by EMTGEN command) ground plane nodes (of TRANS126 elements) are
assumed to be fixed.

Remote Boundary Conditions


The boundary conditions listed here can make use of the Remote Point (p. 609) feature (object)
provided by Mechanical. The Remote Point associated with one of the given objects is either created
and defined by you (you create a Remote Point object that the remote boundary condition references)
or it is automatically generated by the system (you can think of it as an “internal” remote point - no
Remote Point object exists in the object tree).

When defined with a remote point, these objects are considered remote boundary conditions. The remote
point gives the object an “abstract” quality because it is not directly applied to the nodes or vertices
of a model.

However, you can directly scope a single node or vertex of your model to some of the boundary condi-
tions listed below; specifically Point Masses, Springs, and Joints. Using the Details view property, Ap-
plied By, for these objects you can switch between the settings Remote Attachment and Direct At-
tachment. When directly applied, they are not considered remote boundary conditions and as a result
do not provide certain properties, such as Pinball or Formulation.

• Point Mass (p. 505)

• Thermal Point Mass (p. 509)

• Joints (p. 746)

• Spring (p. 818)

• Bearing (p. 831)

• Beam Connection (p. 825)

• Remote Displacement (p. 1086)

• Remote Force (p. 957)

• Moment (p. 972)

Remote boundary conditions have the following characteristics:

• All remote boundary conditions make use of MPC contact used in the Mechanical APDL application. See the
Geometry Behaviors and Support Specifications (p. 614) section in the Mechanical Help as well as the Surface-
Based Constraints section in the Contact Technology Guide - part of the Mechanical APDL Help, for more in-
formation.

Release 2020 R1 - © ANSYS, Inc.


1132
Types of Boundary Conditions

• You are advised to check reaction forces to ensure that a remote boundary condition has been fully applied,
especially if the boundary condition shares geometry with other remote boundary conditions, any type of
constraint, or even MPC contact.

• Once a remote boundary condition is created, you can generate an external Remote Point based on the
scoping of the remote boundary condition using the Promote Remote Point (p. 618) feature (RMB menu).

Annotations are available for point masses, springs, beam connections, and bearings. You can toggle
the visibility of these annotations in the Annotation Preferences dialog box. For more information,
see Specifying Annotation Preferences (p. 164).

Imported Boundary Conditions


By linking ANSYS Workbench systems with Mechanical analysis systems, you can import results from
one analysis and apply them as boundary conditions in a downstream (target) system.

For example, Mechanical enables you to import data from:

• Mechanical analysis systems as Imported Loads (p. 1725) or through Submodeling (p. 433).

• External Data (p. 412) systems as Imported Loads (p. 1725).

• Fluent CFD analyses using the System Coupling (p. 445) feature.

• HFSS, Maxwell, or Q3D Extractor applications as Imported Loads (p. 1725).

Additional information on Thermal-Stress (p. 459), Fluid-Structure Interaction (FSI) (p. 419), Ansoft -
Mechanical Data Transfer (p. 402), Icepak to Mechanical Data Transfer (p. 424), Submodeling, and External
Data Import (p. 412) can be found in the Special Analysis Topics (p. 402) section.

Note

Convergence is not supported for environments with imported loads.

This section outlines the systems that you can link for importing boundary conditions as well as the
supported boundary conditions, and it presents the steps to import and apply imported boundary
conditions. Select a link below to navigate to a desired topic.

• Supported Analysis Types and Systems (p. 1133)

• Supported Boundary Conditions (p. 1134)

• Applying Imported Boundary Conditions (p. 1135)

Note

You can work with imported loads only when you perform an analysis with data transfer.

Supported Analysis Types and Systems


The following table lists the systems that interact with one another using data transfer. The associated
imported boundary conditions (as a data type) are show in parenthesis.

Release 2020 R1 - © ANSYS, Inc.


1133
Setting Up Boundary Conditions

Source Analysis/System (Transfer Target Analysis


Data Type)
CFD (Convection) Steady State Thermal, Transient Thermal, Thermal-Electric
1
CFD (Pressure) Static Structural, Transient Structural (p. 1134)
CFD (Temperature) Steady State Thermal, Transient Thermal, Thermal-Electric, Static
Structural, Transient Structural 1 (p. 1134)
System Coupling (Heat Flow, Steady State Thermal
Convection, Temperature)
Electric (Joule Heat) Steady State Thermal, Transient Thermal
1
Electromagnetic (Force Density) Static Structural, Transient Structural (p. 1134)
Electromagnetic (Power Loss Density) Steady State Thermal, Transient Thermal
2
Electromagnetic (Force and Moment) Harmonic Response (p. 1134)
1
External Files (Displacement, Force, Static Structural, Transient Structural (p. 1134)
Temperature, Stress, Strain, Body Force
Density)
External Files (Temperature, Steady State Thermal, Transient Thermal, Thermal-Electric
Convection, Heat Flux, Heat
Generation)
1
External Files (Pressure) Static Structural, Transient Structural (p. 1134), Harmonic
Response
3
External Files (Velocity) Acoustic Analysis (p. 1134)
3
Harmonic Response (Velocity) Acoustic Analysis (p. 1134)
Polyflow (Temperature) Steady State Thermal, Transient Thermal, Thermal-Electric, Static
Structural, Transient Structural 1 (p. 1134)
1
Static Structural, Transient Structural Static Structural, Transient Structural (p. 1134)
(Displacement, Temperature, Force 4
(p. 1134), and Moment 4 (p. 1134))
1
Steady-State Thermal, Transient Static Structural, Transient Structural (p. 1134), Electric
Thermal (Temperature)
1
Thermal-Electric (Temperature) Static Structural, Transient Structural (p. 1134)

1: Rigid dynamics solver is not supported.

2: See the Importing Data into a Harmonic Analysis (p. 406) section for the specific steps to perform the
analysis.

3: An acoustic analysis is performed via ACT. For information on creating optimization extensions, see
the ANSYS ACT Developer's Guide.

4: Supported for Beam to Shell or Solid submodeling only.

Supported Boundary Conditions


Mechanical supports the boundary conditions listed below. The availability of a boundary condition in
an analysis is dependent upon the types of systems that you have joined.

Imported Body Force Density (p. 1138)

Release 2020 R1 - © ANSYS, Inc.


1134
Types of Boundary Conditions

Imported Body Temperature (p. 1139)


Imported Cut Boundary Remote Constraint (p. 1141) (Beam to Shell-Solid Submodeling Only)
Imported Convection Coefficient (p. 1141)
Imported Cut Boundary Constraint (p. 1141)
Imported Cut Boundary Remote Force (p. 1141) (Beam to Shell-Solid Submodeling Only)
Imported Displacement (p. 1142)
Imported Force (p. 1142)
Imported Heat Flux (p. 1143)
Imported Heat Generation (p. 1143)
Imported Initial Strain (p. 1144)
Imported Initial Stress (p. 1145)
Imported Pressure (p. 1147)
Imported Remote Loads (p. 1148)
Imported Surface Force Density (p. 1148)
Imported Temperature (p. 1148)
Imported Velocity (p. 1149)

Applying Imported Boundary Conditions


To import loads for an analysis:

1. On the Workbench Project page, add the desired analysis that supports data transfer. Link the Solution
cell of the upstream onto the Setup cell of the downstream system. As required, you can also link the
Engineering Data and Geometry cells between the systems.

2. As needed, attach geometry to the downstream analysis system and then double-click Setup to open
the Mechanical window. An Imported Load folder is added under the environment folder, by default.

3. To add an imported load, click the Imported Load folder to make the Environment toolbar available or
right-click the Imported Load folder and select the appropriate load from the context menu.

Note

An Imported Load can also be created from duplicating an existing imported load.
Perform a right-click an Imported Load to display the context menu, select duplicate
to add an identical Imported Load to your model.

Release 2020 R1 - © ANSYS, Inc.


1135
Setting Up Boundary Conditions

4. On the Environment toolbar, click Imported Loads, and then select an appropriate load.

5. Select the appropriate geometry, using the geometry selection or geometry-based Named Selection
option and then click Apply.

The following Imported Loads can also be scoped to node-based Named Selections.

• Imported Body Temperatures (from External Data, for Submodeling [Shell-Shell not supported], or
for Thermal-Stress)

• Imported Displacements (from External Data or for Submodeling)

• Imported Forces (from External Data)

• Imported Temperatures (from External Data or for Submodeling)

• Imported Velocities (from External Data)

• Imported Initial Stress and Imported Initial Strain (from External Data), when the Apply To property
is set to Corner Nodes

6. Set the appropriate options in the Details view.

7. The Data View can be used to control the load data that is imported. Each data transfer incorporates
some or all of the column types shown below.

• Source Time/Frequency: Time at which the load will be imported.

• Source Time Step: Time Step at which the load will be imported.

• Analysis Time/Frequency: Time at which the load will be applied when the analysis is solved.

• Scale: The amount by which the imported load values are scaled before they are sent to the solver. The
scale value is applied to the imported load values in the solver unit system.

For Imported Temperature and Imported Body Temperature loads:

– The values used in the solution are calculated by first converting the imported load values into the
solver unit system and then multiplying the scale value.

• Offset: An offset that is added to the imported load values before they are sent to the solver. The offset
value is applied to the imported load values in the solver unit system.

Specific transfer details can be found in the Special Analysis Topics (p. 402) section.

Release 2020 R1 - © ANSYS, Inc.


1136
Types of Boundary Conditions

8. If you are using the ANSYS solver, loads can be applied using tables, or can be applied at each analysis
time/frequency specified in the imported load using the Tabular Loading property. When sending as
tables, the loads can either be ramped or step changed (stepped) between the specified Analysis
Times/Frequencies.

a. When ramped, the load value at step/sub-step is calculated using linear interpolation in the range
where solve step/sub-step falls.

b. When stepped, the load value specified at t2 is applied in the range (t1, t2], where (t1, t2] is the range
greater than t1 and less than or equal to t2.

Note

• When program controlled, the loads are sent as tables when Analysis Time(s)/Fre-
quency(ies) not matching any step end times/maximum frequency are present in the
load definition. The loads are ramped for static/steady state and harmonic analyses and
step applied for transient analyses.

• The loads are always sent as tables when Ramped or Stepped is chosen.

Important

Note that these options do not change the KBC command value
(Key) which controls whether all of the loads within a load step
are linearly interpolated or step changed. In addition, certain
limitations apply to loads that do not support tabular loading,
such as Imported Body Force Density (p. 1138). The limitations are
described on the Help page for the respective loads (p. 1133).

• Extrapolation is not performed when stepping/ramping the loads. If the solve time for
a step/sub-step falls outside the specified Analysis Time/Frequency, then the load
value at the nearest specified analysis time is used.

• For temperature loads, the values are ramped from reference temperature for the first
time step. For all other loads, the values are ramped from zero.

• User can choose not to send the loads as tables using the Off option. The analysis
times/frequencies specified in the load definition must match the step end
times/maximum frequency in this case for the solution to succeed.

9. In the Project tree, right-click the imported load, and then click Import Load to import the load.

10. When the load has been imported successfully, a contour or vector plot will be displayed in the Geometry
window.

• For vector loads types, contours plots of the magnitude (Total) or X/Y/Z component can be viewed by
changing the Data option in the details pane. Defaults to a vector plot (All).

Release 2020 R1 - © ANSYS, Inc.


1137
Setting Up Boundary Conditions

• For tensor loads types, contours plots of Equivalent (von-Mises) or XX/YY/ZZ/XY/YZ/ZX component
can be viewed by changing the Data option in the details pane. Defaults to a Vector Principal plot (All).

• For Imported Convection loads, contours plots of film coefficient or ambient temperature can be
viewed by changing the Data option in the details pane.

• For complex load types, e.g. Pressure/Velocity in Harmonic Response, the Real/Imaginary component
of the data can be viewed by changing the Complex Data Component option in the details pane.

• The Legend controls options allow the user to control the range of data displayed in the graphics
window. By default, it is set to Program control, which allows for complete data to be displayed. If you
are interested in a particular range of data, you can select the Manual option, and then set the minim-
um/maximum for the range.

Note

• When you scope imported loading conditions to elements, you may see graphic artifacts
on your model in the form of color "bleeding". Selecting Wireframe mode (p. 94) corrects
the display.

• The isoline option is drawn based on nodal values. When drawing isolines for imported loads
that store element values (Imported Body Force Density, Imported Convection, Imported
Heat Generation, Imported Heat Flux, Imported Pressure, Imported Surface Force
Density, Imported Initial Stress and Imported Initial Strain), the program automatically
calculates nodal values by averaging values of the elements to which a node is attached.

• The minimum and maximum values of source data are also available in Legend Controls
for External Data Import (p. 412), Thermal-Stress (p. 459), Submodeling, and Acoustic Coup-
ling (p. 463) analyses.

11. To preview the imported load contour that applies to a given row in the Data View, use the Active Row
option in the Details view.

12. To activate or deactivate the load at a step, highlight the specific step in the Graph or Tabular Data
window, and choose Activate/Deactivate at this step! See Activation/Deactivation of Loads (p. 875) for
additional rules when multiple load objects of the same type exist on common geometry selections.

To export data, select the Imported Load object, right-click the mouse, and then select Export.

Imported Body Force Density


When electromagnetic body forces are transferred to a structural environment, an Imported Body
Force Density object can be inserted to represent the transfer.

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Note

• For a particular load step, an active Imported Body Force Density load will overwrite other
Imported Body Force Density loads that exist higher (previously added) in the tree, on

Release 2020 R1 - © ANSYS, Inc.


1138
Types of Boundary Conditions

common geometry selections. See Activation/Deactivation of Loads (p. 875) for additional
rules when multiple load objects of the same type exist on common geometry selections.

• For large-deflection analyses, the loads are applied to the initial size of the element, not the
current size.

Limitations for Tabular Loading


The application does not support sending the Imported Body Force Density load to the solver as a
table. For this imported load, the Tabular Loading property controls the creation of the data table.
The values are then applied from the at each load step.

However, the KBC command value (Key) specified for the analysis controls the ramping or stepping
within a load step.

Therefore, if the analysis time specified by the Imported Load definition matches the load step end
time, then there is no difference in solution between the Stepped and the Ramped option (of Tabular
Loading property) for the load step.

Imported Body Temperature


When temperatures are transferred to a structural or electric analysis, an Imported Body Temperature
object is automatically inserted to represent the transfer.

If the load is applied to one or more surface bodies, the Shell Face option in the details view enables
you to apply the temperatures to Both faces, to the Top face(s) only, or to the Bottom face(s) only. By
default, the temperatures are applied to both the top and bottom faces of the selection.

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Be sure to review the following information about the requirements and considerations when employing
this loading condition.

Operational Rules for Imported Thermal Loads


Please observe the following operational conditions when you apply Imported Body Temperature loads
and Thermal Condition on the same geometry. For each load step:

• An active, reactivated, or deactivated Imported Body Temperature load overwrites any Thermal Condition
loads on common geometry selections.

• The most recently added Imported Body Temperature load, whether active, reactivated, or deactivated,
overwrites any other Imported Body Temperature loads that exist in the tree and that share common
geometry or node selections.

• Imported Body Temperature loads for which no commands are sent to the solver, for a particular load
step, are overwritten by a reactivated or deactivated:

– Thermal Condition load on common geometry selections.

– Imported Body Temperature load on common geometry selections.

Release 2020 R1 - © ANSYS, Inc.


1139
Setting Up Boundary Conditions

The Imported Body Temperature will remain deleted until it gets reactivated during one of the
subsequent steps (i.e. status change from deactivated to active).

See the Activation/Deactivation of Loads (p. 875) Help for additional rules about when multiple load
objects of the same type exist on common geometry selections.

Note

For an active, reactivated, or deactivated loading condition, the application sends a command
to the solver. The Tabular Loading topic below describes when during the solution process
the command is sent to the solver.

Tabular Loading
Note the following tabular loading characteristics for Imported Body Temperature loads:

• When Imported Body Temperature loads are not sent using tables, the commands are sent to the
solver at load steps specified in the Data View worksheet or when the load is reactivated or deactivated.

• For Imported Body Temperature loads specified in Tabular Data, commands are sent to the solver only
at the first active or reactivated load step.

General Notes
Review to the following to make sure that you properly configure your imported load.

• Adaptive Convergence objects inserted under an environment that is referenced by an Imported


Body Temperature object will invalidate the Imported Body Temperature object, and not allow a
solution to progress.

• For a particular load step, an active Imported Body Temperature load will overwrite any Thermal
Condition loads on common geometry selections.

• When a Thermal Condition is specified on the Top or Bottom shell face of a surface body, the opposite
face defaults to the environment temperature unless it is otherwise specified from another load object.

• For an assembly of bodies with different topologies, you must define a separate Imported Body
Temperature load for surface bodies.

• The values used in the solution are calculated by first converting the imported load values into the
solver unit system and then multiplying the scale value.

• For each load step, if an Imported Body Temperature load and a Thermal Condition load are applied
on common geometry or node selections, the Imported Body Temperature load takes precedence.
An active Imported Body Temperature load will also overwrite other Imported Body Temperature
loads that exist higher (previously added) in the tree, on common geometry or node selections. See
Activation/Deactivation of Loads (p. 875) for additional rules when multiple load objects of the same
type exist on common geometry selections.

• If a scale factor is specified, the values used in the solution are calculated by first converting the imported
load values into the solver unit system and then multiplying the scale value.

• For surface bodies, the thickness of each target node is ignored when data is mapped. When importing
data from an External Data system, the Shell Thickness Factor property enables you to account for

Release 2020 R1 - © ANSYS, Inc.


1140
Types of Boundary Conditions

the thickness at each target node, and consequently modify the location used for each target node
during the mapping process. See External Data Import for additional information.

Imported Boundary Remote Constraint


The Imported Cut Boundary Remote Constraint object applies displacements and rotational forces
from beam-based coarse models to shell or solid submodels (p. 439). These loading conditions are gen-
erated from the results defined on the nearest beam node of the coarse model. Using this method, the
application applies each displacement or rotation using remote displacement objects that by default,
are rigid.

The remote loads generated for this option are, by default, read-only. You can modify the properties
of boundary condition as required by setting the Read Only property to Off.

See the Imported Boundary Conditions (p. 1133) section for additional information about the supported
source (coarse) and target (submodel) systems as well as the specific steps to transfer data.

Imported Convection Coefficient


When CFD convection coefficients are transferred to a thermal analysis, an Imported Convection
Coefficient object can be inserted to represent the transfer.

Note

A warning message will appear if negative mapped HTC values are present. Insert a validation
object and use the Source Value option to determine source nodes with values less than
zero.

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Imported Cut Boundary Constraint


The Imported Cut Boundary Constraint (p. 1141) object applies displacements for Solid- or Shell-Solid
submodeling and displacements and rotations for Shell-Solid submodeling.

See the Imported Boundary Conditions (p. 1133) section for additional information about the supported
source (coarse) and target (submodel) systems as well as the specific steps to transfer data.

Imported Cut Boundary Remote Force


The Imported Cut Boundary Remote Force object applies forces (p. 953) and moments (p. 972) from
beam-based coarse models to shell or solid submodels (p. 439). Each remote force and moment pair
share a remote point that is by default, deformable.

The remote loads generated for this option are, by default, read-only. You can modify the properties
of boundary condition by setting the Read Only property to Off.

Requirements
Note the following requirements:

Release 2020 R1 - © ANSYS, Inc.


1141
Setting Up Boundary Conditions

• In order to add beam forces to the results file and make them available for your submodel, you need
to set the Nodal Forces property (Analysis Settings>Output Controls (p. 904)) to On in the coarse
model.

• If your submodel includes only forces and moments and has no other constraints, you must set the
Weak Springs (p. 881) property (Analysis Settings>Solver Settings (p. 877)) to On.

See the Imported Boundary Conditions (p. 1133) section for additional information about the supported
source (coarse) and target (submodel) systems as well as the specific steps to transfer data.

Imported Displacement
When displacements are transferred to a structural analysis, an Imported Displacement object can be
inserted to represent the transfer.

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Note

If one or more nodes with imported displacements have nodal rotations specified on them,
Mechanical attempts to negotiate and apply the imported displacements. The imported
displacements are transformed to the nodal coordinate system and then applied on the
node(s). However, there may be cases when a suitable transformation cannot be obtained
(for example, [x,y,z] -> [fixed, free, free] in the global coordinate system becomes [fixed, fixed,
free] in the nodal coordinate system if the coordinate system is rotated about the z-axis).
For such situations, Mechanical will report a conflict.

Note

For each load step, if an Imported Displacement and other support or displacement constraints
are applied on common geometry or node selections, you can choose to override the specified
constraints by using the Override Constraints property in the details of the Imported Dis-
placement object. By default, the specified constraints are respected and Imported Displace-
ment is applied only to the free degrees of freedom of a node.

Imported Force
When forces are transferred to a structural analysis, an Imported Force object can be inserted to rep-
resent the transfer.

Force is a conservative quantity, which requires the total force (sum total over source points) applied
on the source to match the target. To achieve this, conservative mapping algorithms are available, when
importing force data.

For uniform source and target meshes, profile preserving algorithms along with an appropriate scale
factor, can also be employed to conserve the total force.

In addition to mapping data across the meshes, the import process also calculates and reports the total
force and the individual X/Y/Z components on both the source and target regions. When mapping data
using the conservative algorithm, you can validate that the total force is conserved between source

Release 2020 R1 - © ANSYS, Inc.


1142
Types of Boundary Conditions

and target. For profile preserving algorithms, this information may be used to appropriately apply a
scaling factor.

Note

When you apply total force in the Cylindrical Coordinate System, the application does
not calculate the Force Components in Radial (X) and Tangential (Y) directions. The ap-
plication reports these components as N/A in the summary.

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or External Data Import
for specific steps to transfer data.

Note

• Both conservative and profile preserving algorithms are available for importing force data. Con-
servative algorithms are the default and automatically ensure that the total force is conserved
between source and target.

• Profile preserving algorithms may also be used to import force loads. When using profile preserving
algorithms, the total force on the source and target may not match. Use the scaling factor reported
in the Transfer Summary to appropriately scale the load.

– Profile preserving algorithms are not recommended to be used with non-uniform source or
target meshes.

Imported Heat Flux


When thermal heat is transferred to a thermal environment, an Imported Heat Flux object can be in-
serted to represent the transfer.

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Note

For surface bodies, the thickness of each target node is ignored when data is mapped. When
importing data from an External Data system, the Shell Thickness Factor property enables
you to account for the thickness at each target node, and consequently modify the location
used for each target node during the mapping process. See External Data Import for addi-
tional information.

Imported Heat Generation


An Imported Heat Generation object is created in the Imported Load folder when you transfer Joule
heating from an electric analysis to a thermal analysis. See the Imported Boundary Conditions (p. 1133)

Release 2020 R1 - © ANSYS, Inc.


1143
Setting Up Boundary Conditions

section for additional information about the supported source and target systems as well as the specific
steps to transfer data.

Note

• You can scope an Imported Heat Generation object to bodies, body-based Named Selections,
Elements, and element-based Named Selections only.

• For each time step, the total heat mapped to the target system is available in the Imported Load
Transfer Summary.

• The Joule heating, from an Electric analysis, resulting from limited contact electric conductance
is ignored during this data transfer.

• For each load step, if an Imported Heat Generation load and an Internal Heat Generation load
are applied on common geometry selections, the Imported Heat Generation load takes precedence.
An active Imported Heat Generation load will also overwrite other Imported Heat Generation
loads that exist higher (previously added) in the tree, on common geometry selections. See Ac-
tivation/Deactivation of Loads (p. 875) for additional rules when multiple load objects of the same
type exist on common geometry selections.

• For surface bodies, the thickness of each target node is ignored when data is mapped. When
importing data from an External Data system, the Shell Thickness Factor property enables you
to account for the thickness at each target node, and consequently modify the location used for
each target node during the mapping process. See External Data Import for additional information.

Imported Initial Strain


When strains are transferred to define the state of a structure at the beginning of a structural analysis,
an Imported Initial Strain object can be inserted to represent the transfer. The following supported
strain types can be chosen using Sub Type property in the details of the Imported Initial Strain object:

• Elastic Strain

• Plastic Strain

• Equivalent Plastic Strain

You can import values for all six components of the symmetric strain tensor (XX, YY, ZZ, XY, YZ and ZX).
See External Data Import for additional information.

Imported initial strain from External Data can be mapped and applied either to the centroids or corner
nodes of the selected bodies using the Apply To property in the Details view.

• When the Apply To property is set to Corner Nodes, the imported initial strain can also be scoped to Node-
based Named Selections.

Release 2020 R1 - © ANSYS, Inc.


1144
Types of Boundary Conditions

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Note

• Imported Initial Strain can only be applied at the start of the first step.

Activation/Deactivation of loads (p. 875) is not available for Imported Strain load.

• Imported elastic strain values are not supported for bodies which have the following material
types assigned:

– Materials with kinematic hardening properties

– Gasket materials

– Hyperelastic materials

• Imported plastic strain values are not supported for bodies which have the following material
types assigned:

– Porous media

– Rate-dependent plasticity

– Viscoplasticity

• For shell bodies, the user has the option to import strain on All, Top, Middle, or Bottom shell
face(s).

• For shells with layered sections, All is the only supported option for importing strain on shell
faces.

• Initial strain can only be applied to a shell body with a default coordinate system. If a coordinate
system is specified either directly through the Coordinate System property on the body or in-
directly through the Coordinate System property on Layered Section, then the object becomes
invalid and strain cannot be imported.

Important

Mechanical maps every individual tensor by direct interpolation of individual components. This
is numerically the simplest method but is physically inconsistent especially in nonlinear solid
mechanics applications. See the Recommendations and Guidelines for Mapping of Initial
Stress and Strain Data (p. 1146) section for more information.

Imported Initial Stress


When stresses are transferred to define the state of a structure at the beginning of a structural analysis,
an Imported Initial Stress object can be inserted to represent the transfer.

You can import values for all six components of the symmetric stress tensor (XX, YY, ZZ, XY, YZ and
ZX). See External Data Import for additional information.

Release 2020 R1 - © ANSYS, Inc.


1145
Setting Up Boundary Conditions

Imported initial stress from External Data can be mapped and applied either to the centroids or corner
nodes of the selected bodies using the Apply To property in the Details view.

• When the Apply To property is set to Corner Nodes, the imported initial stress can also be scoped to node-
based Named Selections.

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Note

• Imported Initial Stress can only be applied at the start of the first step.

Activation/Deactivation of loads (p. 875) is not available for Imported Initial Stress load.

• Imported Initial Stress load is not supported for bodies which have the following material types
assigned:

– Materials with kinematic hardening properties

– Gasket materials

• For shell bodies, the user has the option to import stress on All, Top, Middle, or Bottom shell
face(s).

• For shells with layered sections specified, All is the only supported option for importing stress
on shell faces.

• Initial stress can only be applied to a shell body with a default coordinate system. If a coordinate
system is specified either directly through the Coordinate System property on the body or in-
directly through the Coordinate System property on Layered Section, then the object becomes
invalid and stress cannot be imported.

Important

Mechanical maps every individual tensor by direct interpolation of individual components. This
is numerically the simplest method but is physically inconsistent especially in nonlinear solid
mechanics applications. See the Recommendations and Guidelines for Mapping of Initial
Stress and Strain Data (p. 1146) section for more information.

Recommendations and Guidelines for Mapping of Initial Stress and Strain Data
Mechanical maps initial stress and strain data by direct interpolation of individual components. This is
numerically the simplest method but is physically inconsistent especially in nonlinear solid mechanics
applications.

Tensor fields associated with solid mechanics applications – e.g. stress, strains, plastic strains etc. are
not independent of each other. The strains are related to the displacements through the compatibility
equations and the stresses are related to strains through the constitutive equations. In addition, for
plasticity, other equations like the flow rule also relate the plastic strain tensors to the stress tensors.
Hence independent interpolation of these tensors will violate these equations which in turn will create
a globally un-equilibrated state of stress in the mapped domain. So, using these mapped quantities in

Release 2020 R1 - © ANSYS, Inc.


1146
Types of Boundary Conditions

nonlinear solid mechanics applications is not recommended. However, irrespective of these limitations,
if the user wants to use these mapped fields, it is strongly recommended that he uses a dummy load
step in the solver with the imported initial stress/strain results and only apply new loads and/or
boundary conditions if and only if the dummy load step converges and the resulting deformation is
physically consistent with the problem. Generally, the analysis with the dummy load step will not converge
with loads generated via incorrectly mapped stress/strain fields. Even with a chance convergence in the
dummy load step, no guarantee can be given with respect to the correctness of the results.

Mechanical provides an option to view contours of equivalent (von-Mises) stress/strain, as well as in-
dividual components (XX, YY, ZZ, XY, YZ and ZX) using Data option in details pane of Imported Initial
Stress/Strain. User can insert a Mapping Validation (p. 1899) object under the Imported Load, perform
Source Value validation, and turn Display In Parent, On, to view overlapping contours of interpolated
data with source data and compare the equivalent stress/strain from the interpolated data with the
source data.

The equivalent stress and strain are calculated using the von Mises equation:

Figure 32: Equivalent (von-Mises) stress

Figure 33: Equivalent (von-Mises) strain (elastic/plastic/equivalent plastic)

Imported Pressure
When pressures are transferred to a structural or harmonic analysis, an Imported Pressure object can
be inserted to represent the transfer.

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Note

For surface bodies, the thickness of each target node is ignored when data is mapped. When
importing data from an External Data system, the Shell Thickness Factor property enables
you to account for the thickness at each target node, and consequently modify the location
used for each target node during the mapping process. See External Data Import for addi-
tional information.

Imported pressure loads from External Data can be mapped and applied either to the centroids or
corner nodes of the selected element faces 3D or element edges(2D) using the Applied to property in
the Details view.

When imported pressure loads are applied to corner nodes, the Filter property under the Scope group
allows the user to select a subset of the scoped element faces/edges and imports the load only on the
specified subset. To filter a subset of element faces/edges, follow the following steps:

1. Create a nodal Named Selection to select all the nodes in the region of interest.

Release 2020 R1 - © ANSYS, Inc.


1147
Setting Up Boundary Conditions

2. Select the created named selection in the Filter property. You may also choose any pre-existing nodal
Named Selection.

The filtered subset of element edges/faces is then determined by the following:

1. The element faces/edges which have all their corner nodes defined in the filter will be included in the
mapping

2. For the element edges/faces whose corner nodes are only partially defined the filter, i.e. the faces/edges
which have some corner nodes included in the filter, but not all the Include Partial Faces/Edges property
can be used to include or exclude the element faces/edges from the scoping.

Imported Remote Loads


When electromagnetic forces and moments are transferred to a harmonic environment, an Imported
Remote Loads object is inserted into the environment to represent the transfer.

See the Importing Data into a Harmonic Analysis (p. 406) section for the specific steps to transfer data.

Imported Surface Force Density


When electromagnetic surface forces are transferred to a structural environment, an Imported Surface
Force Density object can be inserted to represent the transfer.

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Imported Temperature
When temperatures are transferred to a thermal analysis, an Imported Temperature object can be in-
serted to represent the transfer.

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Note

• For each load step, if an Imported Temperature load and Temperature load are applied on common
geometry or node selections, the Imported Temperature load takes precedence. An active Imported

Release 2020 R1 - © ANSYS, Inc.


1148
Spatial Varying Loads and Displacements

Temperature load will also overwrite other Imported Temperature loads that exist higher (previ-
ously added) in the tree, on common geometry or node selections. See Activation/Deactivation
of Loads (p. 875) for additional rules when multiple load objects of the same type exist on common
geometry selections.

• If a scale factor is specified, the values used in the solution are calculated by first converting the
imported load values into the solver unit system and then multiplying the scale value.

• For surface bodies, the thickness of each target node is ignored when data is mapped. When
importing data from an External Data system, the Shell Thickness Factor property enables you
to account for the thickness at each target node, and consequently modify the location used for
each target node during the mapping process. See External Data Import for additional information.

Imported Velocity
When velocities are transferred to an acoustic analysis, an Imported Velocity object can be inserted
to represent the transfer. Imported velocity objects are not supported in MSUP harmonic analyses

See the Imported Boundary Conditions (p. 1133) section for applicable transfers or for specific steps to
transfer data.

Note

• For surface bodies, the thickness of each target node is ignored when data is mapped. When
importing data from an External Data system, the Shell Thickness Factor property enables you
to account for the thickness at each target node, and consequently modify the location used for
each target node during the mapping process. See External Data Import for additional information.

• An acoustic analysis is performed via ACT. For information on creating optimization extensions,
see the ANSYS ACT Developer's Guide.

Spatial Varying Loads and Displacements


A spatially varying load or displacement has a variable magnitude in a single coordinate direction (x,
y, or z). The following load and displacement types qualify as varying loads and varying displacements,
and can be a function of time as well.

• Pressure (p. 939) (In a Normal direction only during a Static Structural analysis only)

• Line Pressure (p. 979) (In a Tangential direction only during Static Structural analysis only)

• Pipe Pressure (p. 945) (Static Structural analysis only)

• Pipe Temperature (p. 945) (Static Structural analysis only)

• Temperature (p. 989) (thermal analysis only)

• Convection (p. 992) (thermal analysis only)

• Thermal Condition (p. 987) (Static Structural analysis only)

Release 2020 R1 - © ANSYS, Inc.


1149
Setting Up Boundary Conditions

• Displacement (p. 1080) (For Faces, Edges, or Vertices during a Static Structural analysis.)

• Nodal Displacement (p. 1126)

• Nodal Force (p. 1121)

• Nodal Pressure (p. 1123)

For spatial varying loads and displacements, the spatial independent variable uses the origin of the
coordinate system for its calculations and therefore it does not affect the direction of the load or dis-
placement.

To apply a spatial varying load or displacement, set the input as either Tabular (p. 1154) or Function
(p. 1155) in the Details view. You can then view the variable load using the Variable Load toolbar, available
on the Environment toolbar. From this toolbar, select the smooth contours effect, the contour bands
effect, or the isolines effect. Click Max and Min to toggle the maximum and minimum value label display.

Defining Boundary Condition Magnitude


This section describes the methods you can use to define the magnitude of a boundary condition.
Mechanical enables you to define a load value or magnitude as a:

• Constant (p. 1151): defined by a static value or through an Expression (p. 1151)

• Tabular Load (p. 1153): defined by varying time/frequency/space as well as varying per load step (for
Static Structural only).

• Function Load (p. 1155): defined by varying time or space.

In addition, you can import (p. 1158) and export (p. 1159) load histories.

Note

Changing the method of how a multiple-step load value is specified (such as Tabular to
Constant), the Activation/Deactivation state of all steps resets to the default, Active.

Support Limitations
• Tabular Heat Flow loads applied to an edge in a 3D analysis are not supported.

• Function Heat Flow loads applied to an edge in a 3D analysis are not supported.

Release 2020 R1 - © ANSYS, Inc.


1150
Defining Boundary Condition Magnitude

Constant Magnitude Values


Once you have scoped the geometry for your boundary condition, generally, the Magnitude option
defaults to the Constant setting and you can simply enter your desired magnitude value in the field.

As discussed below, you can also define constant values as expressions.

Constant Magnitude Expressions


The Magnitude field defaults to the option Constant. Expressions are simply typed into the field. The
expression is evaluated and applied.

For example and as illustrated, entering the expression =2 + (3 * 5) + pow(2,3) in English in the numeric
field is evaluated as a Magnitude of 25.

The equal sign [=] must be used to begin an expression. Additional operators include: +, -, *, /, ^ (for
power) and % (integer Modulus). Operator examples are shown here:

2+3
10.5-2.5
3.5*3.3
10.12/1.89
2^10
10%3
2*(3+5)

Release 2020 R1 - © ANSYS, Inc.


1151
Setting Up Boundary Conditions

The order of operator precedence is:

parentheses
intrinsic functions (like sin or cos)
power (^)
multiplication (*), division (/) and integer modulus (%)
addition (+) and subtraction (-)

Note

If the decimal separator (p. 22) in the current language is a comma (,) as it is in German,
then the separator for the list of parameters of a function is a semicolon (;).

For example, if an English expression is =2.5 + pow (1.3, 6), the equivalent German expression
is =2,5 + pow (1.3; 6).

The supported intrinsic functions are:

Supported Sample Usage Usage (angles in current Mechanical units setting)


Intrinsic
Functions
sin(x) sin(3.1415926535/2)
Calculate sines and hyperbolic sines.
sinh(x) sinh(3.1415926535/2)
cos(x) cos(3.1415926535/2)
Calculate the cosine (cos) or hyperbolic cosine (cosh).
cosh(x) cosh(3.1415926535/2)
tan(x) tan(3.1415926535/4)
Calculate the tangent (tan) or hyperbolic tangent (tanh).
tanh tanh(1.000000)
Calculates the arcsine. (x - Value whose arcsine is to be
asin(x) asin(0.326960)
calculated).
Calculates the arccosine. (x - Value between –1 and 1 whose
acos(x) acos(0.326960)
arccosine is to be calculated).
atan(x) atan(-862.42) Calculates the arctangent of x (atan) or the arctangent of y/x
atan2(y,x) (atan2). (x,y Any numbers).
atan2(-862.420000,78.514900)
pow(x,y) pow(2.0,3.0) Calculates x raised to the power of y. (x – Base y - Exponent).
sqrt(x) sqrt(45.35) Calculates the square root. (x should be a Nonnegative value).
exp(x) exp(2.302585093) Calculates the exponential. (x - Floating-point value).
Calculates the natural logarithm. (x - Value whose logarithm is
log(x) log(9000.00)
to be found).
Calculates the common logarithm. (x - Value whose logarithm
log10(x) log10(9000.00)
is to be found).
rand() rand() Generates a pseudorandom number.
ceil(2.8) Calculates the ceiling of a value. It returns a floating-point value
ceil(x) representing the smallest integer that is greater than or equal
ceil(-2.8) to x. (x - Floating-point value).

Release 2020 R1 - © ANSYS, Inc.


1152
Defining Boundary Condition Magnitude

Supported Sample Usage Usage (angles in current Mechanical units setting)


Intrinsic
Functions
floor(2.8) Calculates the floor of a value. It returns a floating-point value
floor(x) representing the largest integer that is less than or equal to x.
floor(-2.8) (x - Floating-point value).
Calculates the floating-point remainder. The fmod function
calculates the floating-point remainder f of x / y such that x =
fmod(x,y) fmod(-10.0, 3.0) i * y + f, where i is an integer, f has the same sign as x, and the
absolute value of f is less than the absolute value of y. (x,y -
Floating-point values).

You can also enter hexadecimal (starting with 0x) and octal (starting with &) numbers, for example 0x12
and &12.

Tabular Loads
Tabular data is most often entered using the Magnitude property of the boundary condition. The
Distance property is also an option for Displacements. As illustrated below, from the appropriate
property in the Details view, open the fly-out menu and select Tabular.

Based on your analysis system, enter the appropriate data in the Tabular Data window (pressure, force,
frequency, etc). The Graph window displays the variation of the load with time for Static and Transient
analysis systems or frequency for Harmonic analysis systems.

Release 2020 R1 - © ANSYS, Inc.


1153
Setting Up Boundary Conditions

For varying loads, annotations in the Geometry window display the current time in the Graph window
along with the load value at that time. Tabular Loads allow up to 100,000 entries. For frequency varying
loads, annotations in the Geometry window displays the minimum range of harmonic frequency sweep
and load value of first frequency entry.

Note

• All new data is entered into the row that begins with an asterisk (*) regardless of whether the
time or frequency point is higher or lower than the last defined point in the table. The application
automatically sorts the content of the table into ascending order.

• Any Tabular Data values preceded by an equal sign (=) are not defined table values. These values
are application interpolated values shown for reference.

Spatial Load Tabular Data


When using spatial varying loads (p. 1149), selecting Tabular as the input option displays the Tabular
Data category and based on the entry of the Tabular Data category, the Graph Controls category
may also display.

The Tabular Data category provides the following options:

Independent Variable
The Independent Variable property specifies how the load varies with either Time (default), load
Step (Static Structural only), or in the X, Y, or Z spatial direction. For a Harmonic Response analysis
the default setting is Frequency. And, for certain temperature-based loads, you can select Temper-
ature as the Independent Variable.

Note

• The application typically writes loading values to the input file as a table of values. When
you set the Independent Variable property to Step, the application instead writes a
constant load value for each load step.

• For a Pressure (p. 939) load, the Define By property must be set to Normal To.

• The option Normalized S becomes available for Line Pressure (p. 979) loads in a 3D
analysis when the Define By property is set to Tangential or Pressure (p. 939) loads in
a 2D analysis when the Define By property is set to Normal To.

Release 2020 R1 - © ANSYS, Inc.


1154
Defining Boundary Condition Magnitude

The Normalized S option enables you to define pressure as a function of the


distance along a path whose length is denoted by S. When you select the Normal-
ized S variable, the Tabular Data window accepts input data in the form of nor-
malized values of path length (Normalized S) and corresponding Pressure values.
A path length of 0 denotes the start of the path and a 1 denotes the end of the
path. Any intermediate values between 0 and 1 are acceptable in the table. Load
values are sent to the solver for each element on the defined path based on a
first-order approximation.

Coordinate System
The Coordinate System property displays if you specify the Independent Variable in a spatial direction
(X, Y, or Z). Use this property to specify a coordinate system.

Graph Controls
The Graph Controls category displays when you define the Independent Variable as a spatial direction
(X, Y, or Z), as Normalized S, or as Temperature. This category provides the property X-Axis which
you use to change the Graph window's display. The options of the X-Axis property vary based upon
analysis type and the selection made for the Independent Variable property. Options may include
Time, or the spatial direction specified, or Temperature.

• When the X-Axis property is defined as Time:

– Tabular Data content can be Scaled against time.

– You can Activate and/or Deactivate (p. 875) the load at a solution load step.

– If Time is not an available option of the X-Axis option, then scaling or activation/deactivation
are not possible for the boundary condition.

Function Loads
For entering a mathematical function, click the flyout arrow in the input field (for example, Magnitude),
choose Function, then type a function such as =1000*sin(10*time). Any time values that you are
evaluating can exceed the final time value by as much as one time step. The Graph window displays
the variation of the load with time. Annotations in the Geometry window display the current time in
the Graph window along with the load value at that time. The following functions are supported: sin,
cos, tan, asin, acos, atan, atan2, log, log10, exp, pow, and sqrt.

Spatial Load and Displacement Function Data


When using spatial varying loads or displacements (p. 1149), selecting Function as the input option in
the Details view presents an editable function field. Enter a mathematical expression in this field. Expres-
sions have the following requirements:

• For a Pressure load, the Define By option must be set to Normal To.

• For a Line Pressure load, the Define By option must be set to Tangential.

• You can use the spatial variation independent variables x, y, or z, and time (entered in lowercase) in the
definition of the function.

• For Line Pressure loads in a 3D analysis or Pressure loads in a 2–D analysis, you can also use the variable s,
which allows you to define pressure as a function of the distance along a path whose length is denoted by

Release 2020 R1 - © ANSYS, Inc.


1155
Setting Up Boundary Conditions

s. When defining a path length, valid primary variables you can enter are s alone or s combined with time,
for example, s*time, or s*sin(time/s). Load values are sent to the solver for each element on the defined path
based on a first-order approximation.

• Define only one direction, x, y, or z; or path length, s. After entering a direction or path length, the Graph
Controls category (see above) displays.

When the Details view property Magnitude is set to Function, the following categories automatically
display.

• Function - properties include:

– Unit System – the active unit system.

– Angular Measure – the angular measure that is used to evaluate trigonometric functions.

• Graph Controls - based of the defined function, properties include:

– X-Axis – This provides options to display time or the spatial independent variable in the graph. When set
to Time you can activate and deactivate the load at a solution step.

– Alternate Value – If the function combines time and a spatial independent variable, one of these values
(alternate) must be fixed to evaluate the function for the two dimensional graph.

– Range Minimum – If the X-Axis property is set to a spatial independent variable, this is the minimum
range of the graph. For time, this value defaults to 0.0 and cannot be modified.

– Range Maximum – If the X-Axis property is set to a spatial independent variable, this is the maximum
range of the graph. For time this defaults to the analysis end time and can’t be modified.

– Number of Segments - The function is graphed with a default value of two hundred line segments. This
value may be changed to better visualize the function. The function can be graphed with up to 100,000
segments.

Caution

Specifying larger numbers of points may slow the response time of Mechanical.

Spatial Varying Displacements


You can also apply spatial varying displacements (p. 1077), which have the following additional or unique
characteristics:

• Edge scoping is available.

• Displacements are shown as vectors instead of contours except if you choose Normal To the surface. Vectors
are only displayed if the model has been meshed. The vector arrows are color-coded to indicate their value.
A contour band is included for interpretation of the values. The contour band is the vector sum of the possible
three vector components and therefore will only display positive values.

• For one Displacement object, you can select up to three displacement components that can all vary using
the same direction. If an additional direction is required, you can use an additional Displacement object.

Release 2020 R1 - © ANSYS, Inc.


1156
Defining Boundary Condition Magnitude

• A constant value and a table cannot be used in different components. A table will be forced in any component
having a constant value if another component has a table.

Direction
There are four types of Direction:

Planar Face (p. 1157)


Edge (p. 1157)
Cylindrical Face or Geometric Axis (p. 1158)
Two Vertices (p. 1158)

Planar Face

Selected planar face. The load is directed normal to the face.

Note

Not applicable to Rotational Velocity or Rotational Acceleration. These objects are aligned
along the normal to a planar face and along the axis of a cylindrical face (p. 1158).

Edge
Straight Colinear to the edge

Circular or Elliptical Normal to the plane containing the edge

Selected straight edge

Release 2020 R1 - © ANSYS, Inc.


1157
Setting Up Boundary Conditions

Cylindrical Face or Geometric Axis


Applies to cylinders, cones, tori, and cylindrical or conical fillets. For vector-based loading on a cylindrical
face or geometric axis, you define the radial direction by selecting a different piece of geometry on
your model that allows you to modify the Direction in the desired direction.

Selected cylinder

Two Vertices

2 selected vertices

Note

Hold the CTRL key to select the second vertex.

Loads that require you to define an associated direction include the Define By Details view control.
Setting Define By to Vector allows you to define the direction graphically, based on the selected geo-
metry. Setting Define By to Components allows you to define the direction by specifying the x, y, and
z magnitude components of the load.

Note

If you switch the load direction setting in the Define By field, the data is lost.

Importing Load History


To import a load history from a library:

1. Select the appropriate geometry on the model and do one of the following:

• Click on the appropriate icon on the toolbar and choose the load.

OR...

• Click right mouse button, select Insert, and choose the load.

Release 2020 R1 - © ANSYS, Inc.


1158
Defining Boundary Condition Magnitude

2. Go to the Details view and in the input field, such as the Magnitude field, click the flyout field and
choose Import. Note that the Import feature can present different dependencies, such as time and
temperature.

Choose the desired load history if it is listed, then click OK. If it is not listed, click the Add
button, choose a load history or Browse to one that is stored, then click OK in both dialog
boxes.

Exporting Load History


To export a load history:

By default, any load history that you create in the application remains in the application. To save
the load history for future use:

1. Create a load history using the Graph or Tabular Data windows.

2. Go to the Details view and in the input field, such as the Magnitude field, click the flyout field, choose
Export, and save the file to a specific location.

Release 2020 R1 - © ANSYS, Inc.


1159
Release 2020 R1 - © ANSYS, Inc.
1160
Using Results
The Help for Results is organized in the following sections based on analysis type as well as the treatment
and usage for the various result options.
Introduction to the Use of Results
Result Outputs
Result Definitions
Result Scoping
Structural Results
Acoustic Results
Thermal Results
Magnetostatic Results
Electric Results
Fatigue Results
User Defined Results
Result Utilities

Introduction to the Use of Results


Generating results to understand the behavior of an analyzed model is fundamental to any analysis in
Mechanical. The application supports a variety of result types and tools to facilitate this process.

Some advantageous features include the following capabilities:

• Display result contours over the entire, or a portion, of the model for various solution quantities, such as
displacement, stress, temperature, and electric field density.

• Customized result access using user-defined results (p. 1340).

• Chart (p. 1162) minimum and maximum values over time for multiple result sets.

• Options (p. 87) to quantify and visualization result contours that represent vectors, iso-surfaces, slice planes,
path operations, surface cuts, and capped iso-surfaces.

• Probes (p. 1175) to calculate abstract engineering quantities such as reaction forces, reaction moments, and
virtual strain gauges.

• Export result data in a variety of formats, such as ASCII files for raw data, static images such as .png, .avi an-
imations, as well as HTML reports.

Result Application
To apply Results:

• Highlight the Solution object in the tree. Open the desired Solution Context Toolbar (p. 84) menu and select
a result item, result probe, or result tool.

Or...

Release 2020 R1 - © ANSYS, Inc.


1161
Using Results

• Right-click the Solution object, select Insert, and then choose from the result options.

Note

See the User Defined Result (p. 1340) section of the Help for more information about the spe-
cification and definition of this result type.

Once inserted into the tree, you need to scope (p. 1214) your result objects to geometric or meshing
entities of the model.

Note

• If you suppress any result object, the application clears all generated data.

• Because of software limitations, Mechanical currently cannot display the results of some types
of nodes and elements. For example, a total deformation display in Mechanical excludes the
deformations of nodes that are not attached to elements (like nodes associated with remote
points).

Result Outputs
The following topics related to result outputs are covered in this section.
Chart and Table
Contour Results
Coordinate Systems Results
Path Results
Surface Results
Probes
Result Set Listing
Interpolation
Vector Plots
Solution Summary Worksheet

Chart and Table

The Standard Toolbar (p. 69) option New Chart and Table is a feature that enables you to chart loading
and result data versus time, additional loading conditions, as well as another result data. This includes
the loading conditions and/or results of different analyses. For example, you may wish to compare the
displacement responses from two different transient analyses with multiple damping characteristics.

Use the Chart and Table feature to:

• Chart load(s) and result(s) vs time.

• Chart multiple harmonic response plots vs. Frequency.

• Change x-axis to plot a result against a load or another result.

• Compare results across analyses.

Release 2020 R1 - © ANSYS, Inc.


1162
Result Outputs

• Visualize and compress data into an easy-to-understand report.

Select Loads and Results from Tree


Press the Ctrl or Shift key to select multiple objects of interest. In doing so, note that:

• You can choose objects in the tree that belong to different analyses of a model. However all objects
must belong to the same Model.

• Only loads, probes and results that can be contoured are added to the chart.

• For result items the variation of minimum and maximum values is plotted as a function of time

Select Chart icon from Standard Toolbar


This adds a new chart object to the tree structure. You can add as many charts as needed.

Determining Data Points


You can choose a mixture of loads and results that may even span different analyses. In these cases
there can be a mismatch between the time points at which the loads are defined and the time points
at which results are available. For example in case of a nonlinear transient stress analysis under constant
load, the load has a single value but there can be many time points where results are available. The
below interpolation scheme is used to create charts when such mismatch occurs.

• Loads are interpolated or extrapolated to the time points at which result values or other load values.

• Results are not interpolated or extrapolated

Details View Content


The main categories are:

• Definition:

– Outline Selection: Lists how many objects are used in the chart. Clicking on the number of objects
highlights the objects in the tree allowing you to modify the selection if needed.

• Chart Controls:

– X-Axis: By default the data of the selected objects are plotted against time. You may choose a different
load or result quantity for the x-axis. For example you can plot a Force – Deflection curve by choosing
the deflection to be the X-axis.

– Plot Style: display as Lines, Points, or Both (default).

– Scale:

→ Linear (default) - plot as linear graph.

→ Semi-Log (X) - X-Axis is plotted logarithmically. If negative axis values or a zero value exists, this
option is not supported and the graph plots linearly.

→ Semi-Log (Y) - Y-Axis is plotted logarithmically. If negative axis values or a zero value exists, this
option is not supported and the graph plots linearly.

Release 2020 R1 - © ANSYS, Inc.


1163
Using Results

→ Log-Log - X-Axis and Y-Axis are plotted logarithmically. If negative axis values or a zero value exists,
this option is not supported and the graph plots linearly.

– Gridlines: Show gridlines for plotting 2D X-Y curves.

→ Both - The gridlines for both the X-axis and Y-axis are shown.

→ X Axis - The gridline for the X-axis is shown.

→ Y Axis - The gridline for the Y-axis is shown.

→ None - No gridlines are shown.

• Axis Labels:

– X-Axis and Y-Axis: You can enter appropriate labels for the X and Y axes. In doing so, note that:

→ The X and Y axes always show the units of the item(s) being charted. These units are appended to
any label that you enter.

→ When multiple items are plotted on the Y-axis the units are determined as follows: If all the items
plotted on the Y-axis have the same units then the unit is displayed. For example, if all items are
of type deformation and the active unit system is British Inch unit system then the unit is displayed
as Inch. If the items plotted on the Y-axis are of different types for example, stress and strain then
Normalized is displayed for unit.

→ When determining pairs of points to plot on the chart when X-axis is not time be aware that time
is still used to determine the pairs of points to plot when an item other than time is used for the
x-axis. Both the X-axis quantity and the Y-axis quantity must share a common time point to be
considered a valid pair.

• Report:

– Content: By default both the chart as well as the data listing of the objects gets added to reports.
Instead you may choose to only add the chart or only add the data listing or exclude the chart from
report. Note that only tabular data or chart data with two or more points is displayed in the report.

– Caption: You may enter a caption for the chart. The caption will be included in the report.

• Input Quantities:

– Input Quantities: Any valid load object added to the chart gets displayed under Input Quantities. If
a load has multiple components then each component will get a line in this details group.

– Output Quantities: Any valid result object added to the chart gets displayed under Output Quantities.
If a result has multiple components then each component will get a line in this details group.
In using Input and Output Quantities, note that:

– Naming and legend: Each object added to a chart is assigned a name and a legend label. The name
is simply the object name in the tree if there are no components associated with the object. An ex-
ample would be a Y displacement probe. For objects that have multiple components the component
direction or name will get added to the object name. For example adding ‘Equivalent Stress’ result
item to a chart will result in two items getting added – ‘Equivalent Stress (min)’ and ‘Equivalent Stress
(max)’.

Release 2020 R1 - © ANSYS, Inc.


1164
Result Outputs

– Each name is preceded by a one letter label such as [A] or [B]. This label is also displayed on the cor-
responding curve in the chart and is used to associate the object name with the curve.

– The default setting is to display the item in the chart and data grid. You can exclude an item by setting
this field to Omit. Omitting an item removes the corresponding data from both data grid and chart.
Be aware that an item chosen for X-axis cannot be omitted and this field will be reset to Display for
that item.

Chart Display
• Legend: You can use the right-click context menu options Show Legend/Hide Legend to display or hide
annotations in the Graph window for the selected Chart (p. 1652).

• Normalization: Scaling of Y-axis is determined as follows.

– Single item on Y-axis : Scaling is based on the minimum and maximum values of the item plotted

– Multiple items on Y-axis that have same unit type: Scaling is based on the minimum and maximum
values of the items plotted. For example, plot applied pressure load and a stress result against time.

– Multiple items on Y-axis that have different unit types: In this case each curve is normalized to lie
between 0 and 1, that is the minimum value is treated as zero and the maximum value as one. The label
of the Y-axis reflects this by appending Normalized to any user specified label. Note that the data grid
displays the actual values always.

Datagrid Display
It is read-only.

Contour Results
Most result types (p. 1804) can be displayed using contours or vectors. The Result context toolbar (p. 84)
applies to Solution level objects that display contour or vector results.

Coordinate Systems Results


The following topics are addressed in this section:
Nodal Coordinate Systems Results
Elemental Coordinate Systems Results
Rotational Order of Coordinate System Results

Important

If a given result experiences any change in position due to the loading conditions, such as
a displacement or deformation, the Geometry window always displays this position change
in the Global Coordinate System (per global XYZ coordinate triad). If you have specified a
local coordinate system for your result, the application exposes all data contained in the
Details view as well as the Tabular Data window based the local coordinate system entry.
Furthermore, if applicable, the application always displays result contour colors in the Geo-
metry window based on a specified local coordinate system.

Release 2020 R1 - © ANSYS, Inc.


1165
Using Results

Nodal Coordinate Systems Results


Every node in a model is associated with a coordinate system that, by default, is aligned with the
global Cartesian coordinate system. If any of the X, Y, or Z axes of an individual node is rotated, the
resulting coordinate system will typically not be aligned with the global Cartesian coordinate system.
Using this feature, you can display nodal result rotations either as Euler rotated triads at each node
location, or as contours that represent an Euler rotation angle about an individual nodal axis. Boundary
conditions are highly dependent upon Euler angles.

To display nodal coordinate systems results:

Highlight the Solution object, and choose one of the following options from the Coordinate Systems
drop-down menu in the toolbar. A corresponding object will be inserted in the tree.

• Nodal Triads: Displays an XYZ triad at each node representing the resulting rotation of the node's coordinate
system compared to the global Cartesian coordinate system. See Rotational Order of Coordinate System
Results (p. 1167) for details.

• Nodal Euler XY Angle: Displays a contour plot representing the magnitude of the resulting Euler angle ro-
tation at each node about the Z axis.

• Nodal Euler YZ Angle: Displays a contour plot representing the magnitude of the resulting Euler angle ro-
tation at each node about the X axis.

• Nodal Euler XZ Angle: Displays a contour plot representing the magnitude of the resulting Euler angle ro-
tation at each node about the Y axis.

Note

For the ANSYS solver, nodal coordinate systems will not vary from time step to time step.

Elemental Coordinate Systems Results


Every element in a model is associated with a coordinate system that, by default, is aligned with the
global Cartesian coordinate system. If any of the X, Y, or Z axes of an individual element is rotated, the
resulting coordinate system will typically not be aligned with the global Cartesian coordinate system.
Using this feature, you can display elemental result rotations either as Euler rotated triads at each ele-
ment's centroid, or as contours that represent an Euler rotation angle about an individual elemental
axis. Shell stresses are highly dependent upon Euler angles.

Note

Euler rotated triads and contours of Euler rotation angles are determined by the element
type and not all elements types are supported. If no result data is available for the corres-
ponding element type, then the triads display as global triads.

To display elemental coordinate systems results:

Highlight the Solution object, and choose one of the following options from the Coordinate Systems
drop-down menu in the toolbar. A corresponding object will be inserted in the tree.

Release 2020 R1 - © ANSYS, Inc.


1166
Result Outputs

• Elemental Triads: Displays an XYZ triad at each element centroid representing the resulting rotation of the
element's coordinate system compared to the global Cartesian coordinate system. See Rotational Order of
Coordinate System Results (p. 1167) for details.

Note

You may need to use the Wireframe viewing mode (p. 64) to see a particular triad in an
element.

• Elemental Euler XY Angle: Displays a contour plot representing the magnitude of the resulting Euler angle
rotation at each element centroid about the Z axis.

• Elemental Euler YZ Angle: Displays a contour plot representing the magnitude of the resulting Euler angle
rotation at each element centroid about the X axis.

• Elemental Euler XZ Angle: Displays a contour plot representing the magnitude of the resulting Euler angle
rotation at each element centroid about the Y axis.

Note

For the ANSYS solver, it is possible for elemental coordinate systems to vary from:

• Time step to time step.

• Node to node. In this case, Mechanical displays the angles for the first node in the node
number sequence. For line elements, like beams, the result file does not contain the elemental
Euler angles and as a result Mechanical calculates the coordinate system from the (x, y, z)
positions of the nodes (including the orientation node). Currently, Mechanical does not have
access to the internal nodes created by the solver. Because of these calculations, the triad
for a line element can differ from the triad displayed by the Mechanical APDL application if
you have issued the / /PSYMB ,ESYS,ON command and the Mechanical APDL application
has access to the Mechanical APDL db file.

Rotational Order of Coordinate System Results


The following rotational convention is used for both Nodal Coordinate Systems Results (p. 1166) and
Elemental Coordinate Systems Results (p. 1166):

1. The first rotation is called ... Euler XY and is in the X-Y plane (X towards Y, about Z).

2. The second rotation is called ... Euler YZ and is in Y1-Z1 plane (Y1 towards Z1, about X1).

3. The third rotation is called ... Euler XZ and is in X2-Z2 plane (Z2 towards X2, about Y2).

X1, Y1, and Z1 refer to the coordinate system axes after the initial rotation about the global Z axis.

X2, Y2, and Z2 refer to the coordinate system axes after the initial rotation about the global Z axis and
subsequent rotation about X1.

See Figure 3.2: Euler Rotation Angles from the Modeling and Meshing Guide for a pictorial representation
of this convention.

Release 2020 R1 - © ANSYS, Inc.


1167
Using Results

Path Results
If you have already defined a path (p. 661), you can view the path results by highlighting the result object,
and in the Details view, setting Scoping Method to Path, then choosing the name of the particular
path that you defined.

Note

Path results are not supported for models using periodic or cyclic symmetry.

An example path result plot is shown below.

In this example, the Number of Sampling Points for the Path object was set to 47. Results were calcu-
lated for each of these 47 points as shown in the Graph below.

Release 2020 R1 - © ANSYS, Inc.


1168
Result Outputs

For each point in a path or in a surface, Mechanical chooses precisely one body from which to calculate
the results. If multiple bodies are scoped, Mechanical calculates the results from the body with the
highest identifier (typically the latest one in the geometry tree). No averaging is done of a path result
across bodies.

If a path or a surface traverses multiple shell or solid bodies and if a path (or surface) point lies on the
interface between distinct bodies, it may not be clear which body was employed in the creation of
contour colors for the point. To avoid this situation, select the bodies from which to obtain the results.

For example, a path can be defined by the edge between two shell bodies. If both bodies are scoped,
the result contours on the path can be based on either body. Consider the following properties specified
for a Path:

• Display Option = Averaged

• Average Across Bodies = Yes

In this instance, a result at an (x, y, z) on the path may show contributions from only one body. For
such an (x, y, z) location, these is no averaging across the bodies that contain the location.

In the following three figures, a path lies along the interface of two shell bodies. In the first two figures,
a body is selected on one side of the path.

Release 2020 R1 - © ANSYS, Inc.


1169
Using Results

However, the stresses in the first figure differ from the stresses in the second figure.

Release 2020 R1 - © ANSYS, Inc.


1170
Result Outputs

In the third figure, the result is scoped to both bodies which touch the path.

Release 2020 R1 - © ANSYS, Inc.


1171
Using Results

Note that the stresses displayed in the third figure match those of the second image.

Interpolation and Paths


For a given path, Mechanical examines each element in the set of scoped bodies to determine the set
of elements which contain a point on the path. A path point may reside on a face of an element, in the
interior of an element, or in no element. The set of path points is, in essence, a set of interpolation
points.

Assume, for example, that you request a normal x-axis stress result on the path (that is, SX). For a given
interpolation point (x,y,z) lying on the face or residing in the interior of an element, Mechanical finds
the natural (or normalized) coordinates of the point within the element. Mechanical then interpolates
the corner values of SX, using the natural coordinates and shape functions, to find a value for SX at
(x,y,z).

See the Interpolation (p. 1184) section for additional information.

Release 2020 R1 - © ANSYS, Inc.


1172
Result Outputs

Surface Results
If you have already defined a surface (p. 666), you can view the surface results by first adding a standard
result or user defined result (p. 1340), and in the Details view of the result object, setting Scoping
Method to Surface, then choosing the name of the particular surface that you defined.

Note

Surface results are not supported for models using periodic or cyclic symmetry.

The Details view for a surface result contains an additional item called Average, which can be paramet-
rized.

For example, average stress over the surface is given by:

{ ∫ Stress(X, Y, Z) dAREA} / {TOTAL_AREA}

For some results, the Details view will also contain a Total quantity, such as Total Force, which also
can be parametrized.

The Total quantities are presented in the following table. Currently, if you desire a Total quantity for
Heat Flux, Magnetic Flux Density, Current Density, or Electric Flux Density, you must choose a
vector user defined result. Total Force (as integrated from principal stress vectors) is available to both
standard and user defined results.

Identifier Result Surface Integral


TFVECTORS Heat Flux Heat Rate
BVECTORS Magnetic Flux Density Magnetic Flux
DVECTORS Electric Flux Density Charge
JTVECTORS, JCVECTORS Current Density Current
SVECTORS (also see Vector Stress Tensor Force
Principals (p. 1232))

Interpolation of Data on a Surface


For a given surface (such as the intersection of a cutting plane and a finite element mesh), Mechanical
examines each element in the set of scoped bodies to determine if any element edge was intersected
by the surface. A surface may intersect multiple edges of a finite element, so Mechanical maintains a
list of all (x,y,z) points and all element IDs from the edge intersections. This set of intersection points
is, in essence, a set of interpolation points.

Release 2020 R1 - © ANSYS, Inc.


1173
Using Results

For example, you request a normal x-axis stress result on the surface (that is, SX). For a given interpol-
ation point (x,y,z) lying on an edge of an element, Mechanical finds the natural (or normalized) co-
ordinates of the point within the element. Mechanical then interpolates the corner values of SX, using
the natural coordinates and shape functions, to find a value for SX at (x,y,z).

See the Interpolation (p. 1184) section for additional information.

Force and Moment Reactions


For a pre-defined surface, a surface probe enables you to study reactions on cutting planes. You can
extract generated member forces and reactions through a model by using a reaction probe scoped to
a surface.

For this probe type, you must explicitly select the bodies to be sliced. You cannot apply this to “all
bodies.” You then specify for the Extraction detail whether you want to study nodes in front or behind
the plane. The probe will only operate on elements cut by the plane (and only nodes on those elements
which are on the selected side of the plane). Note that the surface probe will display nodal forces for
all nodes that are involved in the reaction calculation.

Release 2020 R1 - © ANSYS, Inc.


1174
Result Outputs

Surface Displays and Fracture


Mechanical analyzes for duplicates the sets of (x,y,z) for the facets in a surface construction object and
compresses it by discarding all duplicate (x,y,z) sets. Mechanical employs compression to reduce the
size of the data cache and to improve performance.

For each remaining (x,y,z) in the surface, Mechanical derives via interpolation the results (like displace-
ments and stresses) from precisely one element. That is, even if an (x,y,z) resides in many elements,
Mechanical only fetches the displacements from one element.

Hence, interpolated displacements at the (x,y,z) may currently fail to demonstrate the proper deformation
of a crack.

Probes
Probes allow you to find results at a point on the model, or minimum or maximum results on a body,
face, edge, or vertex; to find results on objects in the tree, such as elastic support or weak springs; or
to obtain reaction forces and moments at supports.

Important

Shell Geometry Scoping Limitation

Release 2020 R1 - © ANSYS, Inc.


1175
Using Results

Because the application can extract results from the top, bottom, or mid-surface locations
of a shell geometry, probes results can produce different results at a node based on the type
of scoping performed, either by Geometry Selection or using a Coordinate System. This is
due to the fact that a probe scoped by a Coordinate System interpolates the result at the
interior location whereas a probe scoped to a Geometry Selection uses uninterpolated node-
based values from the top and bottom nodes of the element (or layer).

This section examines the general function of the probe tool in Mechanical as well as the specific probe
types that are available in the Mechanical application. It also describes the Details view options associated
with the Probe object.
Overview and Probe Types
Probe Details View

Overview and Probe Types


The following probe types are available:

• Structural Probes (p. 1279)

• Thermal Probes (p. 1314)

• Magnetostatic Probes (p. 1319)

• Electric Probes (p. 1322)

You insert a Probe object under Solution in the tree, from the toolbar or from a right mouse button
click. You can adjust options in the Details view or add results for specific points/geometry. When you
solve the probe, the display of the result probe reveals the displaced mesh for the specified time. The
probe shows values over time and for a specified time. The Details view shows either the maximum or
minimum value over time.

Note

You cannot turn off the time history for result probes.

Scoping
Probes are customized for the particular result type, therefore, different probes enable different scoping
mechanisms. For example, a reaction probe allows scoping to a boundary condition while a stress probe
will allow scoping to an x, y, z location on the geometry. Refer to the “Characteristics” column of the
tables in the linked sections above for scoping. Use Location Method in the Details view of the probe
to scope to the desired entity.

When you create a probe by selecting a location on the model or by assigning a coordinate system,
Mechanical associates a small subset of nodes that reside near the probe. The value of this probe is
interpolated from the values at these neighboring (undeformed) nodes. The interpolation is based on
the original node locations and not a function of the displaced position of the probe or of the nodes.
When picking a specific x, y, z location, you can obtain the probe result directly at the closest corner
node, without extra interpolation, by right-clicking on the probe object in the tree and choosing Snap
to mesh nodes from the context menu. The identification number of the closest corner node is displayed

Release 2020 R1 - © ANSYS, Inc.


1176
Result Outputs

as the Node ID in the Details view of the probe in the Results category. See the Interpolation (p. 1184)
section for additional information.

Note

Line Body
If you attempt to intersect probes with a line body, Mechanical issues a warning message.
No results (such as stresses or displacements) will appear in the details view of the probe.

Surface Body
For surface bodies with expanded thickness, because the snapping location is located on
the expanded mesh, while other items such as the original x, y, z location and the node ID
are on the non-expanded mesh, you are advised to turn the visual expansion (p. 94) off in
order to best view these items.

Element Face
Probes do not support element face scoping.

Specific Scoping Requirements

Note the following specifications when scoping a probe:

• When you create a probe by scoping a vertex, edge, face, or volume, the results reported for the probe
are for the undisplaced nodes and elements. The displaced location of the probe (if any) is not used in
any way to calculate results.

• If a probe is scoped to any suppressed parts, then the probe will not solve or evaluate results. This
strategy exists to prevent numeric contributions from elements and nodes that are not scoped.

Scoping Limitations

Reaction, Summation, and Torque


If you apply a Force Reaction or Moment Reaction (p. 1290), Force Summation (p. 1319), or Torque (p. 1319)
probe using a geometry entity (Location Method = Geometry Selection) that shares more than one
body, then the (unscoped) adjacent elements of the scoped body can contribute to the probe's results.
The Geometry Selection option, regardless of whether you select vertices, edges, or faces, chooses
only nodes on the entity. The application then also selects any elements attached to the nodes. As a
result, you can have additional elements (that contribute to the probe results) that are not included
in the geometry scoping.

Shells
Shell element node-based results (like stress and strain) exist at the top, bottom, and middle of the
shell element (or the layer). Therefore, a shell node can have three values for a given layer.

For result probes on shell models that are scoped by Geometry Selection, the probe normally
considers the top value and bottom values at the scoped nodes and picks either the maximum
or minimum value. Based on the probe type, the Spatial Resolution property enables you to
select whether the application uses the maximum or minimum value.

If you scope your probe to a Coordinate System, the application performs an interpolation using
the values at the top and bottom of the shell.

Release 2020 R1 - © ANSYS, Inc.


1177
Using Results

With these situations in mind, your scoping may present results with unexpected or non-intu-
itive values.

For example, consider a probe scoped to a coordinate system that is situated near a vertex at
the mid-plane. For this situation, the interpolation is a simple arithmetic average. However,
what if the Top value at the node is -1000 and the Bottom value at the same node is 1000,
a very real scenario for shell models. The coordinate system probe would report (-1000 + 1000)/2
= 0.

Now consider the probe scoped by geometry to the same Vertex. It would report max(-1000,
1000) = 1000 if the Spatial Resolution property was set to Use Maximum.

Results Output Coordinate System


Some probes such as the Directional Deformation probe allow the results to be calculated and displayed
in a coordinate system of your choice. Some other probes such as a Spring probe allow results to be
output only in a specific coordinate system. Refer to Orientation Coordinate System: entry under
the “Characteristics” column in the probe tables (see links above) regarding what coordinate systems
are allowed and what the default coordinate system is. You can use Orientation in the Details view of
the probe to change the output coordinate system.

Note

When the Orientation Coordinate System is Global Cartesian, the triad (p. 147) symbol is not
displayed. The exception is for Torque probes in magnetostatic analyses, where the global
triad is displayed and the direction vector is placed at the global origin.

Limitations of Geometry-Based Probes


The following table shows the limitations of geometry-based Probe results. If you make incorrect selec-
tions in the Details view for any of the probes, all the probes under solution remain unsolved.

Components and Prin-


Must be Scoped to All Result Selection
Probe Scope cipals Result Selection
a rigid part invalid
invalid
Deformation X
Stress X X
Strain X X
Vertices,
1
Thermal Flux Edges, X
1 Faces, or
Flux Density X
1 Volume
Flux Intensity X
Velocity X
Acceleration X
Position X
1
Angular Velocity X
Angular
X
Acceleration1

1 - Not supported in explicit dynamics analyses.

Release 2020 R1 - © ANSYS, Inc.


1178
Result Outputs

Probe Details View


The following table describes the Probe Details view categories and properties. All Probes provide the
same Details view categories, however, based on the probe type and/or how you specify the probe
properties; the availability of the properties can differ.

Category Property Name and Description


Definition Type
This read-only property displays the selected type of probe.

Location Method
Sets the probe location. Based upon the probe type, Location Method options
include:

Geometry Selection
Default setting, indicating that the probe is applied to a geometry or
geometries (X, Y, Z points, edge/edges, vertex/vertices, face/faces, or
body/bodies), which are chosen using a graphical selection tools.

If you select a point using the Hit Point selection tool (see Graphics
Toolbar (p. 70)), the read-only X,Y, Z Coordinate properties display
and show the coordinate locations.

Geometry : Visible when the Location Method is set to Geometry


Selection. Displays the type of geometry (Body, Face, etc.) and the
number of geometric entities (for example: 1 Body, 2 Edges) to
which the boundary has been applied using the selection tools.

Coordinate System
Use this property to set the location according to a user-defined coordinate
system. This choice displays a Location drop-down list where you pick the
particular coordinate system. The X,Y,Z Coordinates of the location are also
displayed.

Coordinate System : Visible when the Location Method is set to


Coordinate System. Provides a drop-down list of available
coordinate systems.

Remote Points
Use this property to scope the probe to a remote point.

Remote Points : Visible when the Location Method is set to Re-


mote Points. Provides a drop-down list of available remote points.

Boundary Condition
This Location Method option is available for Force Reaction and Moment
Reaction probes in structural analyses. It is also available for the Reaction
Probe in thermal, electric, and thermal-electric (as Heat Reaction) analyses.
And it is available for the Radiation Probe in thermal as well as
thermal-electric analyses. Use this property to scope the probe to an existing
boundary condition.

Release 2020 R1 - © ANSYS, Inc.


1179
Using Results

Category Property Name and Description


Boundary Condition: Visible when the Location Method is set to
Boundary Condition. This property provides a drop-down list of
available boundary conditions.

Spring
Use this property to scope a Force Reaction probe to an existing body-ground
spring that you select from a drop-down list of available body-ground springs.

Spring: This associated property is visible when the Location


Method is set to Spring. This property provides a drop-down list
of available body-ground springs.

Contact Region
Use this property to scope Force Reaction, Moment Reaction, and heat
Reaction (thermal analyses only) probes to an existing contact region that
you pick from a Contact Region drop-down list.

Contact Region: Visible when the Location Method is set to


Contact Region. This property provides a drop-down list of
available contact regions.

Beam
Use to scope the probe to an existing boundary condition that you pick from
a Beam drop-down list.

Beam: Visible when the Location Method is set to Beam. Provides


a drop-down list of available beams objects.

Mesh Connection
Use this property to scope the probe to an existing mesh connection in the
tree.

Mesh Connection: Visible when the Location Method is set to


Mesh Connection. This property provides a drop-down list of
available mesh connection objects.

Surface
Use the scope to probe to a surface and study reactions on cutting planes.

Surface: Visible when the Location Method is set to Surface.


Provides a drop-down list of available surface objects.
Geometry: This property corresponds to the Surface property
when the Location Method is set to Surface. Select a geometry
Body.

Boundary Condition
This property is available for a number of probe types. It provides a drop-down
list of available boundary conditions that you use to scope the probe to.

Orientation
Sets the direction of the coordinate system specified by the Coordinate System
described above.

Release 2020 R1 - © ANSYS, Inc.


1180
Result Outputs

Category Property Name and Description


Spring
This property displays when the Location Method is set to Spring. It provides
a drop-down list of available body-ground springs that you use to scope the
probe to.

X coordinate
A read-only property that displays X Axis value for the Coordinate System
property.

Y coordinate
A read-only property that displays Y Axis value for the Coordinate System
property.

Z coordinate
A read-only property that displays Z Axis value for the Coordinate System
property.

Summation
Displayed only for Moment Reaction probes when Orientation is also displayed.
Allows you to specify the summation point where the moment reaction is
reported.

• Centroid: The simple calculated average; unweighted by length, area, or


volume.

• Orientation System; The coordinate system you specified with the Orientation
setting.

By
Harmonic Response Analysis Only.

This property displays for the Force Reaction and Moment Reaction
probes. Property options include:

Frequency
When this option is specified, a Frequency entry property and the Sweeping
Angle property also display.

Set
When this option is specified, a Frequency entry property and the Sweeping
Angle property also display.

Maximum Over Frequency


When this option is specified, the Sweeping Angle property also displays.

Frequency of Maximum
When this option is specified, a Frequency entry property and the Sweeping
Angle property also display.

Maximum Over Phase


When this option is specified, the Frequency property and Phase Increment
property also display.

Release 2020 R1 - © ANSYS, Inc.


1181
Using Results

Category Property Name and Description


Phase of Maximum
When this option is specified, a Frequency entry property and Phase Incre-
ment property also display.

Extraction
Displayed only for Force Reaction and Moment Reaction probes when the
Location Method is set to Contact Region or Mesh Connection.

Options for Contact Region Setting


When the Location Method is set to Contact Region, options include:

• Contact (Underlying Element)

• Target (Underlying Element)

• Contact (Contact Element) (p. 1298) (Force Reaction Probe only)

Options for Mesh Connection Setting


When the Location Method is set to Mesh Connection, options include:
Master or Slave.

Orientation Method
Only displayed for a Joint Probe. Options include Joint Reference System and
User Specified.

Options Result Selection


The options for this property vary based on the selected type of probe. See the
Overview and Probe Types (p. 1176) section for additional information based on
your desired probe type.

Display Time
End Time or Time Step.

Spatial Resolution
When edges, vertices, faces, or bodies are selected as the Geometry, this property
displays. It allows you to calculate the maximum (Use Maximum) or minimum
(Use Minimum) result values across the given geometry selection.

Result Type
This property provides a list of available results for a Joint Probe.

Results This category provides read-only properties of result you select in the Result
Selection or Result Type drop-down list. The Node ID is displayed if you used
the Snap to mesh nodes feature.
Maximum Value This category provides read-only properties that vary based on the probe type.
Over Time They display maximum values of the results you select over time in stepped
analysis.
Minimum Value This category provides read-only properties that vary based on the probe type.
Over Time They display minimum values of the results you select over time in stepped
analysis.

Release 2020 R1 - © ANSYS, Inc.


1182
Result Outputs

Category Property Name and Description


Information Based on the probe type, the following read-only result-based properties may
be provided by this category.

• Time

• Load Step

• Substep

• Iteration Number

• Surface Area

Note

• When you set Location Method to Coordinate System, the probe traverses the primary axes
to determine where the hits occur on the model. The hit closest to the origin of the coordinate
system is used. This behavior is similar to placing a laser at the origin of the system and then
shooting the laser sequentially along positive and negative direction of x, y, z axis.

• Probe objects scoped to x, y, z picking locations (using the Hit Point selection tool) are achieved
in such a way that a projection of the picked location in screen coordinates occurs onto the
model based on the current view orientation, in other words, normal to the display screen onto
the model at the picked location on the screen. If the geometry is updated, the update of the
projection will follow the original vector that was established “behind the scenes” when the x,
y, z pick was first made. Therefore the update of Probe objects scoped to x, y, z picking locations
may not appear to be logical since it follows a vector that was established dependent on a view
orientation when the original pick was made.

• Probe animation for joints is only supported if there is at least one rigid body.

• Probes are designed to work with geometry entities only. They are not intended to probe dis-
placements on remote locations.

• The details view of the probe shows either the maximum or the minimum result values but not
both.

Result Set Listing


Once you have solved a Static Structural, Transient Structural, and thermal analyses, the Solution (p. 1817)
object displays a list of multiple result sets, as illustrated below, in the Tabular Data window. This is a
default feature. The Changed Mesh portion of this display is only applicable if your analysis has specified
a Nonlinear Adaptive Region (p. 1112) condition. This column displays whether the application regener-
ated the mesh during the analysis and it displays only when mesh regeneration takes place.

Release 2020 R1 - © ANSYS, Inc.


1183
Using Results

The context menu for this feature is illustrated below. Common selection/copy/export options are
available as well as the ability to create new Total Deformation, Equivalent Strain, and Equivalent Stress
results based on an available result set. However, these options are only available if displacement, strain,
and stress data is present in the results file. And, they are not available for thermal analyses.

Interpolation
Interpolation is a result calculation performed when you wish to study results at a location where no
nodes exist. For example, Path results (p. 1168), Surface results (p. 1173), and some probes result ob-
jects (p. 1176) can consist of arbitrary (i.e., non-node-based) locations. To calculate a result at these types
of locations, Mechanical employs an interpolation algorithm. For a given x, y, z in the object, the algorithm
identifies the element that contains x, y, z. If x, y, z is not contained in any element, the algorithm pro-
duces no results.

Release 2020 R1 - © ANSYS, Inc.


1184
Result Outputs

A Newton's Method loop, with the aid of element shape functions and their derivatives, attempts to
converge to the natural (element) coordinates corresponding to the global x, y, z. Using the natural
coordinates, the element shape functions, and the results at the element's nodes, Mechanical computes
the interpolated result value for the global x ,y, z location.

Limitations and Conditions


Interpolation primarily applies to degree of freedom results such as temperatures, displacements, and
node-based element results like thermal flux, stress, and strain.

Therefore, it is recommended that you not use interpolation for results such as node-based element
reactions (EHEAT/ENFO). The application allows for these calculations, but they are not good candidates
for interpolation. In addition, you should not sum interpolated results of these types; such as to calculate
total heat or total force.

Convergence
There is no assurance that convergence actually occurs. If Newton fails to converge, natural coordinates
of (0, 0, 0) are chosen. Currently, no warnings are issued for convergence problems.

Expression-Based User Defined Results


Interpolation should be limited to simple linear combinations of results.

If the application performs an interpolation on an expression-based User Defined Result (p. 1340), it
generates the final result based on the order of the calculations taking place. For example, given
the expression SX^3, for the cube of normal stress in the X direction, at each node the application
calculates SX^3 values. The interpolation occurs next for each (x,y,z) that requires a result and the
application interpolates nodal values of SX^3. The critical point is that this procedure would produce
different results if it first interpolated the nodal values of SX to the x,y,z values and then calculated
SX^3.

Given a complex expression, such as (SEQV / SX)^3, the final interpolated results on a line or a surface
could may be counter intuitive. This is why it is recommended that interpolation be limited to simple
linear combinations of results.

Vector Plots
Certain result items can be displayed using vectors such as the vector principal stresses or vector prin-
cipal strain results. Similarly total deformation, total velocity and total acceleration can also be displayed
using vectors. Using the Graphics button, you can display results as vectors with various options for
controlling the display. See the Vector Display Context Toolbar (p. 89) section for more information.

Solution Summary Worksheet


Once your solution is complete, you can display the Solution Quantities and Result Summary page
of the Worksheet (p. 48) by either selecting the Worksheet button on the Standard Toolbar (p. 69)
or by right-clicking on the Solution (p. 1817) object and selecting the option Worksheet: Result Summary.

As illustrated in the images below, the Worksheet Solution Quantities and Result Summary provides
the following options at the top of the page:

• Available Solution Quantities: This option provides a list of the User Defined Results available in the
result file. See the Application (p. 1342) section of the User Defined Results (p. 1340) section of the Help for
the steps to use the Worksheet content available for this option.

Release 2020 R1 - © ANSYS, Inc.


1185
Using Results

• Material and Element Type Information: This option displays a summary of all the Material and Element
Type data present on the results file. You can use this data as a scoping option (p. 1218) for new result
calculations. See the Result File Item Worksheet Features (p. 1188) topic below for the features available
for this Worksheet selection.

• Solver Component Names: This option lists the Mechanical APDL Solver components present on the
results file. These components are 1) node- or element-based groupings, 2) node- and element-based
Name Selections that were written to the result file from Mechanical, or 3) components that the solver
needed to generate in order to properly solve the analysis. Solver generated components typically

Release 2020 R1 - © ANSYS, Inc.


1186
Result Outputs

contain an underscore (i.e. "_") at the beginning of the Component Name. You can use these components
a scoping option (p. 1218) for new result calculations. See the Result File Item Worksheet Features (p. 1188)
topic below for the features available for this Worksheet selection.

• Result Summary: This option provides a tabular display of the minimum and maximum values of the
available results, the associated units of measure, unit of measure, and time step values.

Result Summary Features


For the results displayed by the Result Summary option, each table entry provides the right-click option,
Go To Selected Items In Tree, to select and then graphically display the corresponding result object.

Release 2020 R1 - © ANSYS, Inc.


1187
Using Results

If a result is included in the tree but not yet evaluated, indicated by a yellow thunder bolt icon, the
Worksheet displays a value of zero (note table entries above).

Result types supported by this feature include:

• Normal Contour/Vector type results such as Stress, Temperature, and Deformation.

• User Defined Results.

• Force and Moment Reaction Probes.

• Joint Probes reporting Force or Moment.

• Spring Probes.

• Bolt Pretension Probes.

Result File Item Worksheet Features


As described below, the Worksheet for the Material and Element Type Information and Solver
Component Names options offers a number of use features.

Collapsing Consecutive IDs


The Collapse Consecutive IDs option is available for the Material and Element Type Information
Worksheet display. As highlighted, this option organizes like materials and/or elements into singular rows
in the table as opposed to creating a lengthy table list that repeats the same ID information. This option
is active by default. Note that Element Type IDs do have a consecutive range of values and that this option
displays this range when collapsed.

Release 2020 R1 - © ANSYS, Inc.


1188
Result Outputs

Contextual Menu Options


You can right-click on a table listing to display option in order to automatically create a result. Based on
your analysis type, the options include Create Total Deformation Result, Create Equivalent Stress
Result, and Create User Defined Result (p. 1342) for structural analyses and Create Temperature Result
and Create User Defined Result (p. 1342) for thermal analyses.

The contextual menu also includes the option Plot Selection. This option displays the elements or
nodes on your model that are associated with the data (row or rows) selected in the Worksheet. In
order to see these associated nodes and/or elements, you need to move the Worksheet so that you
can also see the Geometry window. Refer to the Moving and Docking topic in the Windows Man-
agement (p. 6) section.

Release 2020 R1 - © ANSYS, Inc.


1189
Using Results

Note

Double-clicking a single Worksheet row also plots the node selections for that row.
This feature only works for a singular selection.

Previous and Next Selections


If the Worksheet includes a large number of nodes, the table provides Next and Previous options at the
end of the table so that you can display the next page of data.

Result Definitions
The following topics related to result definitions are covered in this section.
Applying Results Based on Geometry
Result Coordinate Systems
Material Properties Used in Postprocessing
Clearing Results Data
Averaged vs. Unaveraged Contour Results
Multiple Result Sets
Surface Body Results (including Layered Shell Results)
Unconverged Results
Handling of Degenerate Elements
Result Data Display Error Handling

Important

Note the following application result calculations applicable to Coordinate System selection.

Quantities such as Equivalent Stress (SEQV) and Thermal Flux Sum (TFSUM) are derived from
entities like tensors and vectors.

Release 2020 R1 - © ANSYS, Inc.


1190
Result Definitions

If the tensors or vectors are in the Solution Coordinate System and if the elemental coordinate
systems vary from element to element (i.e., shell model), then the process of averaging can
affect Equivalent Stress values, as well as the values of other derived quantities.

Therefore, if you specify the Solution Coordinate System option for the Coordinate System
property, you cannot expect the averaged SEQV solution to be the same as when you specify
the Global Coordinate System option for the Coordinate System property.

Furthermore, for results that can display unaveraged contour results, if you specify Unaveraged
for the Display Option property, the SEQV solution for Solution Coordinate System is the
same as the solution for Global Coordinate System setting.

In addition, if you are performing a Design Assessment analysis in combination with a Re-
sponse Spectrum analysis, the averaged Equivalent Stress (SEQV) result of Design Assessment
system may not match the averaged Equivalent Stress (SEQV) result of corresponding Response
Spectrum system. This is because:

• Equivalent Stress (SEQV) result in Response Spectrum is in Solution Coordinate System which
is not exposed in Details view.

• Equivalent Stress (SEQV) result in Design Assessment is in Global Coordinate System which
is not exposed in Details view.

Applying Results Based on Geometry


The available result objects are based on the given geometry and the analysis type. The following tables
outline which bodies can be represented by the various choices available in the drop-down menus and
buttons of the Solution toolbar (p. 84).

Static Structural Analysis

Geometry Solution Toolbar Options


Deforma- Strain (p. 1229) Stress Tools User Defined Result
tion (p. 1226) (p. 1229) (p. 1340)
Solid Body Total, Direc- All choices All choices Stress (p. 1254), Yes
tional Fatigue
(p. 1337), Con-
tact (p. 1268)
1 (p. 1195)

Surface Body Total, Direc- All choices All choices Stress (p. 1254), Yes
tional Fatigue
(p. 1337), Con-
tact (p. 1268)
1 (p. 1195)

Line Body: Total, Direc- All choices, All Contact Yes


Beam 4 tional except applicable (p. 1268) 1 (p. 1195)
(p. 1196) Equivalent choices, , Beam
(von-Mises), except Error (p. 1275)
Equivalent
Plastic,

Release 2020 R1 - © ANSYS, Inc.


1191
Using Results

Equivalent
Creep,
Equivalent
Total
Line Body: Total, Direc- None None Contact Yes
Pipe tional (p. 1268) 1 (p. 1195)
, Beam
(p. 1275)

Transient Analysis

Geometry Solution Toolbar Options


Deformation Strain Stress Tools User Defined Result
(p. 1226) (p. 1229) (p. 1229) (p. 1340)
Solid Body All choices All choices All choices Stress (p. 1254), Yes
Fatigue
(p. 1337), Con-
tact (p. 1268)
1 (p. 1195)

Surface Body All choices All choices All choices Stress (p. 1254), Yes
Fatigue
(p. 1337), Con-
tact (p. 1268)
Line Body: All All choices, All Contact Yes
Beam 4 except applicable (p. 1268) 1 (p. 1195)
(p. 1196) Equivalent choices, , Beam
(von-Mises), except Error (p. 1275)
Equivalent
Plastic,
Equivalent
Creep,
Equivalent
Total
Line Body: All None None Contact Yes
Pipe (p. 1268) 1 (p. 1195)
, Beam
(p. 1275)

Modal and Eigenvalue Buckling Analyses

Geometry Solution Toolbar Options


Deformation Strain Stress Tools User Defined Result
(p. 1226) (p. 1229) (p. 1229) (p. 1340)
Solid Body Total, Direc- All All choices None Yes
tional applicable
choices,
except En-
ergy

Release 2020 R1 - © ANSYS, Inc.


1192
Result Definitions

Surface Body Total, Direc- All All choices None Yes


tional applicable
choices,
except En-
ergy
Line Body: Total, Direc- All choices, All None Yes
Beam 4 tional except applicable
(p. 1196) Equivalent choices,
(von-Mises), except Error
Equivalent
Plastic,
Equivalent
Creep,
Equivalent
Total
Line Body: Total, Direc- None None None Yes
Pipe tional

Random Vibration Analysis

Geometry Solution Toolbar Options


Deformation Strain Stress Tools User Defined Result
(p. 1226) (p. 1229) (p. 1229) (p. 1340)
Solid Body Directional, Normal, Equivalent None No
Directional Shear (von-Mises),
Velocity, Direc- Normal,
tional Acceler- Shear
ation
Surface Body Directional, Normal, Equivalent None No
Directional Shear (von-Mises),
Velocity, Direc- Normal,
tional Acceler- Shear
ation
Line Body: Directional, Normal, Equivalent None No
Beam 4 Directional Shear (von-Mises),
(p. 1196) Velocity, Direc- Normal,
tional Acceler- Shear,
ation Membrane
Stress,
Bending
Stress
Line Body: Directional, None None None No
Pipe Directional
Velocity, Direc-
tional Acceler-
ation

Response Spectrum Analysis

Geometry Solution Toolbar Options

Release 2020 R1 - © ANSYS, Inc.


1193
Using Results

Deformation Strain Stress Tools User Defined Result


(p. 1226) (p. 1229) (p. 1229) (p. 1340)
Solid Body Total, Direc- Normal, Equivalent None No
tional, Direc- Shear (von-Mises),
tional Velo- Normal,
city, Direction- Shear
al Accelera-
tion
Surface Body Total, Direc- Normal, Equivalent None No
tional, Direc- Shear (von-Mises),
tional Velo- Normal,
city, Direction- Shear
al Accelera-
tion
Line Body: Total, Direc- Normal, Equivalent None No
Beam 4 tional, Direc- Shear (von-Mises),
(p. 1196) tional Velo- Normal,
city, Direction- Shear,
al Accelera- Membrane
tion Stress,
Bending
Stress
Line Body: Total, Direc- None None None No
Pipe tional, Direc-
tional Velo-
city, Direction-
al Accelera-
tion

Steady-State Thermal and Transient Thermal Analyses

Geometry Solution Toolbar Options


Thermal (p. 1311) User Defined Result (p. 1340)
Solid Body Temperature, Total Heat Flux, Yes
Directional Heat Flux, Error
Surface Body Temperature, Total Heat Flux, Yes
Directional Heat Flux, Error
Line Body: Temperature (p. 1312) Yes
Beam 4
(p. 1196)
Line Body: All choices No
Thermal Flow

Magnetostatic Analysis

Geometry Solution Toolbar Options


Electromagnetic (p. 1316) User Defined Result (p. 1340)
2 (p. 1196)
Solid Body All choices Yes

Release 2020 R1 - © ANSYS, Inc.


1194
Result Definitions

Surface Body Not Applicable Yes


Line Body None Yes

Electric Analysis

Geometry Solution Toolbar Options


Electric (p. 1321) User Defined Result (p. 1340)
Solid Body All choices Yes
Surface Body Yes Yes
Line Body Yes Yes

Harmonic Response Analysis (Deformation, Strain, Stress)

Geometry Solution Toolbar Options


Deformation (p. 1226) Strain (p. 1229) Stress (p. 1229)
3 (p. 1195)
Solid Body All choices All choices, except En- All choices
ergy, Thermal, Equival-
ent Plastic
Surface Body All choices 3 (p. 1195) All choices, except En- All choices
ergy, Thermal, Equival-
ent Plastic
Line Body: All choices All choices, except All choices
Beam 4 Equivalent
(p. 1196) (von-Mises), Energy,
Thermal, Equivalent
Plastic, Equivalent
Creep, Equivalent
Total
Line Body: All choices None None
Pipe

Harmonic Response Analysis (Frequency Response, Phase Response, User Defined Result)

Geometry Solution Toolbar Options


3 (p. 1196)
Frequency Response Phase Response User Defined Result
3 (p. 1196)
(p. 1340)
Solid Body All choices All choices Yes
Surface Body All choices All choices Yes
Line Body All choices All choices Yes

1 - Contact results are not reported, and are not applicable to the following:

• Edges.

• MPC contact.

• Target side of asymmetric contact.

Release 2020 R1 - © ANSYS, Inc.


1195
Using Results

2 - Electric Potential can only be scoped to conductor bodies.

3 - See Harmonic Analysis (p. 211) section.

4: See the Line Bodies (p. 498) section for more information about the requirements associated with
specifying a Line Body as a Beam.

Result Coordinate Systems


The application, by default, creates a global coordinate system for your model when it is imported. A
variety of environmental objects use the Global Coordinate System option during the analysis.

A Coordinate System property is available for results that change with respect to a coordinate system,
such as Normal Stress. For the applicable result types, the Coordinate System property provides a drop-
down list of available coordinate system options, which include:

• Global Coordinate System (default setting)

• User-defined local coordinate systems (p. 671)

• Solution Coordinate System (p. 1196)

The Global Coordinate System setting is the default setting. However, you can create local coordinate
systems (p. 671) and apply them to individual result objects. Also, the Solution Coordinate System
(p. 1196) option is available for circumstances such as examining surface and line bodies that align
themselves on a per element basis. Note, in some scenarios, result contours in the Solution Coordinate
System can appear to be a random collection of colors.

Note

• If a given result experiences any change in position due to the loading conditions, such as a dis-
placement or deformation, the Geometry window always displays this position change in the
Global Coordinate System (per global XYZ coordinate triad). If you have specified a local co-
ordinate system for your result, the application exposes all data contained in the Details view
as well as the Tabular Data window based the local coordinate system entry. Furthermore, if
applicable, the application always displays result contour colors in the Geometry window based
on a specified local coordinate system.

• The Mechanical APDL solver treats a "cylindrical" coordinate system as a set of Cartesian coordinate
systems aligned with the specified cylindrical system at each point in the model. See the Addi-
tional POST1 Postprocessing section in the Mechanical APDL Basic Analysis Guide for additional
technical information.

• For Probes, the Orientation property specifies coordinate systems.

Solution Coordinate System


Solution Coordinate System is an option of the Coordinate System property in the Details view for
most result objects. If you are familiar with the Mechanical APDL application commands, Solution Co-
ordinate System is an implementation of the RSYS,SOLU command, where for element results, such
as stress, a coordinate system is produced for each element. If these individual element coordinate
systems are aligned randomly, you can re-align them to a local coordinate system to obtain a uniform

Release 2020 R1 - © ANSYS, Inc.


1196
Result Definitions

alignment. Viewing results in the element solution coordinate system has value since results in a local
coordinate system aligned with a certain shell direction are typically more meaningful than results in
a global coordinate system. For example, seeing bending and in-plane stresses have meaning in a local
coordinate system, but have no meaning in a global coordinate system. See the Additional POST1
Postprocessing section in the Mechanical APDL Basic Analysis Guide for additional information.

Important

For Beam and Pipe elements:

• The following stress and strain component results are displayed in the element coordinate
system:

– Normal X, Y, and Z

– Shear XY, YZ, and XZ

• When a Line Body (p. 498) is specified as a beam/pipe that includes cross sections (SECDATA),
beam strains/stresses always use the Solution Coordinate System, even if you specify the
global coordinate system. To calculate beam strains/stresses, you need to set the Beam
Section Results property of the Solution (p. 1817) object to Yes.

Application
The following are typical applications for viewing results in a solution coordinate system:

• Viewing results in a particular direction for surface bodies or “solid shell” bodies, that is, solids meshed with
the Solid Shell element option (see the Meshing Help: Sweep description in the Method Control section).

• Viewing results in a random vibration, spectrum, or surface bodies in an explicit dynamics analysis. Results
for these analysis types only have meaning in a solution coordinate system.

Background
The meshing of surface bodies and solid shell bodies result in coordinate systems whose alignment is
on a per element basis, in contrast to solid body element types whose coordinate systems are aligned
with the global coordinate system by default. Surface body alignment on a per element basis can lead
to results with totally random alignment directions as shown below.

Release 2020 R1 - © ANSYS, Inc.


1197
Using Results

To produce meaningful results for surface body and solid shell bodies, you can re-align the random
direction of each element's solution coordinate systems to a uniform direction of a local coordinate
system. An example is shown below.

Procedure
To correct for random coordinate system alignments in surface bodies and solid shell bodies, and to
ensure a consistent alignment:

1. For each part, create a local coordinate system (p. 671) to specify the alignment of the elements of the part.

2. Choose the Solution Coordinate System option for the result.

Note

• The Coordinate System setting for result objects in a random vibration, spectrum, or explicit
dynamics analysis is set to Solution Coordinate System by default and cannot be changed be-
cause the results only have meaning when viewed in the solution coordinate system.

• The solution coordinate system is not supported by explicit dynamics analyses for results.

Release 2020 R1 - © ANSYS, Inc.


1198
Result Definitions

Material Properties Used in Postprocessing


The material properties listed below are used in postprocessing calculations to produce the displays of
probe and contour results. For reference, the corresponding labels (Lab argument) for the MP command
in Mechanical APDL are included in parentheses.

• Elasticity modulus (EX, EY, EZ)

• Shear modulus (GXY, GYZ, GXZ)

• Poisson's ratio (NUXY, NUYZ, NUXZ)

• Thermal conductivities (KXX, KYY, KZZ)

• Magnetic permeability (MURX, MURY, MURZ)

The following results, together with their identifiers (see User Defined Results (p. 1340)), are directly affected
by the material property values:

• Equivalent Strain (p. 1230) - uses only NUXY Poisson's ratio

1. Plastic (EPPL) and Creep (EPCR) strain always use NUXY = 0.5.

2. Elastic (EPEL), Thermal (EPTH) and Total (EPTO) default to 0.0.

• Structural Error (p. 1232) - uses elasticity modulus, shear modulus and Poisson's ratio.

• Thermal Error (p. 1313) - uses thermal conductivities

• Magnetic Error (p. 1319) - uses magnetic permeability

An error message is generated if an associated material property is not defined when evaluating
Structural, Thermal or Magnetic Error result.

If Poisson's ratio is not defined when evaluating Equivalent Strain, the Poisson's ratio will assume a zero
value.

Other results affected by material property values include Stress Tool (p. 1254) and Fatigue Tool (p. 1323)
results.

Note

If a material property is temperature dependent, it is evaluated at the reference temperature


of the body to be used in the computation for the result.

Clearing Results Data


You can clear results and meshing data from the database using the Clear Generated Data command
from the File menu, or from a right-mouse click menu item. This reduces the size of the database file,
which can be useful for archiving.

Release 2020 R1 - © ANSYS, Inc.


1199
Using Results

To clear all results data, simply select the Solution object and choose the Clear Generated Data menu
item from the File menu or from a right-mouse click menu. You can clear individual results by selecting
a result object before choosing the Clear Generated Data menu item.

Important

• A geometry or mesh change clears all results data.

• The application clears the solution and the results if the mesh becomes obsolete. See Clearing
Generated Data in the Meshing User's Guide.

Averaged vs. Unaveraged Contour Results


Normally, contour results in the Mechanical application are displayed as averaged results. Some results
can also display as unaveraged contours. Averaged contours distribute the average elemental nodal
results across element and geometric discontinuities. A user option exists that allows you to control
whether results are also averaged across body boundaries that contain a conformal mesh. The default
setting does not calculate an average across bodies.

Using the Mechanical APDL application terminology, unaveraged contour results display as element
nodal contours that vary discontinuously even across element boundaries. These contours are determined
by linear interpolation within each element and are unaffected by surrounding elements (that is, no
nodal averaging is performed). The discontinuity between contours of adjacent elements is an indication
of the gradient across elements.

Results that include the unaveraged contour display option are most elemental quantities such as stress
or strain. This option is not available for degree of freedom results such as displacements.

Nodal averaging of element quantities involves direct averaging of values at corner nodes. For higher-
order elements, midside node results are then taken as the average of the corner nodes.

There are two distinct techniques for calculating averaged nodal results. The calculation for the first
technique is as follows:

1. Average the component (X, Y, Z, XY, YZ, XZ) stress values from the elements at a common node.

2. Calculate the equivalent stresses from the averaged component values

The calculation for the second technique is as follows:

1. Calculate the equivalent stress values (from the six component strains) on a per element basis.

2. Average these values from the elements at a common node.

For equivalent stress, stress/strain intensity, max shear stress/strain, and principal stresses/strains, the
first technique is used to calculate the results. For equivalent strains, which are calculated by the
Mechanical APDL solver, the second technique is used. For random vibration analysis, equivalent stresses

Release 2020 R1 - © ANSYS, Inc.


1200
Result Definitions

are calculated by the Mechanical APDL solver using the Segalman method, so the second technique is
also used.

Note

If an elemental result is scoped to a surface body, then there may be two sets of results at
each node (Top and Bottom) and sometimes a third set of results (Middle). At release 12.0,
if the solver writes Middle results to the result file, then Mechanical displays these results if
the Shell Face setting in the Details view equals Middle (Membrane). If the solver did not
write Middle results to the result file, then Mechanical displays the average of Top and
Bottom if the Shell Face setting in the Details View is Middle (Membrane). For a given node
on the shell, the application will average Top results, separately average Bottom results, and
separately average Middle results. When you export a result in the application that is set to
Top/Bottom, you may note that a node number is repeated in the Excel file. This is because
both the Top and Bottom stresses are listed.

Beginning at Release 16.0, Mechanical supports the Top/Bottom/Middle positions for layered
solid bodies. Therefore, layered solid elements mimic expanded shell elements, which display
as having a thickness between the Top face and Bottom face.

You can display contour results by setting the Display Option field to one of the following:

• Unaveraged: Displays unaveraged results.

• Averaged (default): Displays averaged results.

• Nodal Difference: Computes the maximum difference between the unaveraged computed result (for example,
total heat flux, equivalent stress) for all elements that share a particular node.

• Nodal Fraction: Computes the ratio of the nodal difference and the nodal average.

• Elemental Difference: Computes the maximum difference between the unaveraged computed result (for
example, total heat flux, equivalent stress) for all nodes in an element, including midside nodes.

• Elemental Fraction: Computes the ratio of the elemental difference and the elemental average.

• Elemental Mean: Computes the elemental average from the averaged component results.

Characteristics of unaveraged contour displays:

• Because of the added data involved in the processing of unaveraged contour results, these results take a
longer time to display than averaged results.

• Occasionally, unaveraged contour result displays tend to resemble a checkerboard pattern.

• Capped Isosurface displays can have missing facets.

Average Across Bodies


When you select Averaged as the Display Option, the Average Across Bodies property displays in
the Integration Point Results category. Setting this property to Yes (the default value is No) allows
you to averages the results across separate bodies on your model. This post-processing feature is sup-
ported for most averaged element nodal contour results (like stress, strain, and thermal flux).

Release 2020 R1 - © ANSYS, Inc.


1201
Using Results

If a node belongs to two different bodies, its averaged stress value of one of the bodies is typically
different from the stress value of the other body. Using the Average Across Bodies feature, the average
value at this node is the sum of all of the stress values from all “scoped” elements that contain the node
(divided by the number of elements). The feature graphically renders a smoother result contour at the
interfaces of bodies. If bodies do not share any nodes, then the feature has no effect.

Calculation Conditions

Note the following conditions and characteristics for calculating averages across bodies:

• Principal values themselves are averaged when averaging results across bodies for principal and vector
sums. Calculated results, such as the types shown below, are averaged at the nodes at the interfaces of
bodies. That is, they do not average the components (SX, SY, etc.) across bodies. For example, this feature
averages equivalent stress (SEQV) values directly:

SEQV(node_1) + SEQV(node_2) + SEQV(node_N)/N

This differs from the usual method (except for equivalent strain) of averaging the components and
then computing SEQV.

– Principal Stresses (1, 2, 3)

– Stress Intensity (INT)

– Equivalent Stress (EQV)

– Principal Strains (1, 2, 3)

– Strain Intensity (INT)

– Equivalent Strain (EQV)

– Total Thermal Flux

The following result illustrations show the outcomes between not performing an average calculation,
performing an average calculation but not across bodies, and performing an average calculation
across bodies.

No Averaging Performed

Release 2020 R1 - © ANSYS, Inc.


1202
Result Definitions

No Averaging Across Bodies Performed

Release 2020 R1 - © ANSYS, Inc.


1203
Using Results

Averaging Across Bodies Performed

Release 2020 R1 - © ANSYS, Inc.


1204
Result Definitions

• If the associated bodies have different material properties, such as Poisson's ratios, then, because this feature
averages quantities like equivalent elastic strain at common nodes, you may see unexpected results at the
interfaces. The Poisson Ratio employed to calculate elastic equivalent in one body may be significantly dif-
ferent from the Poisson Ratio employed to calculate elastic equivalent in a different body. Therefore, in this
scenario, averaging across bodies at the interface is not recommended.

• If you choose to compare this feature against Mechanical APDL PowerGraphics with AVRES,1,FULL in effect,
PowerGraphics employs the effective Poisson's ratio in the AVPRIN,KEY,EFFNU command. The EFFNU value
may not match the Poisson's ratios in all bodies. PowerGraphics also calculates equivalent strain from the
average component strains if KEY (in the AVPRIN command) is set to ZERO. As a result, there may be differ-
ences between this feature and PowerGraphics when the AVRES,1,FULL command is employed.

Support Limitations

The following results features are not supported:

• Probe results

• Results in cyclic symmetry analyses

• Results on line bodies

Release 2020 R1 - © ANSYS, Inc.


1205
Using Results

Averaging Element Nodal Results


For most element nodal results (like stresses and strains), the Mechanical solvers write only the unaveraged
corner node values to the result file. No element nodal results are written for mid-side nodes. This dif-
ference is of critical importance.

To derive the value at a mid-side node, the Mechanical post processor must employ the values at the
corner nodes. There are three distinct techniques for this process:

1. For line elements, such as unexpanded beam and pipe stress, Mechanical calculates the average of
the unaveraged values of those corner nodes which share an edge with the mid-side node - corner
nodes, node I and node J. See Case 1 below.

2. For solid elements (i.e. shell, hexahedron, tetrahedron, wedge, and pyramid elements), the technique
calculates the mid-side node results from the averaged corner nodes. See Case 2 below.

3. For contact elements, the technique calculates the mid-side node results by averaging the un-averaged
values of adjacent corner nodes. Note: A result max may be at a mid-side node. See Case 3 below.

Corner Node Calculation Case 1


Consider the following example consisting solely of high order line elements, where:

• Element 1 contains nodes 1, 2, and 12.

• Element 2 contains nodes 2, 3, and 23.

• Element 3 contains nodes 3, 4, and 34.

• Nodes 12, 23, and 34 are mid-side nodes.

If:

• The element nodal solution for element 1 is 0.0 and 0.0 for nodes 1 and 2.

• The element nodal solution for element 2 is 100 and 80 for nodes 2 and 3.

• The element nodal solution for element 3 is 3 and 0.0 for nodes 3 and 4.

The unaveraged solution is then:

• The value at node 12 is the average of the values at the associated element's end points, namely 0.0.

• The value at node 23 is the average of the values at the associated element's end points, namely 90.

• The value at node 34 is the average of the values at the associated element's end points, namely 1.5.

Release 2020 R1 - © ANSYS, Inc.


1206
Result Definitions

For the averaged solution of nodes 2 and 3:

• The value at node 2 is 50.

• The value at node 3 is 41.5.

Note that the value at the mid-side node 23 (90) exceeds the values at the end points.

Corner Node Calculation Case 2


Result averaging for solids: mid-side node results are the average of the averaged corner node values.

Raw Data Averaged Corner Nodes

Mid-Side Nodes Calculated from Averaged Corner Nodes

Release 2020 R1 - © ANSYS, Inc.


1207
Using Results

Corner Node Calculation Case 3


Result averaging for contacts: calculate the final mid-side node results by averaging intermediate mid-
side values.

Raw Data Averaged Corner Nodes

Mid-Side Nodes Calculated from Averaged Corner Nodes

Release 2020 R1 - © ANSYS, Inc.


1208
Result Definitions

Note

Result maximum in this case may be at a mid-side node.

Multiple Result Sets


Many analyses produce multiple result sets over a domain, such as time in a static or transient structural
analysis, or frequency/phase in a harmonic analysis, or cyclic phase in a cyclic modal analysis. The By
property options enable you to specify how you wish to review result contours from multiple result
sets. The options available to you are based on the type of analysis being performed.

Structural Analysis

• Time (default): This option displays the contour result for a Time in the solution history. By default,
this is the end time. For a solution that includes steps and substeps, you can use the Display Time
property to specify a desired time value. In the event that you enter a time that is not equal to an
existing time in the result file, such as a value in between two valid result sets, the application inter-
polates the result.

• Result Set: This option displays the contour result for a given Result Set contained in the result
file. By default, this value is the last set, which is to say, if only one set is available, then that is the
specified Result Set. For a solution that includes load steps and substeps, you specify the desired
chronological set number using the Set Number property. You must enter a valid set number.

• Maximum Over Time or Time of Maximum: Each node/element/sample point is swept through
the result sets to find its maximum result. Either the result itself is reported (sometimes referred to
as a "peak hold") or the time at which the peak occurred is reported.

• Minimum Over Time or Time of Minimum: Each node/element/sample point is swept through
the result sets to find its minimum result. Either the result itself is reported or the time at which the
minimum occurred is reported.

Release 2020 R1 - © ANSYS, Inc.


1209
Using Results

Harmonic Analysis

• Frequency (default): This option displays the contour result for a Frequency in the solution history.
By default, this is the final frequency value. For a solution that includes steps and substeps, you can
use the Frequency property to specify a desired value. Like Time, if you enter a frequency that is
not equal to an existing value in the result file, the application interpolates the result.

• Set: results display for specified sets.

• Maximum Over Frequency or Frequency of Maximum: With these options chosen, the phase
specified in the Sweeping Phase property is held constant and each node/element/sample point
is swept through frequency range to find its maximum result.

• Maximum Over Phase or Phase of Maximum: With these options chosen, frequency is held constant
and each node/element/sample point is swept through a phase period of 0° to 360° at specified
increments to find its maximum result. You can control the increment using the Phase Increment
entry.

• Maximum Over Cyclic Phase or Cyclic Phase of Maximum: Each node/element/sample point is
swept through a phase angle of 0° to 360° in 10 degree increments find its maximum result.

Note

Maximum Over Cyclic Phase and Cyclic Phase of Maximum require that you
specify the Harmonic Index property as greater than zero.

Modal Analysis (Cyclic Only)

• Cyclic Phase (default)

• Maximum Over Cyclic Phase or Cyclic Phase of Maximum. Each node/element/sample point is
swept through a phase angle of 0° to 360° in 10 degree increments find its maximum result. This
result is applicable during a cyclic modal analysis only.

Surface Body Results (including Layered Shell Results)


For surface bodies, stress and strain results at the top and bottom faces are displayed simultaneously,
by default. (See Surface Body Shell Offsets (p. 489) for information on identifying the top and bottom
faces.) The contours vary linearly through the thickness from the top face to the bottom face. However
you can choose to display only the Top, Middle, or Bottom stress/strains in the Details view of the
result item. Selecting Top, Middle, or Bottom will display the result at the selected location as a uniform
contour through the thickness.

Middle Stresses

• Normal and Shear results

The middle stresses are calculated at the shell mid-surface or at each layer mid-surface if layers are
present. The Middle option for Shell gives the actual result values at the mid-surface if the solver was
directed to calculate these results. In Mechanical APDL terminology, the solver computes results at
mid-surface if KEYOPT(8) for the shell element is set to 2 at the time of element creation. Otherwise,
the Middle results are computed as the average of the Top and Bottom results, that is, (Top + Bottom)
/ 2. Note that these results are valid only for linear analyses.

Release 2020 R1 - © ANSYS, Inc.


1210
Result Definitions

• Equivalent and Principal results

These results are derived from the Normal and Shear results. Hence the Normal and Shear component
results for Middle are computed first, and then the Equivalent and Principal results are derived.

Element Nodal results (like stress/strain), as well as EDIR- and PNUM-type Elemental results, can be
plotted on a specific layer or on a specific ply by entering the desired Layer number (Layer only) or
by scoping (p. 1214) the result to a specific Ply using the Sub Scope By (p. 1807) property in the Details
view of the result object. Elemental results outputting volume or energy are calculated for the entire
element, regardless of the requested layer.

If the Layer specified does not exist for a particular surface body, the display of the result will be
translucent with zero values for minimums and maximums on that body. If you enter 0 for Layer, it
defaults to the Entire Section.

Note

• A Layer number must be specified to calculate the Middle stresses and strains. If you set Layer
to 0 (Entire Section) while Shell is Middle, the Shell option will become invalid. Similarly, if you
have Layer set to Entire Section and you try to set Shell to Middle, Shell will become invalid.

• If there is a Layered Section in the model, convergence is not supported for results.

• If Layer is Entire Section, Top stresses and strains are for the top surface of the topmost layer
and the Bottom stresses and strains are for the outer surface of the bottom layer.

• If a Layered Section is present in the model and you enter a number larger than the maximum
number of layers that exists in the model, the Layer field will become invalid.

• All stress tool results and all fatigue tool results are unsupported if Layered Sections are present
in the model.

• Only results from the section top and bottom are available on hyperelastic layered shells. Thus
no results will be reported on such bodies if the layer is not set to 0 "Entire Section".

• Imported Plies are not supported for an Explicit Dynamics analysis.

Layered Solid Body Results


Certain solid elements in the Mechanical APDL element library (including SOLID185, SOLID186, and
SOLSH190) support stress and strain results on layers. These layered solid elements are created on solid
bodies.

At Release 16.0, these elements support the Layer property, which specifies the layer to calculate Shell
result values. This property specifies a Layer number. In addition, the Position property appears only
for stress and strain results scoped to surface bodies or to a layer. This property is specified as either
Top/Bottom, Top, Middle, or Bottom.

Release 2020 R1 - © ANSYS, Inc.


1211
Using Results

For the elements, the convention is that the Bottom corresponds to nodes I-J-K-L and the Top corres-
ponds to nodes M-N-O-P.

Note

If the model does not include surface bodies or layered sections, the Layer and Position
properties do not display in the Details view and the application displays layer results in
Top/Bottom format.

For Explicit Dynamics Layer Results


Normal/shear stresses and strains are available in global and solution coordinate systems.

Stress and strain results for individual layers may be selected by using the Layer property in the result’s
Details view. Only a single result is available per layer.

Unconverged Results
A nonlinear analysis may fail to converge due to a number of reasons. Some examples may be initially
open contact surfaces causing rigid body motion, large load increments, material instabilities, or large
deformations that distort the mesh resulting in element shape errors.

In the Mechanical application, you can review this unconverged result as well as any converged results
at previous time points. These results are marked in the legend of contour/vector plots as ‘Unconverged’
indicating that these results must be used only for debugging purposes. Note that a plot of Newton-
Raphson residuals (p. 1395) is a very useful tool to identify regions of your structure that led to the con-
vergence difficulty.

Note

• Results in Solution Combination objects that use partial solutions will not be solved. You can
view partial results but cannot use them in further post/solution work.

• Newton-Raphson residuals (p. 1395) is a very useful tool to identify regions of your structure that
led to the convergence difficulty.

• The handling of unconverged solutions is the same for both probes and results, with the following
exception: reaction probes scoped to a Compression Only boundary condition cannot display
results if the solver did not converge.

Handling of Degenerate Elements


The finite element method can create elements that are classified as degenerate. For example, a quad
element, with four nodes 1, 2, 3, and 4, may contain duplicate nodes 3 and 4. In this case, node 3 and
4 are located at the same (x, y, z).

Release 2020 R1 - © ANSYS, Inc.


1212
Result Scoping

The degenerate quad element (above, right) contains three distinct nodes and four distinct integration
(Gauss) points. Mechanical APDL's solver calculates element nodal results (like stress and strain and flux,
et. al.) at each of the integration points. Hence, element nodal results in the MAPDL result file are stored
as though an element is not degenerate (even when it is degenerate). For the element (above, right),
the file would contain stress and strain and flux listings for four nodes, 1, 2, 3, and 4.

At nodes that share the same (x,y,z) in an element, it is not necessarily true that the element nodal
results are equal for each coincident node. Depending upon the analysis, the element nodal results for
the element (above, right) at node 3 may not equal the element nodal results at node 4. During the
post processing phase, Mechanical drops the values of all but the first duplicate node at an (x,y,z). The
element (above, right) would display the stress and strain and flux contours for nodes 1, 2, and 3 (but
not 4).

Result Data Display Error Handling


When defining a result, it is necessary to make sure that you have made selections that are supported
by the application. Normally, the application generates a message indicating that the result type is not
available but there are instances when result information is not provided, that is, the application will
not display contour information or it will display generically colored contour information.

Note that:

• Result objects must be scoped to geometry that supports the elements and nodes used by the body;
failing to do so will cause Mechanical to display result contours in grayscale. For example, stress results
do not exist on gasket elements. Therefore, if you scope a stress result to a gasket body, the result displays
in grayscale.

• All possible result data is not provided by a result file. If you create an expression in a user-defined
result that is not applicable to the analysis, such as Total Deformation during in a thermal analysis,
then the result display will have no contour colors.

• The solver can create elements such as surface effect as well as interface elements. Results cannot be
scoped to these elements. For example, because of software limitations, contour colors for surface effect
results will not be shown, even though the surface effect elements cover meshed elements on the
body.

Result Scoping
The topics of this section examine the methods to scope your results. You can scope result on:
Geometry and Mesh
Path Construction Geometry

Release 2020 R1 - © ANSYS, Inc.


1213
Using Results

Surface Construction Geometry


Result File Items
Surface Coatings

Geometry and Mesh


All result objects can be scoped to:

• Geometry selections - edges, a single vertex, faces, parts, bodies, or the entire assembly.

• Geometry-based Named Selections (p. 583).

• Node-based Named Selections (p. 142)

• Node selections (p. 137) of the underlying mesh.

• Element or Element Face selections (p. 143) of the underlying mesh.

• Element or Element Face-based Named Selections (p. 143).

Support Requirements
Make sure that your result objects conform to the following:

• If you scope a result to one or more geometric entities (body, face, edge, or vertex) and subsequently suppress
all of the bodies associated with the scoped entities, the application, by default, sets the scoping to All
Bodies. However, the application still stores the suppressed geometric entity set for future reference.
Therefore, if any of the bodies associated with the scoped entities are later unsuppressed, the result scoping
is set back to the originally defined (unsuppressed) geometric entities. If this behavior is undesirable, it is
recommended that you use a Named Selection to define the scoping of the result.

• Once a solution is computed, the scope of the result object cannot change. You must either add a new
result object with the desired scope, or you can right-click that result item, and choose Clear Generated
Data to change its scope.

• Result scoping has an impact on convergence. Refinement does not happen outside the scope for a given
convergence control. Multiple convergence controls are possible, however.

See the following subsections for additional information specific to the type of result scoping you wish
to perform:

• Composite Analysis Result Scoping (p. 1214)

• Node-Based Scoping (p. 1216)

• Element-Based Scoping (p. 1217)

Composite Analysis Result Scoping


For a Composite Analysis (p. 466), elemental strain and elemental stress results, elemental coordinate
system (p. 1166) results, User Defined Results (p. 1340) (for Structural analyses), and heat flux results (for
Thermal Analyses), can be scoped to Analysis Ply objects (p. 1633) using the Sub Scope By (p. 1807)
property and the corresponding Ply property. The result calculation uses the intersection of the specified
Ply and the Geometry property scoping. When scoping ply objects, the associated geometry selection
needs to be based on either bodies or elements (p. 143). Body- and element-based Named Selec-

Release 2020 R1 - © ANSYS, Inc.


1214
Result Scoping

tions (p. 143) are supported. In addition, for shell topologies, you can scope to a face (which represents
an entire element).

Automated Result Scoping for Composites

The Imported Plies (p. 1723) object, as well as all of its child objects, offer an automated option for cre-
ating results, including User Defined Results (p. 1340). Right-clicking on a ply object provides the following
dynamic menu options that enable you to create and scope a result at the same time.

Depending upon the level within the Imported Plies object that you select, you can create individual
results, as shown below, or you can create a group of results.

This example shows the creation of results for all of the individual plies within a ply group. The feature
created a group of six results and scoped them accordingly. Once you create a group, the rules for
Group Tree Objects (p. 100) apply.

Release 2020 R1 - © ANSYS, Inc.


1215
Using Results

If your analysis includes multiple environments, only supported environments display on the menu and,
only result objects supported by the given scoping display as the menu extends. As illustrated in the
following example, multiple supported environments are selected and the supported result types for
the Transient Thermal selection are the only options available. See the Result Context Toolbar (p. 84)
section for additional information about how results are graphically represented following a solution.

Note

Direct graphical node or element selection requires you to generate the mesh and have the
Show Mesh tool turned on.

Node-Based Scoping
The following are known characteristics related to node-based scoping:

• If all nodes of an element face are scoped, then Mechanical will draw contour bands on the entire face.

• If some nodes of an element face are not scoped, then Mechanical will draw the face as transparent and
draw the scoped nodes in contour colors.

• As is the case with other scoping that occurs within a body (such as vertex or edge), any applicable averaging
is done considering all of the nodes on a body.

Release 2020 R1 - © ANSYS, Inc.


1216
Result Scoping

Element-Based Scoping
Unlike results scoped to geometries or nodes, results scoped to elements evaluate only the scoped
elements. No adjacent elements are considered. The example results shown below illustrate this beha-
vior. Refer to the Averaged vs. Unaveraged Contour Results (p. 1200) section of the Help for additional
information on this topic.

The following results illustrate contour bands for all nodes.

Global Averaged Result Global Unaveraged Result

Max. = 205 and Min. = -50 Max. = 276 and Min. = -74

The following results illustrate contour bands for elements only.

Result Scoped to Three Elements


Result Scoped to One Element
Max. = 205: Matches the Global Averaged
Max. = 276: Matches the Global Unaveraged
Result
Result
Min. = -74: Matches the Global Unaveraged
(Min. Value = 127)
Result

Path Construction Geometry


When you defined a path (p. 661) in your analysis, you may wish to scope results directly on this defined
path. In order to do so, you can set the Scoping Method of the result object to Path and then choose
the name of the particular path that you defined. This enables you to produce Path Results (p. 1168) as
a result output.

Release 2020 R1 - © ANSYS, Inc.


1217
Using Results

Surface Construction Geometry


When you defined a surface (p. 666) in your analysis, you may wish to scope results directly on this
defined surface. In order to do so, you can set the Scoping Method of the result object to Surface and
then choose the name of the particular surface that you defined. This enables you to produce Surface
Results (p. 1173) as a result output.

Result File Items


The result object Scoping Method option, Result File Item, enables you to scope a result to the following
Mechanical APDL Solver generated data items generated in the result (.rst) file, once you have performed
a solution:

• Material IDs: The material ID assigned to the element by Mechanical APDL.

• Element Name IDs: Mechanical APDL element name string such as BEAM188, SOLID185, and SURF154.
In addition, for this option, you can enter an element group label, such as "beam", to include all beam
element types. Supported group labels include:

– COMBIN
– SURF – FOLLW

– MASS – TARGE – FLUID

– LINK – CONTAC – PRETS

– PLANE– BEAM – MPC

– SOLID – PIPE – INTER

– SHELL – ELBOW – SOLSH

See the Element Library section of the Mechanical APDL Element Reference for a complete listing
of all available elements.

• Element Type IDs: The element type ID assigned to the element by Mechanical APDL.

• Component Name: Component names are created by the Mechanical APDL Solver. Components are
node- or element-based groupings, node- and element-based Name Selections that were written to
the result file from Mechanical, or components that the solver needed to generate in order to properly
solve the analysis. Solver generated components typically contain an underscore (i.e. "_") at the beginning
of the Component Name.

This scoping option is unique in that it obtains data from the result file following the solution. This
section examines the following topics for this feature. Select a link to jump to that topic.

• Background (p. 1219)

• Application (p. 1220)

• Examples (p. 1221)

Release 2020 R1 - © ANSYS, Inc.


1218
Result Scoping

Background
During the solution process, Mechanical identifies nodes and elements contained in the mesh and sends
this data to the solver for analysis processing. An element is identified by an element type number, an
element name and a material number. A typical element name, such as SOLID285, consisting of a group
label (SOLID) and a unique, identifying number (285).

Additional elements, nodes, and groups of nodes or elements, not included in the original mesh, may
also be created to process loads, contact conditions, or support conditions, that are required to properly
solve the analysis. Once the solution is complete, the data is written to the result file, and the element
data, as well as material data, becomes available to you.

In addition, during the solution process, node and element Name Selections are also written to the
result file and may be selected for scoping. The Mechanical solve process may also create additional
components for use in solving the analysis. The components typically contain an underscore (i.e. "_")
at the beginning of the Component Name.

The application presents this information in the Solution Summary Worksheet (p. 1185), using the Ma-
terial and Element Type Information and Solver Component Names options. As illustrated below,
the Worksheet option Material and Element Type Information lists Material IDs, Element Name IDs,
and Element Type IDs generated during the solution as well as other appropriate information such as
Element Shape. The Solver Component Names option lists the solver generated Component Name
as well as the Component Type (nodes or elements) and the Number of Entities. The Component
Name always includes an underscore prefix.

Material and Element Type Information

Solver Component Names

Release 2020 R1 - © ANSYS, Inc.


1219
Using Results

Note

The Material and Element Type Information option does not display elements with:

• Element type MPC184.

• A Material ID of 0.

Application
Once you solve your analysis, you can select the Result File Item option for the Scoping Method of
the desired result object in the Details view, as illustrated below for a total Deformation result.

When you specify the Scoping Method as Result File Item, the following additional properties display
in the Details view:

• Item Type: The options for this property include Materials IDs (default), Element Name IDs, Element
Type IDs, and Component Name.

• Solver Component IDs: Based on the option selected in the Item Type property, you enter the appro-
priate ID or Component Name in this property as listed in the Worksheet. The default value is All. You

Release 2020 R1 - © ANSYS, Inc.


1220
Result Scoping

can enter a number or a number range (i.e., 1, 2, 3, or 2-5). For Element Name IDs, you enter a element
name, such as BEAM188, or you can simply enter "beam" to include all beam element types.

Note

You may encounter a rare case when you are scoping a result to a solver component
for a body that contains multiple materials. In this instance, set the Mesh Source property
(Solution object) to the option Result File.

Examples
Here is an example model. It includes four line bodies as well as two user-created beam connections.

Examining the Worksheet following a solution process for the material and element data, we have the
following. We are going to further examine the beam connections that correspond with Materials 15
and 16 (Element Type ID as well).

The following sequence of Total Deformation results illustrate the Result File Type scoping options,
Material ID, Element Type ID, and Element Name ID. Note that the Material ID and Element Type ID
present the same result data using different scoping options.

Release 2020 R1 - © ANSYS, Inc.


1221
Using Results

For this example, we generalized the Element Name and used "Beam." This generates results for the
additional (four) line bodies of the model as well as the beam connections.

Release 2020 R1 - © ANSYS, Inc.


1222
Result Scoping

Surface Coatings
You can apply a Surface Coating (p. 507) to your model from the Geometry toolbar (p. 81). You can
apply one or more of these coatings, or layers, to the faces of your model. This feature places shell
elements of a specified material and thickness on the selected face or faces of your model.

Once properly defined, you can use these surface coating definitions as a Scoping Method for results.
The Surface Coating scoping option is supported by most result types, including User Defined res-
ults (p. 1340). During the solution process, the Mechanical APDL solver specifies the elements as either
SHELL181 (low order) and SHELL281 (high order).

As illustrated in the example below, a Surface Coating is defined and specified as the Scoping Method.
The associated Surface Coating property in the Details view of the results is used to select the coating
defined under the Geometry object. If multiple coatings were specified, they would display in the drop-
down list of this Surface Coating property for the result. The default option for this property is All.

Release 2020 R1 - © ANSYS, Inc.


1223
Using Results

Structural Results
The following structural result topics are addressed in this section:
Deformation
Stress and Strain
Stabilization Energy
Strain Energy
Linearized Stress
Damage Results
Contact Results

Release 2020 R1 - © ANSYS, Inc.


1224
Structural Results

Frequency Response and Phase Response


Stress Tools
Fatigue (Fatigue Tool)
Fracture Results (Fracture Tool)
Composite Failure Tool
Contact Tool
Bolt Tool
Beam Tool
Beam Results
Structural Probes
Response PSD Tool
Gasket Results
Campbell Diagram Chart Results

Stress Tools (p. 1254) are used to determine the following results:

• Maximum Equivalent Stress Safety Tool (p. 1255)

• Maximum Shear Stress Safety Tool (p. 1256)

• Mohr-Coulomb Stress Safety Tool (p. 1258)

• Maximum Tensile Stress Safety Tool (p. 1260)

Structural Probes (p. 1279) can be used to determine the following results:

• Deformation

• Strain

• Position (p. 1288)

• Velocity

• Angular Velocity

• Acceleration

• Angular Acceleration

• Energy (p. 1289)

• Flexible Rotation Probe

• Force Reaction (p. 1290)

• Moment Reaction (p. 1290)

• Joint (p. 1298)

• Response PSD (p. 1300)

• Spring (p. 1301)

• Bearings (p. 1302)

Release 2020 R1 - © ANSYS, Inc.


1225
Using Results

• Beam (p. 1303)

• Bolt Pretension (p. 1303)

• Generalized Plane Strain (p. 1303)

Deformation
Physical deformations can be calculated on and inside a part or an assembly. Fixed supports prevent
deformation; locations without a fixed support usually experience deformation relative to the original
location. Deformations are calculated relative to the part or assembly world coordinate system.

Component deformations (Directional Deformation)

Deformed shape (Total Deformation vector)

The three component deformations Ux, Uy, and Uz, and the deformed shape U are available as individual
results.

Scoping (p. 919) is also possible to both geometric entities and to underlying meshing entities (see ex-
ample below). Numerical data is for deformation in the global X, Y, and Z directions. These results can
be viewed with the model under wireframe (p. 88) display, facilitating their visibility at interior nodes.

Example: Scoping Deformation Results to Mesh Nodes


The following example illustrates how to obtain deformation results for individual nodes in a model.
The nodes are specified using criteria based named selections.

1. Create a named selection by highlighting the Model tree object and clicking the Named Selection toolbar
button.

2. Highlight the Selection object and in the Details view, set Scoping Method to Worksheet.

3. In the Worksheet, add a row and set the following items for the row. Refer to Specifying Named Selections
using Worksheet Criteria (p. 587) for assistance, if needed.

• Entity Type = Mesh Node.

• Criterion = Location X.

• Operator = Greater Than.

• Value = 0.1.

4. Add a second row with Criterion = Location Y, Value = 0.2, and all remaining items set the same as the
first row.

Release 2020 R1 - © ANSYS, Inc.


1226
Structural Results

5. Add a third row with Criterion = Location Z, Value = 0.3, and all remaining items set the same as the first
row.

The table displays as shown below

6. Click the Generate button. The Geometry field in the Details view displays the number of nodes that meet
the criteria defined in the Worksheet.

7. After applying loads and supports to the model, add a Total Deformation result object, highlight the object,
set Scoping Method to Named Selection, and set Named Selection to the Selection object defined
above that includes the mesh node criteria. Before solving, annotations are displayed at each selected
node as shown below.

Release 2020 R1 - © ANSYS, Inc.


1227
Using Results

8. Solve the analysis. Any element containing a selected node will display a contour color at the node. If all
nodes on the element are selected, the element will display contour colors on all facets. Element facets
that contain unselected nodes will be transparent. An example is shown below.

Note that all element facets are drawn, not just the facets on the surface or skin of the model.

To possibly reduce clutter for complex models, the size of the dots representing the nodes can be
changed by choosing View>Large Vertex Contours.

Working with Deformations


Deformations can be used to:

• Set Alert objects (p. 1632).

• Control accuracy and convergence and to view converged results.

• Study deformations in a selected or scoped area of a part or an assembly.

Important

The deformation result can exhibit a node-based display limitation. If a node represents a
remote point, the application does not process result data for it and as a result, Mechanical
does not display result data. Deformed shapes, deformation contour colors, and deformation
MIN/MAX values can differ from the displays (and listings) of Mechanical APDL commands,
such as PRNSOL, PLNSOL, and MONITOR.

Velocity and Acceleration


In addition to deformation results, velocity and acceleration results are also available for Transient
Structural (p. 384), Harmonic Response (p. 211) (Full and MSUP), Rigid Dynamics (p. 263), Random Vibra-
tion (p. 235), and Response Spectrum (p. 242) analyses. Both total and directional components are available

Release 2020 R1 - © ANSYS, Inc.


1228
Structural Results

for the Transient Structural and Harmonic Response analyses but only directional components are
available for Random Vibration and Response Spectrum (Total Deformation is available).

Considerations for Random Vibration


For Random Vibration analyses, only component directional deformations are available because the
directional results from the solver are statistical in nature. The X, Y, and Z displacements cannot be
combined to get the magnitude of the total displacement. The same holds true for other derived
quantities such as principal stresses.

Directional Deformation, Directional Velocity, and Directional Acceleration result objects in Random
Vibration analyses also include the following additional items in the Details view:

• Reference - Read-only reference indication that depends on the directional result. Possible indications are:

– Relative to base motion for a Directional Deformation result.

– Absolute (including base motion) for a Directional Velocity or Directional Acceleration result.

• Scale Factor - A multiple of standard deviation values (with zero mean value) that you can enter which
determines the probability of the time the response will be less than the standard deviation value. By default,
the results output by the solver are 1 Sigma, or one standard deviation value. You can set the Scale Factor
to 2 Sigma, 3 Sigma, or to User Input, in which case you can enter a custom scale factor in the Scale Factor
Value field.

• Probability - Read-only indication of the percentage of the time the response will be less than the standard
deviation value as determined by your entry in the Scale Factor field. A Scale Factor of 1 Sigma = a Prob-
ability of 68.3 %. 2 Sigma = 95.951 %. 3 Sigma = 99.737 %.

Stress and Strain


Stress solutions allow you to predict safety factors, stresses, strains, and displacements given the model
and material of a part or an entire assembly and for a particular structural loading environment.

A general three-dimensional stress state is calculated in terms of three normal and three shear stress
components aligned to the part or assembly world coordinate system.

The principal stresses and the maximum shear stress are called invariants; that is, their value does not
depend on the orientation of the part or assembly with respect to its world coordinate system. The
principal stresses and maximum shear stress are available as individual results.

The principal strains ε1, ε2, and ε3 and the maximum shear strain γmax are also available. The principal
strains are always ordered such that ε1> ε2> ε3. As with principal stresses and the maximum shear stress,
the principal strains and maximum shear strain are invariants.

You can choose from the following stress/strain results:


Equivalent (von Mises)
Maximum, Middle, and Minimum Principal
Maximum Shear
Intensity
Vector Principals
Error (Structural)
Thermal Strain
Equivalent Plastic Strain

Release 2020 R1 - © ANSYS, Inc.


1229
Using Results

Equivalent Creep Strain


Equivalent Total Strain
Membrane Stress
Bending Stress

Normal (X, Y, Z) and Shear (XY, YZ, XZ) stress and strain results are also available.

It is assumed that whatever holds true for stress applies to strain as well. However, the relationship
between maximum shear stress and stress intensity does not hold true for an equivalent relationship
between maximum shear strain and strain intensity.

For more information about Stress/Strain, see the Mechanical APDL Theory Reference.

Considerations
The degree of uncertainty in the numerical calculation of Stress answers depends on your accuracy
preference. See Adaptive Convergence (p. 1411) for information on available options and their effect on
Stress answers.

For your convenience and future reference, Report can include stress, strain, and deformations value,
convergence histories, and any alerts for these values.

Equivalent (von Mises)


Equivalent stress is related to the principal stresses by the equation:

Equivalent stress (also called von Mises stress) is often used in design work because it allows any arbitrary
three-dimensional stress state to be represented as a single positive stress value. Equivalent stress is
part of the maximum equivalent stress failure theory used to predict yielding in a ductile material.

The von Mises or equivalent strain εe is computed as:

where:

ν' = effective Poisson's ratio, which is defined as follows:

• Material Poisson's ratio for elastic and thermal strains computed at the reference temperature of the
body.

• 0.5 for plastic strains.

Note

Currently, for Linked MSUP analyses with the Expand Results From detail under Output
Controls set to Modal Solution, the Mechanical APDL solver does not calculate equivalent
strains. If you choose to display equivalent strain results, you will see zero contours.

Release 2020 R1 - © ANSYS, Inc.


1230
Structural Results

Maximum, Middle, and Minimum Principal


From elasticity theory, an infinitesimal volume of material at an arbitrary point on or inside the solid
body can be rotated such that only normal stresses remain and all shear stresses are zero. The three
normal stresses that remain are called the principal stresses:

σ1 - Maximum
σ2 - Middle
σ3 - Minimum

The principal stresses are always ordered such that σ1 > σ2 > σ3.

Maximum Shear
The maximum shear stress τmax, also referred to as the maximum shear stress, is found by plotting
Mohr's circles using the principal stresses:

or mathematically through:

For elastic strain, the maximum shear elastic strain γmax is found through:

γmax = ε1 - ε3

since the shear elastic strain reported is an engineering shear elastic strain.

Intensity
Stress intensity is defined as the largest of the absolute values of σ1 - σ2, σ2 - σ3, or σ3 - σ1:

Release 2020 R1 - © ANSYS, Inc.


1231
Using Results

Stress intensity is related to the maximum shear stress:

σI = 2τmax

Elastic Strain intensity is defined as the largest of the absolute values of ε1 - ε2, ε2 - ε3, or ε3 - ε1:

Elastic Strain intensity is equal to the maximum shear elastic strain:

εI = γmax

Equivalent Stress (and Equivalent Elastic Strain) and Stress Intensity are available as individual results.

Note

Computation of Equivalent Elastic Strain uses Poisson’s ratio. If Poisson’s ratio is temperature
dependent then the Poisson’s ratio value at the reference temperature of the body is used
to compute the Equivalent Elastic Strain.

Vector Principals
A Vector Principals plot provides a three-dimensional display of the relative size of the principal
quantities (stresses or elastic strains), and the directions along which they occur. Positive principals
point outwards and negative ones inwards.

Plots of Vector Principals help depict the directions that experience the greatest amount of normal
stress or elastic strain at any point in the body in response to the loading condition. The locus of direc-
tions of maximum principal stresses, for example, suggests paths of maximum load transfer throughout
a body.

Request a Vector Principals plot in the same way that you would request any other result. Scoping (p. 1214)
is also possible. Numerical data for these plots can be obtained by exporting the result values to an
.XLS file. These files have 6 fields. The first three correspond to the maximum, middle, and minimum
principal quantities (stresses or elastic strains). The last three correspond to the Mechanical APDL applic-
ation Euler angle sequence (CLOCAL command in the ANSYS environment) required to produce a co-
ordinate system whose X, Y and Z-axis are the directions of maximum, middle and minimum principal
quantities, respectively. This Euler angle sequence is ThetaXY, ThetaYZ, and ThetaZX and orients the
principal coordinate system relative to the global system. These results can be viewed using the
Graphics (p. 89) button, so that you can use the Vector Display toolbar.

Error (Structural)
You can insert an Error result based on stresses to help you identify regions of high error and thus
show where the model would benefit from a more refined mesh in order to get a more accurate answer.
You can also use the Error result to help determine where Mechanical will be refining elements if
Convergence (p. 1411) is active. The Error result is based on the same errors used in adaptive refine-

Release 2020 R1 - © ANSYS, Inc.


1232
Structural Results

ment (p. 1412). Information on how these errors are calculated is included in POST1 - Error Approximation
Technique, in the Theory Reference for ANSYS and ANSYS Workbench .

Note

The Error result is based on linear stresses and as such may be inaccurate in certain nonlinear
analyses (for example, when plasticity is active). Furthermore, the Error result is currently
restricted to isotropic materials. You may wish to refer to the Structural Material Properties
section of the Engineering Data help for additional information.

Presented below are example applications of using the Error result in a Structural simulation.

3D Model:

2D Model, Base Mesh:

2D Model, Adaptive Refinement (Convergence Added):

2D Model, With Mesh Control:

Release 2020 R1 - © ANSYS, Inc.


1233
Using Results

Thermal Strain
Thermal strain is computed when coefficient of thermal expansion is specified and a temperature load
is applied in a structural analysis. To specify the coefficient of thermal expansion, you must set Thermal
Strain Effects (p. 177) to Yes in the Details view of the part or body objects before initiating a solve.

Each component of thermal strain is computed as:

Where:

- thermal strain in one of the directions x, y, or z.

- Secant coefficient of thermal expansion defined as a material property in Engineering Data (see
“Chapter 2.4 Linear Material Properties” in the Element Reference of the Mechanical APDL application
Help for more information about the secant function).

- reference temperature or the "stress-free" temperature. This can be specified globally for the
model using the Reference Temperature field of Static Structural or Transient Structural analysis types.
Optionally you can also specify the reference temperature as a material property for cases such as the
analysis for cooling of a weld or solder joint where each material has a different stress-free temperature.

Equivalent Plastic Strain


The equivalent plastic strain gives a measure of the amount of permanent strain in an engineering
body. The equivalent plastic strain is calculated from the component plastic strain as defined in the
Equivalent (p. 1230) stress/strain section.

Most common engineering materials exhibit a linear stress-strain relationship up to a stress level known
as the proportional limit. Beyond this limit, the stress-strain relationship will become nonlinear, but will
not necessarily become inelastic. Plastic behavior, characterized by nonrecoverable strain or plastic
strain, begins when stresses exceed the material's yield point. Because there is usually little difference
between the yield point and the proportional limit, the Mechanical APDL application assumes that these
two points are coincident in plasticity analyses.

Release 2020 R1 - © ANSYS, Inc.


1234
Structural Results

In order to develop plastic strain, plastic material properties must be defined. You may define plastic
material properties by defining either of the following in the Engineering Data:

• Bilinear Stress/Strain curve.

• Multilinear Stress/Strain curve.

Note

Yield stresses defined under the Stress Limits section in the Engineering Data are used for
the post tools only (that is, Stress Safety Tools and Fatigue tools), and do not imply plastic
behavior.

Equivalent Creep Strain


Creep is a rate-dependent material nonlinearity in which the material continues to deform under a
constant load. The material deforms under an initial applied load and the load diminishes over time
with an increase in deformation or creep strain. The equivalent creep strain gives a measure of the
amount of the creep strain in an engineering body. The equivalent creep strain is calculated from
component creep strains.

In order to develop creep strain, creep material properties must be defined. You may define creep ma-
terial properties by choosing one of the available 13 creep models in Engineering Data. This result type
is available in Mechanical only after you have selected a creep material for at least one prototype in
the analysis.

Equivalent Total Strain


The equivalent total strain gives a total value of strain in any engineering body. The total strain com-
ponents are calculated by addition of components of elastic, plastic, thermal, and creep strains and
then equivalent total strain is calculated from total strain components. This result type is available in
Mechanical only if at least one of the other three strain results is available for post processing. In
Mechanical APDL this strain in called Total Mechanical and Thermal Strain.

Membrane Stress
Membrane stress calculates the stresses along the thickness of the shell in longitudinal direction, in
transverse direction, and in plane shear. The result is available only for shell bodies and solids that are
meshed using the thin-solid meshing option. Each element of the body can display individual stress
values and give a checkboard appearance to the result contours. The results are calculated in the element
coordinate system.

Release 2020 R1 - © ANSYS, Inc.


1235
Using Results

Shell membrane stress tensor (s11m, s22m, s12m) is the average of the in-plane stress tensor (s11(z),
s22(z), s12(z)) along the shell thickness direction:

Where:

t is the total shell thickness,


z is the thickness location where the in-plane stress is evaluated.

Unlike linearized stress in other elements, a pre-defined path through the shell thickness is not required
in order to compute shell membrane stress.

Note

Make sure that the Output Control (p. 904), General Miscellaneous is set to Yes or your
results may be under-defined.

Bending Stress
The result is available only for shell bodies and solids that are meshed using the thin-solid meshing
option and are calculated in the element coordinate system. Each element of the body can display in-
dividual stress values and give a check-board appearance to the result contours.

Shell bending stress tensor (s11b, s22b, s12b) represents the linear variation portion of the in-plane
stress tensor (s11(z), s22(z), s12(z)) along the shell thickness direction:

Where:

t is the total shell thickness,

Release 2020 R1 - © ANSYS, Inc.


1236
Structural Results

z is the thickness location where the in-plane stress is evaluated.

Note

Make sure that the Output Control (p. 904), General Miscellaneous is set to Yes or your
results may be under-defined.

Stabilization Energy
Stabilization can help with convergence problems, but it can also affect accuracy if the stabilization
energy or forces are too large. Although ANSYS automatically reports the stabilization force norms and
compares them to internal force norms, it is still very important to check the stabilization energy and
forces to determine whether or not they are excessive. If the stabilization energy is much less than the
potential energy (for example, within a 1.0 percent tolerance), the result should be acceptable. Stabiliz-
ation energy is not available to the Samcef or ABAQUS solver.

When stabilization energy is large, check the stabilization forces at each DOF for all substeps. If the
stabilization forces are much smaller than the applied loads and reaction forces (for example, within a
0.5 percent tolerance), the results are still acceptable. Such a case could occur when an elastic system
is loaded first, then unloaded significantly. It is possible that the final element potential energy is small
and stabilization energy is relatively large, but all stabilization forces are small. Currently, stabilization
forces are accessible in the .OUT file.

Even when both stabilization energy and forces are too large, the results could still be valid. Such a
scenario is possible when a large part of an elastic structure undergoes large rigid body motion (as in
a snap-through simulation). In such a case, the stabilization energy could be large as well as the stabil-
ization force for some DOFs at some substeps, but the results could still be acceptably accurate. Never-
theless, consider the results along with other support data and use your own discretion.

To insert a Stabilization Energy result, highlight the Solution object in the tree, then select Stabilization
Energy from the Solution Context Toolbar (p. 84) or right-click the object and choose Insert> Energy>
Stabilization Energy.

The following figure shows an example stabilization energy contour plot:

Release 2020 R1 - © ANSYS, Inc.


1237
Using Results

Strain Energy
Energy stored in bodies due to deformation. This value is computed from stress and strain results. It
includes plastic strain energy as a result of material plasticity.

To insert a Stabilization Energy result, highlight the Solution object in the tree, then select Stabilization
Energy from the Solution Context Toolbar (p. 84) or right-click the object and choose Insert> Energy>
Strain Energy.

Linearized Stress
The Linearized Stress results calculate membrane, bending, peak, and total stress along a straight line
path in the Mechanical application. To calculate linearized stress, you must first define a straight line
path object using Construction Geometry under Model. A path you define for linearized stress can
be of type Two Points or of type X axis Intersection and should have at least 47 sample points. The
number of points must be an odd number; otherwise the result will not solve and an error message
will be issued. The path must be straight and entirely within the model’s elements. The X axis Intersec-
tion option is recommend as it ensures that the start and end points are inside the mesh and that the
path is straight. Note that the Two Points method obtains the points from the tessellation of the geo-
metric model, and if the geometry faces are curved, the points might not be inside the mesh. For these
situations, you can use the Snap to mesh nodes feature (see Path (p. 661)) to ensure that the two points
are contained within the mesh.

Linearized stress does not support the Edge path type. To calculate linearized stresses:

1. In the object tree, select Solution to make the Solution toolbar available.

2. On the Solution toolbar, click Linearized Stress, and then click the stress you want to calculate.

3. In the Details view, select the Path you have defined to calculate the linearized stress.

4. Select the coordinate system you have used for the model.

5. Click Solve to calculate linearized stress along the path.

Geometry Select bodies that contribute toward stress calculation


Path The path you define to calculate the linearized stresses
Type Types of linearized stresses available
Coordinate System Coordinate systems you can select for stress calculation

About Linearized Stress


When the result is evaluated, component stress values at the path points are interpolated from the
appropriate element's average corner nodal values. Stress components through the section are linearized
by a line integral method and are separated into constant membrane stresses, bending stresses varying
linearly between end points, and peak stresses (defined as the difference between the actual (total)
stress and the membrane plus bending combination).

The Details view shows Membrane, Bending, Membrane + Bending, Peak, and Total stresses. The
bending stresses are calculated such that the neutral axis is at the midpoint of the path.

Release 2020 R1 - © ANSYS, Inc.


1238
Structural Results

Principal stresses are recalculated from the component stresses and are invariant with the coordinate
system as long as stress is in the same direction at all points along the defined path. It is generally re-
commended that calculations be performed in a rectangular coordinate system (e.g. global Cartesian).

The Details view also includes the following three choices for the 2D Behavior (2D analysis (p. 502) only)
property: Planar, Axisymmetric Straight, and Axisymmetric Curve. These choices are available only
for 2D geometries (e.g., plane stress).

For Axisymmetric Straight and Axisymmetric Curve, the Details view includes entries for Average
Radius of Curvature and Through-Thickness Bending Stress.

The Average Radius of Curvature represents the in-plane (X-Y) average radius of curvature of the inside
and outside surfaces of an axisymmetric section. If the radius is zero, a plane or 3D structure is assumed.
The curve radius is in the current units.

An Axisymmetric Straight analysis always has an infinite radius of curvature (which is denoted by a
value of -1).

The choices for Through-Thickness Bending Stress are:

• Include: Include the thickness-direction bending stresses.

• Ignore: Ignore the thickness-direction bending stresses.

• Include Using Y Dir. Formula: Include the thickness-direction bending stress using the same formula as
the Y (axial direction) bending stress. Also use the same formula for the shear stress.

If the Average Radius of Curvature is non-zero, Mechanical reports the linearized stresses in the section
coordinates (SX – along the path, SY – normal to the path, and SZ – hoop direction). In this case, the
choice of Coordinate System in the Details view is ignored.

If the Average Radius of Curvature is zero, Mechanical reports the linearized stresses in the active
results coordinate system.

Notes on Linearized Stress


• The line integral method is the same as that used in the Mechanical APDL command PRSECT, RHO, KBR.

• Mechanical does not support the Solution Coordinate System for this result.

• The Worksheet reports the linearized component and principal stresses for each stress category at the be-
ginning, mid-length, and end of the section path.

Damage Results
Mechanical supports a number of damage results using non-linear material models, including the Mullins
Effect, Progressive Damage, and Physical Failure Criteria.

Mullins Effect
The Mullins effect is a phenomenon resulting from load-induced changes to constitutive response ex-
hibited by some hyper elastic materials, especially filled polymers. The effect is most evident during
cyclic loading, where the unloading response is more compliant than the loading behavior. During the
process of cyclic loading, stress-strain curve for these materials is dependent on the maximum previous
load, where the load is the strain energy of the virgin hyper elastic material. As the maximum previous

Release 2020 R1 - © ANSYS, Inc.


1239
Using Results

load increases, changes to the virgin hyper elastic constitutive model also increase, due to the Mullins
effect. Below the maximum previous load, the Mullins effect changes are not evolving; however, the
Mullins effect still modifies the hyper elastic constitutive response based on the maximum previous
load. If the load increases beyond the maximum previous all time value, the result is an irreversible and
instantaneous softening of the material, which causes a hysteresis in the stress-strain response.

The Mullins effect is modeled with the modified Ogden-Roxburgh pseudo-elastic model (TB,CDM,,,,PSE2)
and is applicable to any nearly or purely incompressible hyperelastic model (TB,HYPER). For more in-
formation on the Mullins effect, see Mullins Effect Material Model.

Mechanical supports two results for the Mullins Effect: Mullins Damage Variable and Mullins Max. Previous
Strain Energy.

The Mullins Damage Variable is a unitless scale range from 0, at which the material is completely damaged
without any stiffness, to 1, at which the material is intact, without any loss of stiffness.

At a given time step, the Mullins Max. Previous Strain Energy result is the maximum value of strain energy
of the virgin material in the time interval [0, t0], where t0 is the beginning of a time step. Depending
on the unit system you choose, this result chooses the appropriate unit of energy. A typical unit is the
Joules (J) unit.

Progressive Damage
Progressive Damage is associated with the damage phenomenon that occurs in composite materials.
When a composite material is subjected to loading, the matrix and fiber controlled types of failure can
occur both separately or sequentially. After a certain point, the material experiences enough damage
in the form of the local failures that the material can no longer sustain the load. These local failures
govern the ultimate load that the material can withstand.

Progressive Damage uses material damage initiation (TB, DMGI) and evolution criteria (TB, DMGE) to
analyze the progressive damage in composites. While Physical Failure Criteria analyzes the failure criteria,
Progressive Damage analyzes the progression of the damage.

Damage Initiation Criteria defines the criteria type for determining the onset of material damage under
loading. Depending upon the failure mode selected here, the respective failure criteria will be computed
for “Physical Failure Criteria”. The available failure modes for damage are:

• Maximum Strain

• Maximum Stress

• Puck

• Hashin

• LaRc03

• LaRc04

The Damage Evolution Law defines the material damage evolution law (or the way a material degrades)
following the initiation of damage. The stiffness reduction takes a value of 0 to 1, where 0 is no damage
and 1 is completely damaged.

For more information, see Damage Evolution Law and Damage Initiation Criteria in the Mechanical
APDL documentation.

Release 2020 R1 - © ANSYS, Inc.


1240
Structural Results

The Progressive Damage model supports the following results:

Result Description
Damage Status The Damage Status result will be an enum type with values of 0,
1, or 2, where

• 0 -- undamaged

• 1 -- partially damaged

• 2 -- completely damaged

Fiber Tensile Damage The Fiber Tensile Damage Variable result value will be in the range
Variable of 0 to the “Tensile Fiber Stiffness Reduction” value set in the
Damage Evolution Law. In other words, if you set the Tensile Fiber
Stiffness Reduction to 0.6, the range of Fiber Tensile damage
variable result will be in the range of 0 to 0.6.

A value of 0 for this result means undamaged and a value of 1


means completely damaged. The result has no units.
Fiber Compressive Damage The Fiber Compressive Damage Variable result value will be in the
Variable range of 0 to the “Compressive Fiber Stiffness Reduction” value
set in the Damage Evolution Law. In other words, if you set the
Compressive Fiber Stiffness Reduction to 0.6, the range of Fiber
Tensile damage variable result will be in the range of 0 to 0.6.

A value of 0 for this result means undamaged and a value of 1


means completely damaged. The result has no units.
Matrix Tensile Damage The Matrix Tensile Damage Variable result value will be in the
Variable range of 0 to the “Tensile Matrix Stiffness Reduction” value set in
the Damage Evolution Law i.e. if you set the Tensile Matrix Stiffness
Reduction to 0.6, the range of Fiber Tensile damage variable result
will be in the range of 0 to 0.6.

A value of 0 for this result means undamaged and a value of 1


means completely damaged. The result has no units.
Matrix Compressive The Matrix Compressive Damage Variable result value will be in
Damage Variable the range of 0 to the “Compressive Fiber Stiffness Reduction” value
set in the Damage Evolution Law i.e. if you set the Compressive
Fiber Stiffness Reduction to 0.6, the range of Fiber Tensile damage
variable result will be in the range of 0 to 0.6.

A value of 0 for this result means undamaged and a value of 1


means completely damaged. The result has no units.
Shear Damage Variable The Shear Damage Variable result value will be in the range of 0 to 1.
This value is computed using the results of Fiber Tensile Damage
Variable, Fiber Compressive Damage Variable, Matrix Tensile Damage
Variable, and Matrix Compressive Damage Variable. The result has no
units.
Energy Dissipated Per The Energy Dissipated Per Volume result value will be a positive
Volume real number.

Release 2020 R1 - © ANSYS, Inc.


1241
Using Results

Result Description
This result uses a unit of “Energy/Volume” in the unit system you
choose.

Physical Failure Criteria


The respective failure criteria are computed for the failure modes chosen in the damage initiation cri-
teria. While the damage variables give you an idea where the damage is located and its likely direction
of propagation, the Physical Failure Criteria helps you determine how much more load the material can
handle.

These failure criteria are computed based on the parameters given using the material damage initiation
(TB, DMGI) and evolution criteria (TB, DMGE). For more information, see Progressive Damage (p. 1240),
above, as well as Damage Evolution Law, Damage Initiation Criteria, and Physical Failure Criteria in the
Mechanical APDL documentation.

The Physical Failure Criteria model supports the following results:

Result Description
Max Failure Criteria The Max Failure Criteria is computed based on the maximum of Fiber
Tensile Failure Criterion, Fiber Compressive Failure Criterion, Matrix
Tensile Failure Criterion, and Matrix Compressive Failure Criterion.
Fiber Tensile Failure The Fiber Tensile Failure Criterion result value will be a positive integer.
Criterion A value of 0 indicates no failure, while 1 is a complete failure. A value
above 1 indicates the material has completely failed. The higher this
number, the higher the load above the prescribed limits, although
specifics are dependent on the stress limits you set and the amount
of loading applied.
Fiber Compressive Failure The Fiber Compressive Failure Criterion result value will be a positive
Criterion integer. A value of 0 indicates no failure, while 1 is a complete failure.
A value above 1 indicates the material has completely failed. The higher
this number, the higher the load above the prescribed limits, although
specifics are dependent on the stress limits you set and the amount
of loading applied.
Matrix Tensile Failure The Matrix Tensile Failure Criterion result value will be a positive integer.
Criterion A value of 0 indicates no failure, while 1 is a complete failure. A value
above 1 indicates the material has completely failed. The higher this
number, the higher the load above the prescribed limits, although
specifics are dependent on the stress limits you set and the amount
of loading applied.
Matrix Compressive Failure The Matrix Compressive Failure Criterion result value will be a positive
Criterion integer. A value of 0 indicates no failure, while 1 is a complete failure.
A value above 1 indicates the material has completely failed. The higher
this number, the higher the load above the prescribed limits, although
specifics are dependent on the stress limits you set and the amount
of loading applied.

Release 2020 R1 - © ANSYS, Inc.


1242
Structural Results

Contact Results
If your model contains Contact Regions, you can define the contact results as listed below under the
Solution object by inserting a Contact Tool. See the Reviewing the Results section of the Contact
Technology Guide for additional information.

• Gap

• Penetration

• Pressure

• Frictional Stress - available only for evaluating contact conditions after solution.

Note

– To reflect total contact pressures or frictional stress, you must either set the Behavior (p. 703)
option to Asymmetric or Auto Asymmetric, or manually create an asymmetric contact
pair (p. 723).

– For node-to-surface contact, Pressure will display zero results. To display the associated contact
force, you must insert a user defined result (p. 1340) called CONTFORC.

• Sliding Distance - available only for evaluating contact conditions after solution. The total sliding distance
(SLIDE) is the amplitude of total accumulated slip increments (a geometrical measurement) when the contact
status is sticking or sliding (STAT = 2, 3). It contains contributions from the elastic slip and the frictional slip.
Elastic slip due to sticking represents the reversible tangential motion from the point of zero tangential
stresses. Ideally, the equivalent elastic slip does not exceed the user-defined absolute limit. The higher the
tangent stiffness, the smaller the resulting elastic slip. The pair-based elastic slip can be monitored using
the Contact Result Tracker (p. 1408).

• Fluid Pressure - Fluid penetration pressure (surface-to-surface contact only). Note that command snippets
are required to apply the loading to create this result. For more information, see Applying Fluid Pressure-
Penetration Loads in the Mechanical APDL Contact Technology Guide.

• Status. Status codes include:

– -3 - MPC bonded contact.

– -2 - MPC no-separation contact.

– 0 - open and not near contact.

– 1 - open but near contact.

– 2 - closed and sliding.

– 3 - closed and sticking.

Release 2020 R1 - © ANSYS, Inc.


1243
Using Results

The labels Far, Near, Sliding, and Sticking are included in the legend for Status.

Note

– MPC-based contact definitions use negative values. They indicate the intentional removal of
one or more contact constraints to prevent over-constraint.

– Contact that has been deactivated via Auto Asymmetric behavior will be displayed with a
status of Far-Open. Results for deactivated pairs can be suppressed in the Contact Tool by
changing Both to either Contact or Target as necessary.

If you choose to display contact results with a display option other than Unaveraged, then Mechanical
uses all elements in the selected regions to calculate the result. That is, Mechanical averages contact
across regions regardless of whether you scoped the result via Geometry Selection or via the Worksheet.

For example, if you set the display option to Averaged, then the displayed result for a node is the
average of all values (from all selected elements) at that node. Contact elements can be coincident,
which may be difficult to discern visually, and Mechanical does not display unaveraged contact results
if it detects coincident elements in the scoping. However, Mechanical calculates and displays averaged
contact results for coincident elements.

In addition, if more than one face on a non-contact element (such as a solid element) includes contact
elements, Mechanical does not display unaveraged contact results because the application cannot assign
multiple contact values to a node.

The images below illustrate how contact results are affected by the different scoping types. The model
consists of two blocks contacting a third block.

Using the Worksheet method, one Contact Tool was scoped to the contact pair on the left, and another
one was scoped to the contact pair on the right. This allows you to view the contact results for each
contact pair individually. The contact status for the contact pair on the left is shown below.

Release 2020 R1 - © ANSYS, Inc.


1244
Structural Results

The contact status for the contact pair on the right is shown below.

A third Contact Tool scoped to the surface of the large block (using the Geometry Selection method)
enables you to view the contact status averaged over that surface, as shown below.

Contact Results Restrictions


Note the following restrictions regarding contact results:

Release 2020 R1 - © ANSYS, Inc.


1245
Using Results

• When a contact result is scoped to a face of an assembly, a contact result may not be obtained in certain
cases, especially if the scoped face is not a part of any contact region.

• Contour contact results are not reported for 3D edge contact.

• If you use the Generate Initial Contact Results option on a Contact Tool contained in the Connections
folder, and use the Worksheet to scope these Initial Contact results, the application displays the contour
results for the geometry scoping of the contact pairs, not the individual contact elements. Therefore, and
as illustrated above by the third Contact Tool scoped to a surface, the results appear as if the scoping is to
the geometric faces.

• If the contact status of all nodes of a contact element is FAR (or 0), then 16.0 will report all contact results
as undefined.

• For any contact result, the averaged contact results at 16.0 can display values that differ from values of
previous revisions, if:

– (a) two contact elements share nodes, and,

– (b) one of the elements has a FAR contact status, and,

– (c) one of the elements does not have a FAR status.

This is because, prior to 16.0, the elements with FAR status reported values that were ZERO. At 16.0,
these elements have no values and are not involved in the averaging process.

Frequency Response and Phase Response


Graphs can be either Frequency Response graphs that display how the response varies with frequency
or Phase Response plots that show how much a response lags behind the applied loads over a phase
period.

Frequency Response
You can scope graphical results using:

• Geometry selection (vertex, face, edge, or nodes)

• Named Selections (p. 583)

• Contact Regions (p. 1669)

• Springs (p. 818)

• Beam Connections (p. 825)

• Support Boundary Conditions (p. 1077) (Fixed Support, Displacement, Frictionless Support, Cylindrical
Support)

• Remote Points (p. 609)

You can view these options as a value graphed along a specified frequency range. These include the
frequency results for stress, elastic strain, deformation, velocity, acceleration (frequency only), and force
reaction plotted as a graph. In addition, you can parameterize these frequency results. The plot will in-

Release 2020 R1 - © ANSYS, Inc.


1246
Structural Results

clude all the frequency points at which a solution was obtained. When you generate frequency response
results, the default plot (Bode) shows the amplitude and phase angle.

Note

Direct graphical node selection requires you to generate the mesh and have the Select Mesh
(see Graphics Options Toolbar (p. 94) Help) tool chosen.

The following equations describe how frequency graphs are defined and plotted.

Stress and Strain Results


The strain result is calculated using the displacement result. Using the Young’s Modulus and strain result,
the stress result can be evaluated. Because of this reason, the stress and strain results are in phase with
the displacement result.

Displacement Result
The displacement vector on a structure subjected to harmonic loading may be expressed as:

EQUATION 1

The Frequency Response chart for Displacement is calculated by expressing Equation (1) in time
domain as follows:

EQUATION 2

where:

Velocity Result
The equation for velocity can be obtained by taking a time derivative of Equation (1). The frequency re-
sponse for velocity in time domain is calculated as follows:

EQUATION 3

where:

Release 2020 R1 - © ANSYS, Inc.


1247
Using Results

Acceleration Result
The equation for acceleration can be obtained by taking a double time derivative of Equation (1). The
frequency response for acceleration in time domain is calculated as follows:

EQUATION 4

where:

Force Reaction
The Frequency Response for Force Reaction is calculated by replacing displacement with force in Equation
(2) as shown below.

EQUATION 5

where:

(Amplitude)

(Phase Angle)

Optionally, the Display property provides the following results values for graphs:

• Real

• Imaginary

Release 2020 R1 - © ANSYS, Inc.


1248
Structural Results

• Real and Imaginary

• Amplitude

• Phase Angle

• Bode (default setting - plots both Amplitude and Phase Angle)

The Chart Viewing Style property provides the following options to plot results for a scale of an axis:

• Linear: this option plots the result values linearly.

• Log X: this option plots the X-Axis logarithmically. If negative axis values or a zero value exists, this
option is not supported and the graph plots linearly.

• Log Y (default when graph has Amplitude): this option plots the Y-Axis is plotted logarithmically. If
negative axis values or a zero value exists, this option is not supported and the graph plots linearly.

• Log-Log: this option plots the X-Axis and Y-Axis logarithmically. If negative axis values or a zero value
exists, this option is not supported and the graph plots linearly.

For edges, faces, surface bodies, and multiple vertex selections (which contain multiple nodes), the
results can be scoped as minimum, maximum, or average using the Spatial Resolution option. This
option is also available for frequency and phase response results scoped on a single vertex.

Note

The Spatial Resolution option is especially important for results scoped to a shell vertex,
where the default option, Use Average, may yield unexpected results.

The Use Minimum and Use Maximum settings of the Spatial Resolution option are based on the
amplitude and thus are reported from the location with either the largest or smallest amplitude. The
Use Average setting calculates the average by calculating the real and imaginary components separately.

Note

You cannot use the Mechanical application convergence capabilities for any results item
under a harmonic analysis. Instead, you can first do a convergence (p. 1411) study on a modal
analysis (p. 227) and reuse the mesh from that analysis.

Presented below is an example of a Frequency Response plot:

Release 2020 R1 - © ANSYS, Inc.


1249
Using Results

The average, minimum, or maximum value can be chosen for selected entities. Stress, Strain, Deform-
ation, Velocity, and Acceleration components vary sinusoidally, so these are the only result types that
can be reviewed in this manner. (Note that items such as Principal Stress or Equivalent Stress do not
behave in a sinusoidal manner since these are derived quantities.)

Phase Response
Similarly, Phase Response plots show the minimum, average, or maximum Stress, Strain, or Deformation
for selected graphical entities (vertex, face, edge, or nodes) or a Named Selection (p. 583). An example
of a Phase Response plot is illustrated below.

Release 2020 R1 - © ANSYS, Inc.


1250
Structural Results

However, unlike Frequency Response plots that show a response amplitude over a frequency range,
Phase Response plots show a response over a phase period, so you can determine how much a response
lags behind the applied load.

The following functions outline the relationships of response amplitude, phase response graphs, and
result contours (with associated caveats):

Response Amplitude
Response Amplitude is defined as the maximum value of the following expression:

value = sqrt(real*real + imag*imag)

Where real and imag represent all real and imaginary result values from the result file for the selected
frequency.

Phase Response Graph


The graph is the image of the following function, where Sweeping Phase is allowed to vary across a user
specified Duration:

value = AMPLITUDE * sin(phase)

Note

Take caution when comparing the values in the Output column of the Tabular Data
for a Phase Response against maximum values of contour displays.

Result Contour
Drawing contour displays in a Harmonic Response analysis, Mechanical uses the phase specified by the
Sweeping Phase property defined by the user to evaluate the expression:

value = real*cos(phase) - imag*sin(phase)

Where real and imag represent all real and imaginary result values from the result file for the selected
frequency.

Because the formula for the Phase Response graph differs from the formula for the contour, an Output
value for the graph does not necessarily equal a maximum for a contour result at the same frequency.

General Approach to Harmonic Response Analysis Postprocessing

Generally speaking, you would look at Frequency Response plots at critical regions to ascertain what
the frequency of interest may be. In conjunction with Phase Response plots, the phase of interest is
also determined. Then, you can request Stress, Strain, or Deformation contour plots to evaluate the
response of the entire structure at that frequency and phase of interest.

Creating Contour Result from Frequency Response Results


You can use Frequency Response result types (not including Velocity and Acceleration) to generate
new result objects of the same type, orientation, frequency. The phase angle of the contour result will
be opposite in sign with the same magnitude as the frequency response result type. The sign of the
phase in the Sweeping Phase property of the contour result is reversed so that the response amplitude
of the frequency response plot for that frequency and phase defined by the Duration property matches
with the contour results. To create a Contour Result in a Harmonic Analysis:

Release 2020 R1 - © ANSYS, Inc.


1251
Using Results

1. Select and right-click the desired Harmonic result in the solution tree.

2. Choose Create Contour Result.

As illustrated here, you can see how the feature automatically scopes the Type, Orientation, Coordinate
System, Frequency, and Sweeping Phase.

Release 2020 R1 - © ANSYS, Inc.


1252
Structural Results

The Reported Frequency in the Information category is the frequency at which contour results were
found and plotted. This frequency can be potentially different from the frequency you requested.

Limitations
For a Mode Superposition Harmonic Response Analysis (standalone and linked MSUP), if the Store
Results At All Frequencies property in the Options category (p. 890) of the Analysis Settings is set
to No, the Frequency Response and Phase Response results can be scoped to geometric entities only
(node-based scoping is not allowed).

If the Store Results At All Frequencies property in the Options category (p. 890) of the Analysis Set-
tings is set to No, the Frequency Response results for force reactions cannot be extracted.

Release 2020 R1 - © ANSYS, Inc.


1253
Using Results

Stress Tools
You can insert any of the following stress tools in a Solution object by choosing Stress Tool under
Tools in the Solution context toolbar, or by using a right mouse button click a Solution object and
choosing Stress Tool:

Maximum Equivalent Stress Safety Tool (p. 1255)


Maximum Shear Stress Safety Tool (p. 1256)
Mohr-Coulomb Stress Safety Tool (p. 1258)
Maximum Tensile Stress Safety Tool (p. 1260)

After adding a Stress Tool object to the tree, you can change the specific stress tool under Theory in
the Details view.

The Stress Tools make use of the following material properties:

• Tensile Yield Strength

• Compressive Yield Strength

• Tensile Ultimate Strength

• Compressive Ultimate Strength

Safety Tools in the ANSYS Workbench Product


The ANSYS Workbench product uses safety tools that are based on four different stress quantities:

1. Equivalent stress (σe).

2. Maximum tensile stress (σ1).

3. Maximum shear stress (τMAX)

This uses Mohr's circle:

where:
σ1 and σ3 = principal stresses.

4. Mohr-Coulomb stress

This theory uses a stress limit based on

where:

Release 2020 R1 - © ANSYS, Inc.


1254
Structural Results

Maximum Equivalent Stress Safety Tool


The Maximum Equivalent Stress Safety tool is based on the maximum equivalent stress failure theory
for ductile materials, also referred to as the von Mises-Hencky theory, octahedral shear stress theory,
or maximum distortion (or shear) energy theory. Of the four failure theories supported by the Mechan-
ical application, this theory is generally considered as the most appropriate for ductile materials such
as aluminum, brass and steel.

The theory states that a particular combination of principal stresses causes failure if the maximum
equivalent stress in a structure equals or exceeds a specific stress limit:

Expressing the theory as a design goal:

If failure is defined by material yielding, it follows that the design goal is to limit the maximum equivalent
stress to be less than the yield strength of the material:

An alternate but less common definition states that fracturing occurs when the maximum equivalent
stress reaches or exceeds the ultimate strength of the material:

Options
Define the stress limit in the Details view under Stress Limit Type. Use either Tensile Yield Per Mater-
ial, or Tensile Ultimate Per Material, or enter a Custom Value. By default, Stress Limit Type equals
Tensile Yield Per Material.

Choose a specific result from the Stress Tool context toolbar or by inserting a stress tool result using
a right mouse button click Stress Tool:

Safety Factor

Safety Margin

Stress Ratio

Release 2020 R1 - © ANSYS, Inc.


1255
Using Results

Notes
• The reliability of this failure theory depends on the accuracy of calculated results (p. 1411) and the represent-
ation of stress risers (peak stresses). Stress risers play an important role if, for example, yielding at local dis-
continuities (e.g., notches, holes, fillets) and fatigue loading are of concern. If calculated results are suspect,
consider the calculated stresses to be nominal stresses, and amplify the nominal stresses by an appropriate
stress concentration factor Kt. Values for Kt are available in many strength of materials handbooks.

• If fatigue is not a concern, localized yielding will lead to a slight redistribution of stress, and no real failure
will occur. According to J. E. Shigley (Mechanical Engineering Design, McGraw-Hill, 1973), "We conclude, then,
that yielding in the vicinity of a stress riser is beneficial in improving the strength of a part and that stress-
concentration factors need not be employed when the material is ductile and the loads are static."

• Alternatively, localized yielding is potentially important if the material is marginally ductile, or if low temper-
atures or other environmental conditions induce brittle behavior.

• Yielding of ductile materials may also be important if the yielding is widespread. For example, failure is most
often declared if yielding occurs across a complete section.

• The proper selection and use of a failure theory relies on your engineering judgment. Refer to engineering
texts such as Engineering Considerations of Stress, Strain, and Strength by R. C. Juvinall (McGraw-Hill) and
Mechanical Engineering Design by J. E. Shigley (McGraw-Hill) for in-depth discussions on the applied theories.

Maximum Shear Stress Safety Tool


The Maximum Shear Stress Safety tool is based on the maximum shear stress failure theory for ductile
materials.

The theory states that a particular combination of principal stresses causes failure if the Maximum
Shear (p. 1231) equals or exceeds a specific shear limit:

where the limit strength is generally the yield or ultimate strength of the material. In other words, the
shear strength of the material is typically defined as a fraction (f < 1) of the yield or ultimate strength:

In a strict application of the theory, f = 0.5. Expressing the theory as a design goal:

If failure is defined by material yielding, it follows that the design goal is to limit the shear stress to be
less than a fraction of the yield strength of the material:

An alternate but less common definition states that fracturing occurs when the shear stress reaches or
exceeds a fraction of the ultimate strength of the material:

Release 2020 R1 - © ANSYS, Inc.


1256
Structural Results

Options
Define the stress limit in the Details view under Stress Limit Type. Use either Tensile Yield Per Mater-
ial, or Tensile Ultimate Per Material, or enter a Custom Value. By default, Stress Limit Type equals
Tensile Yield Per Material.

Define coefficient f under Factor in the Details view. By default, the coefficient f equals 0.5.

Choose a specific result from the Stress Tool context toolbar or by inserting a stress tool result using
a right mouse button click Stress Tool:

Safety Factor

Safety Margin

Stress Ratio

Notes
• The reliability of this failure theory depends on the accuracy of calculated results and the representation of
stress risers (peak stresses). Stress risers play an important role if, for example, yielding at local discontinuities
(e.g., notches, holes, fillets) and fatigue loading are of concern. If calculated results are suspect, consider the
calculated stresses to be nominal stresses, and amplify the nominal stresses by an appropriate stress con-
centration factor Kt. Values for Kt are available in many strength of materials handbooks.

• If fatigue is not a concern, localized yielding will lead to a slight redistribution of stress, and no real failure
will occur. According to J. E. Shigley (Mechanical Engineering Design, McGraw-Hill, 1973), "We conclude, then,
that yielding in the vicinity of a stress riser is beneficial in improving the strength of the part and that stress-
concentration factors need not be employed when the material is ductile and the loads are static."

• Alternatively, localized yielding is potentially important if the material is marginally ductile, or if low temper-
atures or other environmental conditions induce brittle behavior.

• Yielding of ductile materials may also be important if the yielding is widespread. For example, failure is most
often declared if yielding occurs across a complete section.

• The proper selection and use of a failure theory relies on your engineering judgment. Refer to engineering
texts such as Engineering Considerations of Stress, Strain, and Strength by R. C. Juvinall (McGraw-Hill) and
Mechanical Engineering Design by J. E. Shigley (McGraw-Hill) for in-depth discussions on the applied theories.

Release 2020 R1 - © ANSYS, Inc.


1257
Using Results

Mohr-Coulomb Stress Safety Tool


The Mohr-Coulomb Stress Safety Tool is based on the Mohr-Coulomb theory for brittle materials, also
known as the internal friction theory.

The theory states that failure occurs when the combination of the Maximum, Middle, and Minimum
Principal (p. 1231) equal or exceed their respective stress limits. The theory compares the maximum tensile
stress to the material's tensile limit and the minimum compressive stress to the material's compressive
limit. Expressing the theory as a design goal:

where σ1 > σ2 > σ3; σ3 and the compressive strength limit assume negative values even though you
must actually enter positive values for these quantities. Also, a given term is only used if it includes the
correct sign. For example, σ1 must be positive and σ3 must be negative. Otherwise, the invalid term is
assumed to be negligible.

Note that the Mohr-Coulomb Stress Safety tool evaluates maximum and minimum principal stresses at
the same locations. In other words, this tool does not base its calculations on the absolute maximum
principal stress and the absolute minimum principal stress occurring (most likely) at two different locations
in the body. The tool bases its calculations on the independent distributions of maximum and minimum
principal stress. Consequently, this tool provides a distribution of factor or margin of safety throughout
the part or assembly. The minimum factor or margin of safety is the minimum value found in this dis-
tribution.

For common brittle materials such as glass, cast iron, concrete and certain types of hardened steels,
the compressive strength is usually much greater than the tensile strength, of which this theory takes
direct account.

The design goal is to limit the maximum and minimum principal stresses to their ultimate strength
values by means of the brittle failure relationship:

An alternative but less common definition compares the greatest principal stresses to the yield strengths
of the material:

The theory is known to be more accurate than the maximum tensile stress failure theory used in the
Maximum Tensile Stress Safety tool, and when properly applied with a reasonable factor of safety the
theory is often considered to be conservative.

Options
Define the tensile stress limit in the Details view under Tensile Limit Type. Use either Tensile Yield
Per Material, or Tensile Ultimate Per Material, or enter a Custom Value. By default, Tensile Limit
Type equals Tensile Yield Per Material.

Release 2020 R1 - © ANSYS, Inc.


1258
Structural Results

Define the compressive stress limit in the Details view under Compressive Limit Type. Use either Comp.
Yield Per Material, or Comp. Ultimate Per Material, or enter a Custom Value. By default, Compressive
Limit Type equals Comp. Yield Per Material.

Choose a specific result from the Stress Tool context toolbar or by inserting a stress tool result using
a right mouse button click Stress Tool:

Safety Factor

Safety Margin

Stress Ratio

Notes
• The use of a yield strength limit with brittle materials is not recommended since most brittle materials do
not exhibit a well-defined yield strength.

• For ductile and some other types of materials, experiments have shown that brittle failure theories may be
inaccurate and unsafe to use. The brittle failure theories may also be inaccurate for certain brittle materials.
Potential inaccuracies are of particular concern if the accuracy of calculated answers (p. 1411) is suspect.

• The reliability of this failure criterion is directly related to treatment of stress risers (peak stresses). For brittle
homogeneous materials such as glass, stress risers are very important, and it follows that the calculated
stresses should have the highest possible accuracy or significant factors of safety should be expected or
employed. If the calculated results are suspect, consider the calculated stresses to be nominal stresses, and
amplify the nominal stresses by an appropriate stress concentration factor K t. Values for Kt are available in
many strength of materials handbooks. For brittle nonhomogeneous materials such as gray cast iron, stress
risers may be of minimal importance.

• If a part or structure is known or suspected to contain cracks, flaws, or is designed with sharp notches or re-
entrant corners, a more advanced analysis may be required to confirm its structural integrity. Such discon-
tinuities are known to produce singular (i.e., infinite) elastic stresses; if the possibility exists that the material
might behave in a brittle manner, a more rigorous fracture mechanics evaluation needs to be performed.
An analyst skilled in fracture analysis can use the Mechanical APDL application to determine fracture
mechanics information.

• The proper selection and use of a failure theory relies on your engineering judgment. Refer to engineering
texts such as Engineering Considerations of Stress, Strain, and Strength by R. C. Juvinall (McGraw-Hill) and
Mechanical Engineering Design by J. E. Shigley (McGraw-Hill) for in-depth discussions on the applied theories.

Release 2020 R1 - © ANSYS, Inc.


1259
Using Results

Maximum Tensile Stress Safety Tool


The Maximum Tensile Stress Safety tool is based on the maximum tensile stress failure theory for brittle
materials.

The theory states that failure occurs when the maximum principal stress (p. 1231) equals or exceeds a
tensile stress limit. Expressing the theory as a design goal:

The maximum tensile stress failure theory is typically used to predict fracture in brittle materials with
static loads. Brittle materials include glass, cast iron, concrete, porcelain and certain hardened steels.

The design goal is to limit the greatest principal stress to be less than the material's ultimate strength
in tension:

An alternate definition compares the greatest principal stress to the yield strength of the material:

For many materials (usually ductile materials), strength in compression and in tension are roughly equal.
For brittle materials, the compressive strength is usually much greater than the tensile strength.

The Mohr-Coulomb theory used in the Mohr-Coulomb Stress Safety tool is generally regarded as more
reliable for a broader range of brittle materials. However, as pointed out by R. C. Juvinall (Engineering
Considerations of Stress, Strain, and Strength, McGraw-Hill, 1967), "There is some evidence to support its
use with porcelain and concrete. Also, it has been used in the design of guns, as some test results on
thick-walled cylinders tend to agree with this theory."

Options
Define the stress limit in the Details view under Stress Limit Type. Use either Tensile Yield Per Mater-
ial, or Tensile Ultimate Per Material, or enter a Custom Value. By default, Stress Limit Type equals
Tensile Yield Per Material.

Choose a specific result from the Stress Tool context toolbar or by inserting a stress tool result using
a right mouse button click Stress Tool:

Safety Factor

Safety Margin

Release 2020 R1 - © ANSYS, Inc.


1260
Structural Results

Stress Ratio

Notes
• The use of a yield strength limit with brittle materials is not recommended since most brittle materials do
not exhibit a well-defined yield strength.

• For ductile and some other types of materials, experiments have shown that brittle failure theories may be
inaccurate and unsafe to use. The brittle failure theories may also be inaccurate for certain brittle materials.
Potential inaccuracies are of particular concern if the accuracy of calculated answers is suspect.

• The reliability of this failure criterion is directly related to treatment of stress risers (peak stresses). For brittle
homogeneous materials such as glass, stress risers are very important, and it follows that the calculated
stresses should have the highest possible accuracy or significant factors of safety should be expected or
employed. If the calculated results are suspect, consider the calculated stresses to be nominal stresses, and
amplify the nominal stresses by an appropriate stress concentration factor K t. Values for Kt are available in
many strength of materials handbooks. For brittle nonhomogeneous materials such as gray cast iron, stress
risers may be of minimal importance.

• If a part or structure is known or suspected to contain cracks, flaws, or is designed with sharp notches or re-
entrant corners, a more advanced analysis may be required to confirm its structural integrity. Such discon-
tinuities are known to produce singular (i.e., infinite) elastic stresses; if the possibility exists that the material
might behave in a brittle manner, a more rigorous fracture mechanics evaluation needs to be performed.
An analyst skilled in fracture analysis can use the Mechanical APDL application program to determine fracture
mechanics information.

• The proper selection and use of a failure theory relies on your engineering judgment. Refer to engineering
texts such as Engineering Considerations of Stress, Strain, and Strength by R. C. Juvinall (McGraw-Hill) and
Mechanical Engineering Design by J. E. Shigley (McGraw-Hill) for in-depth discussions on the applied theories.

Fatigue (Fatigue Tool)


See Fatigue Results (p. 1323).

Fracture Results (Fracture Tool)


To review fracture results in Mechanical, you insert a Fracture Tool (p. 1700) object under the Solution
folder, and then add Fracture Results (p. 1264) under the Fracture Tool.

There are six types of Fracture Results:

• SIFS Results

• J-Integral

• VCCT Results

• Material Force

• T-Stress

Release 2020 R1 - © ANSYS, Inc.


1261
Using Results

• C*-Integral

Mechanical computes the fracture parameter result based on the type and subtype of the result defin-
ition. The type is based on a SIFS, JINT, VCCT, Material Force, T-Stress and C*-Integral based result. The
subtype for SIFS result is the Mode I Stress Intensity Factor (K1), Mode II Stress Intensity Factor (K2) and
Mode III Stress Intensity Factor (K3). The subtype for the VCCT based result is Mode I Energy Release
rate (G1), Mode II Energy Release rate (G2), Mode III Energy Release rate (G3), and Total Energy Release
rate (GT). The subtype for the Material Force result include X Axis, Y Axis, and Z Axis of the Material
Force in the local coordinates of the crack front nodes. The JINT, T-Stress and C*-Integral results are
mixed mode results, and have no subtype associated with them.

Note

The computation for the J-Integral result includes the effect of body forces.

For more information about Fracture Results, see:


Fracture Tool
Defining a Fracture Result

The Active Contour in the Details view indicates the contour number for which the results are shown
under the Results parameter. The Graphics window displays the graphical result for the active contour.
The “1” in the Graphics window indicates the start of the crack front, while “2” indicates the end of the
crack front.

The results are plotted in the Graph window for all contours, starting from the Contour Start value and
ending at the Contour End value. The X axis in the Graph window indicates the distance along the
crack front. The start of the crack front has a value of zero, and the end of the crack front has the
maximum value. The Tabular Data window displays the data points in a table format.

Release 2020 R1 - © ANSYS, Inc.


1262
Structural Results

Fracture Tool
The Fracture Tool allows you to group together all of the different types of fracture results associated
with one single Semi-Elliptical Crack or Arbitrary Crack or Pre-Meshed Crack object defined in the
Fracture folder.

To define a Fracture Tool:

1. Select the Solution object in the Tree Outline.

2. Choose Tools>Fracture Tool from the Solution context toolbar.

Note

By default, a Fracture Result of type Mode I Stress Intensity Factor is inserted under the
Fracture Tool.

3. In the Details View, for the Crack Selection option, select the Semi-Elliptical Crack, Arbitrary Crack,
or Pre-Meshed Crack object for which you want to group results.

Release 2020 R1 - © ANSYS, Inc.


1263
Using Results

Defining a Fracture Result


To define a Fracture Result:

1. Select the Fracture Tool from the Tree Outline.

2. From the Fracture Tool context toolbar, select any results you want to add.

• SIFS Results>SIFS(K1) inserts a Mode 1 Stress Intensity Factor result.

• SIFS Results>SIFS(K2) inserts Mode 2 Stress Intensity Factor result.

• SIFS Results>SIFS(K3) inserts Mode 3 Stress Intensity Factor result.

• J-Integral (JINT) inserts a J-Integral result.

• VCCT Results>VCCT(G1) inserts Mode 1 Energy Release Rate result.

• VCCT Results>VCCT(G2) inserts Mode 2 Energy Release Rate result.

• VCCT Results>VCCT(G3) inserts Mode 3 Energy Release Rate result.

• VCCT Results>VCCT(GT) inserts Total Energy Release Rate result.

• Material Force>Material Force (X Axis) inserts Total Material Force result in the X Axis of the local
crack front node coordinates.

• Material Force>Material Force (Y Axis) inserts Total Material Force result in the Y Axis of the local
crack front node coordinates.

• Material Force>Material Force (Z Axis) inserts Total Material Force result in the Z Axis of the local
crack front node coordinates.

• T-Stress inserts T-Stress result.

• C*-Integral inserts C*-Integral result.

Tip

In the Details View, you can change the type of fracture result to SIFS, J-Integral(JINT)
VCCT, Material Force, T-Stress, or C*-Integral, change the SIFS result subtype to K1, K2
and K3, change the VCCT result subtype to G1, G2, G3 and GT, and change the Material
Force subtype to X-axis, Y-axis and Z-axis.

Note

The C*-Integral result is only valid when a creep material is used and the Creep Controls
are turned on.

3. Define each Fracture Result in the Details view. Options specific to fracture results include:

Release 2020 R1 - © ANSYS, Inc.


1264
Structural Results

• Contour Start: Specifies the first contour number for which the result will be plotted in the graph and
displayed in the tabular data. The value must not be greater than the value of Contour End. This option
is applicable to SIFS, JINT, Material Force, T-Stress and C*-Integral types of fracture result.

• Contour End: Specifies the last contour number for which the result will be plotted in the graph and
displayed in the tabular data. The value must not be greater than value of the Solution Contours option
specified for the associated crack object. Since the maximum of 10 contours can be plotted in Graph
window at one point of time, the difference between Contour End and Contour Start must not be
greater than 9. This option is applicable to SIFS, JINT, Material Force, T-Stress and C*-Integral types of
fracture result.

• Active Contour: Specifies the contour number for which the results are plotted in the Graphics window
and are shown in the Details view. By default, it takes the "Last" value which is the contour number
specified for Contour End. This option is applicable to SIFS, JINT, Material Force, T-Stress and C*-Integral
types of fracture result.

For information on other Details view options, see Results and Result Tools (Group) (p. 1804).

Composite Failure Tool


The Composite Failure Tool is a post-processing option that you can use for composite ply structures
that were modeled using ANSYS Composite PrepPost (ACP).

Important

• The application supports the Composite Failure Tool on the same operating systems as ANSYS
Composite PrepPost. See the Supported Platforms section of the ANSYS Composite PrepPost User's
Guide for specific platform information.

• For a Static Structural system linked to a ACP-Pre system, created prior to 18.2, Mechanical does
not support the Composite Failure Tool. You can resolve this issue by cleaning and updating
the ACP-Pre system and then refreshing the inputs of the Static Structural system.

This section addresses the following topics:

• Tool Overview (p. 1265)

• Result Types (p. 1266)

• Composite Failure Tool Promotion (p. 1267)

• Application (p. 1268)

Tool Overview
This tool provides result data that corresponds to that of the failure definition in ACP Post. In addition,
and as illustrated below, the Details view properties for the object provide a set of failure criteria and
functionality. You enable these failure criteria using the properties of the Reinforced Ply Criteria category
(see Composite Failure Tool Result Objects (p. 1658)). The Worksheet provides additional details for each
criteria enabling you to make further specifications.

Release 2020 R1 - © ANSYS, Inc.


1265
Using Results

The properties of the Composite Failure Tool enable you to configure your own combined failure cri-
teria for the strength assessment of composites. Both established and basic as well as recent and ad-
vanced failure criteria are included in the program and you can combine them with the goal to incor-
porate all relevant failure modes which turn up in a composite structure. This helps to design robust
structures and to work efficiently. A discussion related to the best practices for using this tool is available
in the Guide to Composite Failure Criteria topic in the ANSYS Composite PrepPost User's Guide.

Result Types
The Composite Failure Tool supports the following result objects:

Safety Factor (SF)


This result type is an indication of the margin to failure. That is, the applied load multiplied by the
safety factor determines the failure load. Failure is experienced when you have a Safety Factor less
than 1.

SF x F applied = F f

Safety Factor values that are greater than one indicate a positive margin to failure and values
less than one indicate a negative margin. Safety Factor values are always greater than zero.

Inverse Reserve Factor (IRF)


This result type is an inverse margin to the Safety Factor. The failure load can be defined as the load
value divided by IRF. Failure is experienced when you have an Inverse Reserve Factor greater than 1.

IRF = 1/SF

Release 2020 R1 - © ANSYS, Inc.


1266
Structural Results

The critical values of reserve factors lie between zero and one, whereas the non-critical values
range from one to infinity. Whether the results are shown in numeric form or as contour plots,
the non-critical values tend to be emphasized in comparison to critical values.

Safety Margin
The Safety Margin result is obtained from the safety factor. Failure is experienced when you have a
Safety Margin less than 1.

SM = SF - 1

A positive safety margin indicates the relative amount that the applied load can be increased
before reaching failure load. Correspondingly, a negative safety margin indicates how much
the applied load should be decreased. Safety margins are typically expressed as percentages.

User-Defined Results
See the User-Defined Results (p. 1340) section of the Mechanical Help.

Also see the Composite Failure Tool (Group) (p. 1656) object reference page for additional information
about these result types.

Composite Failure Tool Promotion


Through the promotion feature, as illustrated below, you can promote a defined Composite Failure
Tool to the Composite Failure Criteria Definitions (p. 1655) object. By default, the promoted object
maintains the name of the original object, such as the default tool name, "Composite Failure Tool."

After promotion, the properties of the corresponding Composite Failure Tool object become read only,
except for the Defined By property.

Release 2020 R1 - © ANSYS, Inc.


1267
Using Results

The purpose of this feature is to enable you to create and share one or more combinations of failure
criteria by using them in various tools or across analyses.

Application
To define results using the Composite Failure Tool:

1. Make sure that your composite analysis is properly defined.

2. Highlight the Solution object and select Tools>Composite Failure Tool from the Solution context
toolbar or highlight the Solution object, right-click, and then select Insert>Composite Failure Tool. The
Composite Failure Tool becomes the active object in the tree, it contains an Inverse Reserve Factor
result object by default, and the Worksheet displays.

3. Specify the Defined By property as Direct Input (default) or Composite Failure Criteria Definitions. In
order to select Composite Failure Criteria Definitions, you must first specify failure criteria in the Rein-
forced Ply Criteria category and promote the Composite Failure Tool. This creates the required criteria
object and you must specify in the Composite Failure Criteria property that becomes available when
you select the Composite Failure Criteria Definitions option. Review the above Composite Failure Tool
Promotion topic as needed.

4. Specify failure criteria by turning the properties of the Reinforced Ply Criteria category of the Details
view On or Off. The Worksheet aromatically displays and populates with the criteria that you have specified.
You can further customize the criteria using the check boxes available in the Worksheet. In addition, further
failure criteria changes can be made in the Worksheet, specifically, Weighting values.

5. Insert results objects as desired (Inverse Reserve Factor, Safety Factor, and Safety Margin) from the
Composite Failure Tool toolbar or using the right-click context menu.

6. For individual result objects, specify elemental max or ply-wise results using the options of the Sub Scope
By property, Entire Section (default) or Ply. Based on your selection, either Ply Maximum or Elemental
Maximum displays in the Display Option property.

7. The properties Show Critical Failure Mode, Show Critical Layer, and Threshold for Text Visualization
are used to configure the overlaid text plot as shown below. The acronyms indicate the failure mode and
the indices the critical layer where failure occurs. The text labels are not shown if they are below the
defined threshold which is, by default, 0.25. If working with very large models, it is suggested that you
set a meaningful threshold so that thousands of text labels do not display. This makes it easier to examine
the structure and improves the performance.

8. Composite Failure Tool promotion may occur as desired.

Contact Tool
The Contact Tool allows you to examine contact conditions on an assembly both before loading, and
as part of the final solution to verify the transfer of loads (forces and moments) across the various
contact regions. The Contact Tool is an object you can insert under a Connections (p. 1663) branch object
for examining initial contact conditions, or under a Solution (p. 1817) or Solution Combination (p. 1820)
branch object for examining the effects of contact as part of the solution. The Contact Tool allows you
to conveniently scope contact results (p. 1243) to a common selection of geometry or contact regions.
In this way, all applicable contact results can be investigated at once for a given scoping.

A Contact Tool is scoped to a given topology, and there exist two methods for achieving this: the
Worksheet method and the Geometry Selection method. Under the Worksheet method, the Contact

Release 2020 R1 - © ANSYS, Inc.


1268
Structural Results

Tool is scoped to one or more contact regions. Under the Geometry Selection method, the Contact
Tool can be scoped to any geometry on the model. Regardless of the method, the scoping on the tool
is applied to all results grouped under it.

To use a Contact Tool, prepare a structural analysis for an assembly with contacts. You then use either
the Geometry Selection or Worksheet scoping method for results.

Evaluating Initial Contact Conditions

Note

To calculate initial contact results, the Contact Tool assumes small deflection. This assumption
impacts the resulting pinball radius of the scoped contacts if their Pinball Region property
is set to Program Controlled.

To evaluate initial contact conditions using the Worksheet method:

1. Insert a Contact Tool in the Connections folder (Contact Tool from the Connections context toolbar,
or right mouse button click Connections, then Insert> Contact Tool). You will see a Contact Tool inserted
that includes a default Initial Information object.

2. In the Details view of the Contact Tool, ensure that Worksheet (the default) is selected in the Scoping
Method field. The Worksheet appears. Scoped contact regions are those that are checked in the table.

3. You can modify your selection of contact regions in the Worksheet using the following procedures:

• To add or remove pre-selected groups of contact regions (All Contacts, Nonlinear Contacts, or Linear
Contacts), use the drop-down menu and the corresponding buttons.

• To add any number of contact regions, you can also drag-drop or copy-paste any number of contact
regions from the Connections folder into the Contact Tool in the Tree View. Also, one or more contact
regions can be deleted from the Contact Tool worksheet by selecting them in the table and pressing
the Delete key.

• To change the Contact Side of all contact regions, choose the option in the drop-down menu (Both,
Contact, or Target from the drop-down menu and click the Apply button).

• To change an individual Contact Side, click in the particular cell and choose Both, Contact, or Target
from the drop-down menu.

4. Add contact result objects of interest under the Contact Tool folder (Contact> Penetration or Gap or
Status from the Contact Tool context toolbar, or right mouse button click Contact Tool, then Insert>
Penetration or Gap or Status). The specific contact result objects are inserted.

5. Obtain the initial contact results using a right mouse button click the Contact object, or Contact Tool
object, or any object under the Contact Tool object, then choosing Generate Initial Contact Results
from the context menu. Results are displayed as follows:

• When you highlight the Initial Information object, a table appears in the Worksheet that includes
initial contact information (p. 1272) for the contact regions that you specified in step 2 above. You can
display or hide the various columns (p. 49) in the table. The table rows display in various colors that
indicate the detected contact conditions. A brief explanation of each color is provided in the legend

Release 2020 R1 - © ANSYS, Inc.


1269
Using Results

that is displayed beneath the table. Copies of the legend explanations are presented below in quotes,
followed by more detailed explanations.

– Red: "The contact status is open but the type of contact is meant to be closed. This applies to bonded
and no separation contact types."

Workbench has detected an open contact Status (p. 1243) condition, which is invalid based
on the definitions of Bonded and No Separation contact types (p. 701). It is very likely that
the model will not be held together as expected. The geometry of the contact may be too far
apart for the closed condition to be satisfied. Review of the Contact Region (p. 1669) definition
is strongly recommended.

– Yellow: "The contact status is open. This may be acceptable."

Workbench has detected an open contact Status (p. 1243) condition on a nonlinear contact
type, Frictionless, Rough, or Frictional, which is probably acceptable under certain conditions
as stated in their descriptions (p. 701).

If the Status is Far Open, the Penetration and the Gap will be set to zero even though the
Resulting Pinball (p. 716) is non-zero.

Note

Currently, contact results are not saved to results (.rst) file for all contact elements
that are outside the pinball region to optimize the file size. Results for far field
contact elements were reported as zero in prior releases.

– Orange: "The contact status is closed but has a large amount of gap or penetration. Check penetration
and gap compared to pinball and depth.”

Workbench has detected that any of the following contact results are greater than 1/2 of the
Resulting Pinball, or greater than 1/2 of the Contact Depth: Gap, Penetration, maximum
closed Gap, maximum closed Penetration. This could lead to poor results in terms of stiffness
of the contacting interface. It is recommended that you alter the geometry to reduce the gap
or penetration.

– Gray: "Contact is inactive. This can occur for MPC and Normal Lagrange formulations. It can also occur
for auto asymmetric behavior."

Refer to the individual descriptions for the MPC and Normal Lagrange formulations (p. 706),
and the description for Auto Asymmetric behavior (p. 703).

Note

The “not applicable” designation, N/A appears in the following locations and situations:

• All result columns when the contact pair is inactive (row is gray, or Inactive appears under
the Status column).

• The Geometric Gap column for Frictionless (p. 702), Rough (p. 702), or Frictional (p. 702)
contact Types (p. 701) and an Interface Treatment (p. 717) set to Add Offset (p. 718),
Ramped Effects.

Release 2020 R1 - © ANSYS, Inc.


1270
Structural Results

• When you highlight any of the contact result objects, the Geometry tab appears and displays the
graphical result for the contact regions that you specified in step 2 above.

To evaluate initial contact conditions using the Geometry Selection method:

1. Select one or more bodies that are in contact.

2. Insert a Contact Tool in the Connections folder (Contact Tool from the Connections context toolbar,
or right mouse button click Connections, then Insert> Contact Tool). You will see a Contact Tool inserted
that includes a default Initial Information object.

Note

The scoping of the Initial Information object is only available using the Worksheet
method. Selecting bodies as in step 1 above has no effect on Initial Information results.

3. In the Details view of the Contact Tool, select Geometry Selection in the Scoping Method field. The
bodies that you selected in step 1 are highlighted in the Geometry tab.

4. Add contact result objects of interest under the Contact Tool folder (Contact> Penetration or Gap or
Status from the Contact Tool context toolbar, or right mouse button click Contact Tool, then Insert>
Penetration or Gap or Status). The specific contact result objects are inserted.

5. Obtain the initial contact results using a right mouse button click the Contact object, or Contact Tool
object, or any object under the Contact Tool object, then choosing Generate Initial Contact Results
from the context menu. When you highlight any of the contact result objects, the Geometry tab appears
and displays the graphical result for the bodies that you selected in step 1.

Evaluating Contact Conditions After Solution

Note

The default method will be the last one that you manually chose in the Scoping Method
drop-down menu. If you have already selected geometry, the Scoping Method field auto-
matically changes to Geometry Selection. The default however will not change until you
manually change the Scoping Method entry.

To evaluate contact conditions after solution using the Worksheet method:

1. Insert a Contact Tool in the Solution folder (Tools> Contact Tool from the Solution context toolbar, or
right mouse button click Solution, then Insert> Contact Tool> Contact Tool). You will see a Contact
Tool inserted with a default contact result.

2. In the Details view, select Worksheet in the Scoping Method field. The Worksheet appears. Scoped
contact regions are those that are checked in the table.

3. You can modify your selection of contact regions in the Worksheet using the following procedures:

• To add or remove pre-selected groups of contact regions (All Contacts, Nonlinear Contacts, or Linear
Contacts), use the drop-down menu and the corresponding buttons.

Release 2020 R1 - © ANSYS, Inc.


1271
Using Results

• To add any number of contact regions, you can also drag-drop or copy-paste any number of contact
regions from the Contact folder into the Contact Tool in the Tree View. Also, one or more contact regions
can be deleted from the Contact Tool worksheet by selecting them in the table and pressing the Delete
key.

• To change the Contact Side of all contact regions, choose the option in the drop-down menu (Both,
Contact, or Target from the drop-down menu and click the Apply button).

• To change an individual Contact Side, click in the particular cell and choose Both, Contact, or Target
from the drop-down menu.

4. Add more contact results as needed in the Contact Tool folder (Contact> [Contact Result, for example,
Pressure] from the Contact Tool context toolbar, or right mouse button click Contact Tool, then Insert>
[Contact Result, for example, Pressure]).

5. Solve database. Upon completion, you will see contact results with the common scoping of the Contact
Tool.

To evaluate contact conditions after solution using the Geometry Selection method:

1. Select one or more bodies that are in contact.

2. Insert a Contact Tool in the Solution folder (Tools> Contact Tool from the Solution context toolbar, or
right mouse button click Solution, then Insert> Contact Tool> Contact Tool). You will see a Contact
Tool inserted with a default contact result. Because you have already selected one or more bodies, Geo-
metry Selection is automatically set in the Scoping Method field within the Details view.

3. Add more contact results as needed in the Contact Tool folder (Contact> [Contact Result, for example,
Pressure] from the Contact Tool context toolbar, or right mouse button click Contact Tool, then Insert>
[Contact Result, for example, Pressure]).

4. Solve database. Upon completion, you will see contact results with the common scoping of the Contact
Tool.

The configuration of the Contact Tool, in particular the location (Solution vs Solution Combination)
and the scoping method, affects the availability of results. A Contact Tool in the Solution Combination
folder has the limitation that it supports only pressure, frictional stress, penetration and distance.

Contact Tool Initial Information


When a Contact Tool is inserted under the Connections object, it includes a default object, Initial In-
formation. This object provides the following information from the Worksheet.

• Name: Contact Region name.

• Contact Side: Selected contact side, either Contact or Target.

• Type: contact type, Bonded, No Separation, Frictionless, Rough, Frictional.

• Status: the status of the contact, Open, Closed, Far Open.

• Number Contacting: the number of contact or target elements in contact.

• Penetration: the resulting penetration.

Release 2020 R1 - © ANSYS, Inc.


1272
Structural Results

• Gap: the resulting gap.

• Geometric Penetration: the penetration that initially exists between the Contact and Target surfaces.

• Geometric Gap: the gap that initially exists between the Contact and Target surfaces. For Frictional or
Frictionless contact, this is the minimum gap. For Bonded or No Separation contact, this is the maximum
closed gap detected.

• Resulting Pinball: user specified or the Mechanical APDL application calculated pinball radius.

• Contact Depth: average contact depth of elements.

• Normal Stiffness: the calculated maximum normal stiffness value.

• Tangential Stiffness: the calculated maximum tangential stiffness value.

• Real Constant: the contact Real Constant number.

The following table outlines how to interpret the Gap and Penetration columns in the Initial Contact
Information when there is a true initial geometric gap at the contact interface.

Contact Type Interface Offset Status Penetration Gap Geometric Geometric


Treatment Penetration Gap
True
Bonded or No
NA NA Closed 0 0 0 Geometric
Separation
Gap
Bonded or No Far
NA NA 0 0 0 0
Separation Open
Frictionless,
Add Offset, Far
Rough, or 0 0 0 0 0
No Ramping Open
Frictional
Frictionless, Add Offset,
Far
Rough, or Ramped 0 0 0 0 NA
Open
Frictional Effects
True
Frictionless, < True True
Add Offset, Near Geometric
Rough, or Geometric 0 0 Geometric
No Ramping Open Gap -
Frictional Gap Gap
Offset
True
Frictionless, Add Offset, < True
Near Geometric
Rough, or Ramped Geometric 0 0 NA
Open Gap -
Frictional Effects Gap
Offset
Offset -
Frictionless, > True True
Add Offset, True
Rough, or Geometric Closed 0 0 Geometric
No Ramping Geometric
Frictional Gap Gap
Gap
Offset -
Frictionless, Add Offset, > True
True
Rough, or Ramped Geometric Closed 0 0 NA
Geometric
Frictional Effects Gap
Gap

Release 2020 R1 - © ANSYS, Inc.


1273
Using Results

The following table outlines how to interpret the Gap and Penetration columns in the Initial Contact
Information when there is a true initial geometric penetration at the contact interface.

Contact Type Interface Offset Status Penetration Gap Geometric Geometric


Treatment Penetration Gap
True
Bonded or No
NA NA Closed 0 0 Geometric 0
Separation
Penetration
Bonded or No Far
NA NA 0 0 0 0
Separation Open
Offset +
Frictionless, Add Offset, | Offset | < True
True
Rough, or No Geometric Closed 0 Geometric 0
Geometric
Frictional Ramping Penetration Penetration
Penetration
Offset +
Frictionless, Add Offset, | Offset | < True
True
Rough, or Ramped Geometric Closed 0 Geometric NA
Geometric
Frictional Effects Penetration Penetration
Penetration
| – Offset
Frictionless, Add Offset, | – Offset | > True
Near | - True
Rough, or No Geometric 0 Geometric 0
Open Geometric
Frictional Ramping Penetration Penetration
Penetration
| – Offset
Frictionless, Add Offset, | – Offset | > True
Near | - True
Rough, or Ramped Geometric 0 Geometric NA
Open Geometric
Frictional Effects Penetration Penetration
Penetration

Bolt Tool
When examining numerous bolt loads, use the Bolt Tool to obtain bolt-specific results.

Scoping
You scope the Bolt Tool to defined Bolt Pretension (p. 967) boundary conditions that you activate
using the Worksheet. Bolt Pretension boundary condition and Worksheet usage are the only supported
methods for specifying the data of a Bolt Tool. Therefore, all of the support and scoping requirements
of the Bolt Pretension boundary condition must be considered.

Result Types
Like the Bolt Probe, the Bolt Tool provides the following results:

• Adjustment: This represents the displacement that occurs from the pretension. In Mechanical APDL terms,
this is the displacement reported from the pretension node. This result is also available for reporting regardless
of how the bolt is defined.

• Working Load: This represents a constrained force reaction from the pretension load. In Mechanical APDL
terms, this is the constrained reaction reported from the pretension node. This is essentially the sum of all
the forces acting through the pretension cut. This result is applicable for load steps when the load is defined
by either Locked or Adjustment or Increment.

Release 2020 R1 - © ANSYS, Inc.


1274
Structural Results

Application
To define results using the Bolt Tool:

1. Make sure that all Bolt Pretension (p. 967) loads are properly defined.

2. Highlight the Solution object and select Tools > Bolt Tool from the Solution context toolbar (p. 84) or
highlight the Solution object, right-click, and then select Bolt Tool > Bolt Tool. The Bolt Tool becomes
the active object in the tree, it contains an Adjustment result object by default, and the Worksheet displays.

3. All existing Bolt Pretension loads populate the Worksheet. By default, all loads are applied, as shown by
the activated checkboxes for each table row. You can modify the table entries as needed.

Add Adjustment and Working Load results to the tool as required.

In addition, the following right-click menu options are available in the Worksheet:

• Scope To All Bolts

• Clear Scoping

• Activate all Selections

• Deactivate all Selections

Beam Tool
You can apply a Beam Tool to any assembly in order to view the linearized stresses on beam (line)
bodies. It is customary in beam design to employ components of axial stress that contribute to axial
loads and bending in each direction separately. Therefore, the stress outputs (which are linearized
stresses) associated with beam bodies have been focused toward that design goal.

Note

Note the following limitations for the Beam Tool:

• The Beam Tool does not support bending or combined stress results when scoped to a
geometry that includes a user-defined cross-section.

• The Beam Tool is not available to the Samcef or ABAQUS solver.

The Beam Tool is similar to the Contact Tool (p. 1268) in that the tool, not the results themselves control
the scoping. By default, the scoping is to all beam bodies. You can change the scoping in the Details
view, if desired.

To insert a Beam Tool, highlight the Solution object then choose Tools> Beam Tool from the Solution
context toolbar. Three beam stress results are included under the Beam Tool object: Direct Stress,
Minimum Combined Stress, and Maximum Combined Stress. You can add additional beam stress
results or deformation results (p. 1226) by highlighting the Beam Tool object and choosing the particular
result from the Beam Tool context toolbar. As an alternative, you can right mouse button click the
Beam Tool object and, from the context menu, choose Insert> Beam Tool> Stress or Deformation.

Presented below are definitions of the beam stress results that are available:

Release 2020 R1 - © ANSYS, Inc.


1275
Using Results

• Direct Stress: The stress component due to the axial load encountered in a beam element.

• Minimum Bending Stress: From any bending loads a bending moment in both the local Y and Z directions
will arise. This leads to the following four bending stresses: Y bending stress on top/bottom and Z bending
stress on top/bottom. Minimum Bending Stress is the minimum of these four bending stresses.

• Maximum Bending Stress: The maximum of the four bending stresses described under Minimum Bending
Stress.

• Minimum Combined Stress: The linear combination of the Direct Stress and the Minimum Bending
Stress.

• Maximum Combined Stress: The linear combination of the Direct Stress and the Maximum Bending
Stress.

Caution

Be cautious when adding Beam Tool results to the Solutions Combination (p. 1370) feature.
As stated above, Beam Tool minimum and maximum results can originate from one of four
different physical locations. As a result, the application could add solution results from different
physical locations together. For this reason, carefully review stress results used with the
Solutions Combination feature.

Beam Results
Beam results can be applied only to line body edges and are defined as follows in reference to the
solution coordinate system of each beam or pipe element:

• Axial Force: the force along a beam element axis (X component).

• Bending Moment: the moment in the plane perpendicular to the beam element axis (Y and Z components).

• Torsional Moment: the moment about the beam element axis (X component).

• Shear Force: the force perpendicular to the beam element axis (Y and Z components).

• Shear-Moment Diagram (p. 1277): simultaneously illustrates the distribution of shear forces, bending moments
and displacements, as a function of arc length along a path consisting of line bodies.

To apply a beam result, define a path by using edges, on the line body edges as described in “Defining
a Path using an Edge” in Path (p. 661). For Shear-Moment Diagrams, the defined line body edges must
be contiguous.

Beam results are not available to the Samcef or ABAQUS solver.

Note

• User Defined Result (p. 1340) equivalents of the above results are BEAM_AXIAL_F, BEAM_BEND-
ING_M, BEAM_TORSION_M, and BEAM_SHEAR_F.

• An Axial Force display will not include an arrow (that is, a vector). The force consists of only the
X component. A positive force denotes tension; a negative force denotes compression.

Release 2020 R1 - © ANSYS, Inc.


1276
Structural Results

• If a path is coincident with an edge, beam results from scoping to the path may not match beam
results from scoping to the edge. The path for beams only allows contributions from beam ele-
ments with both endpoints in the path. An edge can allow contributions from elements that
have only one node on the edge.

Shear-Moment Diagram
A shear-moment diagram is a beam result (p. 1276) that you can apply only to paths, which simultaneously
illustrates the distribution of shear forces, bending moments and displacements, as a function of arc
length along the path consisting of line bodies.

These three quantities are included in a shear-moment diagram because they are so closely related.
For example, the derivative of the moment is the shear:

dM/dx = V(x)

You can pre-define the path by selecting a contiguous set of line body edges, then inserting a Shear-
Moment Diagram object in the tree. Insert from the Beam Results drop-down menu on the Solution
context toolbar, or by a right-click the Solution folder and choosing Insert> Beam Results from the
context menu.

With the Shear-Moment Diagram object highlighted, the Path, Type and Graphics Display settings
in the Details view control the curves you can display in the Worksheet or the Graph window. Descrip-
tions are presented below. When the X, Y, or Z component is indicated, they are in the local coordinate
system whose X axis is directed instantaneously along the beam. The Y and Z axes can be inspected
using an Element Triad (p. 1166) result. All Type and Graphics Display directions are referenced to this
axis.

• Path: The specific path to which the shear-moment diagram is to apply. For ease of use, before inserting
the Shear-Moment Diagram object, you can define the path by selecting a contiguous set of line body
edges. You can choose to use this path or any other pre-defined paths (p. 661) that you have created for
other path results (p. 1168).

• Type: The shear-moment diagram to display. Choices are:

– Total Shear-Moment Diagram

– Directional Shear-Moment Diagram (VY-MZ-UY)

– Directional Shear-Moment Diagram (VZ-MZ-UZ)

• Graphics Display: Controls which quantity is plotted in the Graph window and reported as Minimum and
Maximum values in the Details view.

Example in Worksheet:

Release 2020 R1 - © ANSYS, Inc.


1277
Using Results

You can toggle the display of all the Max and Min annotation labels by right-clicking anywhere in the
top diagram and choosing Hide/Show Annotation Labels.

Example in Graph and Tabular Data Windows:

Example of Tracking Graph with Path Position:

When you click anywhere along the Length axis, the vertical bar and length that display corresponds
to the position of the + annotation on the path as shown below.

Release 2020 R1 - © ANSYS, Inc.


1278
Structural Results

Structural Probes
The following structural probe types are available.

Probe Type Applicable Analysis Types Output C


Deformation Static Structural, Transient Structural, Rigid Deformation: X axis, Y axis, Z axis, Total S
Dynamics, Explicit Dynamics f
r

S
b
(
o
l
o
e

O
c

Release 2020 R1 - © ANSYS, Inc.


1279
Using Results

Probe Type Applicable Analysis Types Output C


s
a
t
C
Strain Static Structural, Transient Structural, Explicit Strain: Components, Principals, Normal X, Normal S
Dynamics Y, Normal Z, XY Shear, YZ Shear, XZ Shear, f
Minimum Principal, Middle Principal, Maximum o
Principal, Intensity, Equivalent (von-Mises)
S
b
l
o
e

O
c
s
a
t
C
Stress Static Structural, Transient Structural, Explicit Stress: Components, Principals, Normal X, Normal S
Dynamics Y, Normal Z, XY Shear, YZ Shear, XZ Shear, f
Minimum Principal, Middle Principal, Maximum o
Principal, Intensity, Equivalent (von-Mises)
S
b
l
o
e

O
c
s
a
t
C
Position (p. 1288) Static Structural, Transient Structural, Rigid Result Selection: X axis, Y axis, Z axis S
Dynamics, Explicit Dynamics r
o

S
b
c
s

O
c
s
a
t
C

Release 2020 R1 - © ANSYS, Inc.


1280
Structural Results

Probe Type Applicable Analysis Types Output C


Velocity Transient Structural, Rigid Dynamics, Explicit Velocity: X axis, Y axis, Z axis S
Dynamics f
r

S
b
(
o
c
s
b
l
o
e

O
c
s
a
t
C
Angular Velocity Transient Structural, Rigid Dynamics, Angular Velocity: X axis, Y axis, Z axis S
r
o

S
b

O
c
s
a
t
C
Acceleration Transient Structural, Rigid Dynamics, Explicit Acceleration: X axis, Y axis, Z axis S
Dynamics f
r

S
b
(
o
c
s
b
l
o
e

O
c

Release 2020 R1 - © ANSYS, Inc.


1281
Using Results

Probe Type Applicable Analysis Types Output C


s
a
t
C
Angular Transient Structural, Rigid Dynamics Angular Acceleration: X axis, Y axis, Z axis S
Acceleration r
o

S
b

O
c
s
a
t
C
Energy (p. 1289) Static Structural, Transient Structural, Rigid For Static Structural and Transient Structural S
Dynamics analyses: Kinetic, Strain. f
r
For Rigid Dynamics analyses: Kinetic,
Potential, External, Total S

Release 2020 R1 - © ANSYS, Inc.


1282
Structural Results

Probe Type Applicable Analysis Types Output C


Flexible Static Structural and Transient Structural Rotation of X, Y, and Z axes S
Rotation U
Probe R
P
B

S
U
R
P
B
Force Static Structural, Transient Structural, Modal, Force Reaction: X axis, Y axis, Z axis S
Reaction (p. 1290) Harmonic, Random Vibration, Response f
1
(p. 1287) Spectrum o
c
s
s
p
b
s
S
t
t
o

S
B
C
C
R
R
P
(
B
(
S
(
M
C
a
7

O
c
s
C
d
G
C
S

Release 2020 R1 - © ANSYS, Inc.


1283
Using Results

Probe Type Applicable Analysis Types Output C


C
S
(
o
o
R
V
a
R
S
Moment Static Structural, Transient Structural, Modal, Moment Reaction: X axis, Y axis, Z axis S
Reaction (p. 1290) Harmonic, Random Vibration, Response f
1
(p. 1287) Spectrum o
c
s
s
p
b
s
S
t
t
o

S
B
C
C
R
R
P
(
B
(
M
C
a
7

O
c
s
C
d
G
C
S
C
S
(

Release 2020 R1 - © ANSYS, Inc.


1284
Structural Results

Probe Type Applicable Analysis Types Output C


o
o
R
V
a
R
S

S
p
c
o
c
s
Joint (p. 1298) Static Structural, Transient Structural, Rigid See Joint Probes (p. 1298) S
Dynamics j

O
c
s
O
M
p
a
P
d
t
r
s
J
R
S
o
s
o
O
C
c
s
v
J

S
p
a
j
M
Response Random Vibration X axis, Y axis, and Z axis. S
2
PSD (p. 1300) f
(p. 1287) Displacement, Stress, Strain, Acceleration, o
Velocity

Release 2020 R1 - © ANSYS, Inc.


1285
Using Results

Probe Type Applicable Analysis Types Output C


S
l
o
v

O
C
S
S
C
S
(
o
o
R
V
Spring (p. 1301) Static Structural, Transient Structural, Elastic Force 3 (p. 1287), Damping Force 4
(p. 1287),S
Modal, Harmonic Response, Random Elongation, Velocity 5 (p. 1287) s
Vibration, Response Spectrum, Rigid
Dynamics O
c
s
s
o
Bearing (p. 831) Static Structural, Transient Structural, Modal, Elastic Force 1, Elastic Force 2, Damping Force 1, S
Harmonic Response, Random Vibration, Damping Force 2, Elongation 1, Elongation 2, b
Response Spectrum Velocity 1, Velocity 2 o

O
c
s
b
o
Beam (p. 1303) Static Structural, Transient Structural Axial Force, Torque, Shear Force at I, Shear Force B
at J, Moment at I, and Moment at J C
S
Bolt Static Structural, Transient Structural, Random Adjustment (Static and Transient Structural), S
Pretension (p. 1303)Vibration, Response Spectrum Tensile Force b
c
p
b
c

O
c
s
a
p
d
o

Release 2020 R1 - © ANSYS, Inc.


1286
Structural Results

Probe Type Applicable Analysis Types Output C


Generalized 2D: Static Structural, Transient Structural Rotation: X, Y; Moment: X, Y; Fiber Length Change; O
Plane Force c
Strain (p. 1303) s
a
t
C

1: The Force and Moment Reactions for Mesh Connections are not supported for Modal and Harmonic
Response analyses.

2: The Response PSD Probe (p. 1300) provides an excitation response plot across the frequency domain
of an input PSD load. It also evaluates the root mean square (RMS) and expected frequency of a response
PSD. It is assumed that the excitations are stationary random processes from the input PSD values.

3: Random Vibration and Response Spectrum analyses support the Elastic Force result only.

4: The Damping Force result is calculated for Transient Structural analysis only when damping is defined.

5: Velocity result is calculated only for Static Structural and Transient Structural analyses.

6: Remote Points must be constrained and Beams and Springs must be grounded.

7: The application displays a Geometry property if you select Surface (p. 666) as the Location Method.
To specify a Surface for the scoping of the probe, the application requires you to also manually specify
the body or bodies (via the Geometry property) to be sliced. You then specify the Extraction property
as either Mesh From Positive Side or Mesh From Negative Side. The probe only examines the elements
cut by the plane (and only nodes on those elements which are on the selected side of the plane).

Note

Surfaces used in reaction probes do not currently intersect all geometries, such as line
bodies, joints, springs, and MPC contact.

Note

• Refer to the Probe Details View (p. 1179) section for additional information about the above scoping
options.

• For a linked Mode-Superposition Harmonic Response analysis, the Expand Results From property
(see Output Controls (p. 904)) in the Harmonic Response analysis needs to be set to Harmonic
Solution in order to support the Elongation result.

• For a linked Mode-Superposition Transient Structural analysis, the Expand Results From property
(see Output Controls (p. 904)) in the Transient Structural analysis needs to be set to Transient
Solution in order to support the Elongation result and, if damping is defined, the Damping Force
result.

Release 2020 R1 - © ANSYS, Inc.


1287
Using Results

Differences in Probes Applied to Rigid Bodies


The following table describes the differences between probes applied to rigid bodies in an Explicit Dy-
namics analysis, compared to probes applied to rigid bodies in a Static Structural or Transient Structural
analysis.

Characteristic Explicit Dynamics Analysis Static Structural or Transient


Structural Analysis
How rigid part is Meshed with solid element containing Meshed as a single element
meshed multiple nodes. containing a single node.
Centroid of the rigid Need not be represented by any node Results at the single node represent
part in the mesh. The Mechanical application the displacement, velocity, etc. at
computes the part centroid by the centroid of the part.
averaging the element centroids. Each
element centroid is the average of the
element's nodes.
Display of minimum and Probe applied to rigid body Probe applied to rigid body does not
maximum results displays both the minimum and display both the minimum and
maximum results at a given time maximum results at a given time
because there are multiple because there is only one element
elements and nodes reporting and one node reporting results.
results.

The position probe represents the


sum of the minimum (or
maximum) displacement with the
average nodal coordinate.

More Information on Probes


See the Probes (p. 1175) section for further information. In addition, see the following sections for details
on these probe types:
Position
Energy (Transient Structural and Rigid Dynamics Analyses)
Reactions: Forces and Moments
Joint Probes
Response PSD Probe
Spring Probes
Bearing Probes
Beam Probes
Bolt Pretension Probes
Generalized Plain Strain Probes

Position
The Position probe must be scoped to a rigid body and supports Static Structural, Transient Structural,
Rigid Dynamics, and Explicit Dynamics analyses.

This probe extracts the positions of the scoped geometric entity during time for a specified axis, or all
axes.

Release 2020 R1 - © ANSYS, Inc.


1288
Structural Results

As shown in the following animation, the graphical display for the Position probe includes a curve that
connects all 3D positions from result values (as contained in Tabular Data). The trace of the results is
based on the scoped entity over time. When animated, the evolution is shown from an empty curve
(at the beginning) to a full trajectory at the end of simulation time. A small red ball marks the current
position along the curve.

Energy (Transient Structural and Rigid Dynamics Analyses)


A Transient Structural analysis supports the following energy outputs:

Strain Energy: Energy stored in bodies due to deformation. This value is computed from stress and
strain results. It includes plastic strain energy as a result of material plasticity.
Kinetic Energy: Kinetic energy due to the motion of parts in a transient analysis.

A Rigid Dynamics analysis supports the following energy outputs:

Kinetic Energy: Kinetic energy due to the motion of parts in a transient analysis is calculated
as ½ *mass* velocity2 for translations and ½ *omegaT*Inertia*omega for rotations.
Potential Energy: This energy is the sum of the potential energy due to gravity and the elastic
energy stored in springs. The potential energy due to gravity is proportional to the height of
the body with respect to a reference ground. The reference used in a Rigid Dynamics analysis
is the origin of the global coordinate system. Because of this, it is possible to have a negative
potential energy (and negative total energy) depending on your model coordinates. The
elastic energy includes only energy due to deformation of spring(s) in a rigid body dynamic
analysis and is calculated as ½ * Stiffness * elongation 2.
External Energy: This is all the energy the loads and joints bring to a system.
Total Energy: This is the sum of potential, kinetic and external energies in a Rigid Dynamics
analysis.

Note

Energy results are not available for Rigid Dynamics analysis on a body per-body basis.
An energy probe scoped on a body will return the energy of the whole part to which
body belongs.

Release 2020 R1 - © ANSYS, Inc.


1289
Using Results

Reactions: Forces and Moments


You can obtain reaction forces and moments using Force Reaction probes or Moment Reaction probes.
At the solver level, the output of reaction forces and moments is controlled via the Mechanical APDL
OUTRES command. Support types marked RSOL are governed by the RSOL option, which refers to
nodal constraint reactions. Those marked NLOAD and MISC are governed by the NLOAD and MISC options,
which refer to the elemental nodal loads and elemental miscellaneous data, respectively. In addition,
some analysis and support types require you turn them on in the Output Controls. If no setting is
specified for a reaction type, the output occurs automatically.

When you request a Force Reaction or a Moment Reaction in a Cartesian coordinate system at a
specific time point by setting Display to Single Time Point in the Details view for Static Structural and
Transient Structural Analysis, the Force Reaction or Moment Reaction is displayed by an arrow in the
Geometry window. Force Reaction uses a single arrowhead and Moment Reaction uses double arrow-
head. The arrows are drawn on the deformed mesh.

Similarly, when the force or moment reaction results are requested based on Frequency or Set Number
and Phase Angle for Harmonic analysis or Mode Number for Modal analysis, the base of the arrow of
the moment probe is placed at the Summation Point (or "centroid"; the simple calculated average;
unweighted by length, area, or volume). However, a Moment Reaction probe whose Location Method
is a remote point will place the base of the arrow at the location of the remote point. In this case, there
is no detail for Summation Point, and Mechanical does not employ a moment arm calculation. The
moments are precisely the nodal moments for the remote point in the result file (as printed by the
PRRSOL command in Mechanical APDL).

For those Moment probes which perform a moment arm calculation, Mechanical employs the undisplaced
mesh. In other words, when Mechanical computes a moment arm for a node, it finds the difference
between the (x,y,z) of the node and the summation point (sx,sy,sz) in the base mesh:

moment_arm = (x,y,z) - (sx,sy,sz)

Note that the above formula differs from how Mechanical APDL performs a moment arm calculation
and therefore, the results between the two applications differ. Mechanical APDL uses the FSUM command
for large scale deformation analyses (NLGEOM,ON). In Mechanical APDL, node-based displacements,
where the NLGEOM,ON command is issued, are added to the (x,y,z) in the base mesh, such that:

moment_arm = (x+ux,y+uy,z+uz) - (sx,sy,sz)

The following topics discuss each type of reaction, the option that controls the output, and any required
setting in the Output Controls. In addition, at the end of the section there is a listing of Support Re-
quirements and Limitations (p. 1296). Make sure you review this content.

Fixed Boundary Conditions


For fixed boundary conditions, including:

• Face, Edge, and Vertex Rotations (do not include Force reactions)

• Displacements for Faces, Edges, and Vertices

• Cylindrical Support

• Frictionless face

Release 2020 R1 - © ANSYS, Inc.


1290
Structural Results

• Simply Supported Edge and Vertex

• Finite Element (FE) Connection Boundary Conditions (Nodal Displacement and Nodal Rotation)

Reaction Output Controlled By


Type
Static The output of these options are controlled by the RSOL option of the
Transient - OUTRES command.
Full
Modal The output of these options are controlled by the RSOL option of the
Harmonic OUTRES command.
Response -
To enable the output, set Calculate Reactions = Yes in the Output Controls.
Full
Harmonic If results are expanded from a modal solution, then the output of these
Response - options are controlled by both the RSOL and NLOAD options of the OUTRES
Mode-Superpositioncommand. You must set both Calculate Reactions and Nodal Forces to
Transient - either Yes or Constrained Nodes in the Output Controls.
Mode-Superposition
Note

Constrained Nodes is the preferred option, as the results


file size will be smaller and the process time shorter.

Otherwise, the output of these options are controlled by the RSOL option
of the OUTRES command. Set Calculate Reactions = Yes in the Output
Controls.
Response In the upstream Modal analysis, under the Analysis Settings Output Controls
Spectrum (p. 904), you must set the Nodal Forces property to either Yes or Constrained
Random Nodes and set the Store Modal Results property to Program Controlled
Vibration or For Future Analysis.

Note

The Constrained Nodes setting is the preferred setting


because the results file size will be smaller and the processing
time shorter.

Remote Displacement

Reaction
Output Controlled By
Type
Static
The output of these options are controlled by the RSOL option of the
Transient - OUTRES command.
Full
Modal The output of these options are controlled by the RSOL option of the
OUTRES command.

Release 2020 R1 - © ANSYS, Inc.


1291
Using Results

Reaction
Output Controlled By
Type
Harmonic
Response -
Full
Response
To enable the output, set Calculate Reactions = Yes in the Output Controls.
Spectrum
Random
Vibration
PSD
Harmonic If results are expanded from a modal solution, then the output of these
Response - options are controlled by both the RSOL and NLOAD options of the OUTRES
Mode-Superpositioncommand. You must set both Calculate Reactions and Nodal Forces to
either Yes or Constrained Nodes in the Output Controls.

Note

Transient - Constrained Nodes is the preferred option, as the results


Mode-Superposition file size will be smaller and the process time shorter.

Otherwise, the output of these options are controlled by the RSOL option
of the OUTRES command. Set Calculate Reactions = Yes in the Output
Controls.

Compression Only Support

Reaction
Output Controlled By
Type
Static The output of these options are controlled by the RSOL option of the
Transient - OUTRES command. Reaction probes scoped to a Compression Only boundary
Full condition cannot display results if the solver did not converge.

Elastic Support

Reaction
Output Controlled By
Type
Static The output of these options are controlled by the NLOAD option of the
OUTRES command.
Transient -
Full To enable the output, set Nodal Forces = Yes in the Output Controls.

Imported Displacement

Reaction
Output Controlled By
Type
Static
The output of these options are controlled by the RSOL option of the
Transient - OUTRES command.
Full

Release 2020 R1 - © ANSYS, Inc.


1292
Structural Results

Weak Springs

Reaction
Output Controlled By
Type
Static
The output of these options are controlled by the RSOL option of the
Transient - OUTRES command.
Full

Grounded Beam

Reaction
Output Controlled By
Type
Static
The output of these options are controlled by the RSOL option of the
Transient OUTRES command.
Full
Modal The output of these options are controlled by the RSOL option of the
Harmonic OUTRES command.
Response -
Full To enable the output, set Calculate Reactions = Yes in the Output Controls.
Harmonic If results are expanded from a modal solution, then the output of these
Response - options are controlled by both the RSOL and NLOAD options of the OUTRES
Mode-Superpositioncommand. You must set both Calculate Reactions and Nodal Forces to
either Yes or Constrained Nodes in the Output Controls.

Note

Transient - Constrained Nodes is the preferred option, as the results


Mode-Superposition file size will be smaller and the process time shorter.

Otherwise, the output of these options are controlled by the RSOL option
of the OUTRES command. Set Calculate Reactions = Yes in the Output
Controls.

Contact

Reaction
Output Controlled By
Type
Static The underlying element options are controlled by the NLOAD option of the
OUTRES command. To enable the output, set Nodal Forces = Yes in the
Output Controls.
Transient -
Full The contact element options are governed by the MISC option of the
OUTRES command. To enable the output, set Contact Miscellaneous = Yes
in the Output Controls.
Modal These analysis types do not support contact reactions using the contact
Standalone element option. They only support contact reactions using the underlying
Harmonic element option.

Release 2020 R1 - © ANSYS, Inc.


1293
Using Results

Reaction
Output Controlled By
Type
Response -
Full
Standalone
Harmonic
Response -
Mode-Superposition
Harmonic You control the underlying element options using the NLOAD option of the
Response OUTRES command. To enable the output, set the Nodal Forces property
Analysis to Yes in the Output Controls category.
Linked to
Modal
Analysis
Transient -
Linked to
Modal
Analysis

Remote Point

Reaction
Output Controlled By
Type
Static
The output of these options are controlled by the RSOL option of the
Transient - OUTRES command.
Full
Modal The output of these options are controlled by the RSOL option of the
Harmonic OUTRES command.
Response -
Full To enable the output, set Calculate Reactions = Yes in the Output Controls.
Harmonic If results are expanded from a modal solution, then the output of these
Response - options are controlled by both the RSOL and NLOAD options of the OUTRES
Mode-Superpositioncommand. You must set both Calculate Reactions and Nodal Forces to
either Yes or Constrained Nodes in the Output Controls.

Note

Transient - Constrained Nodes is the preferred option, as the results


Mode-Superposition file size will be smaller and the process time shorter.

Otherwise, the output of these options are controlled by the RSOL option
of the OUTRES command. Set Calculate Reactions = Yes in the Output
Controls.

Release 2020 R1 - © ANSYS, Inc.


1294
Structural Results

Grounded Spring

Reaction Type Output Controlled By


Static The output of these options are controlled by the RSOL option of
Transient - Full the OUTRES command.
Modal The output of these options are controlled by the RSOL option of
the OUTRES command.
Harmonic Response
- Full To enable the output, set Calculate Reactions = Yes in the Output
Controls.
Harmonic Response If results are expanded from a modal solution, then the output of
- these options are controlled by both the RSOL and NLOAD options
Mode-Superposition of the OUTRES command. You must set both Calculate Reactions
and Nodal Forces to either Yes or Constrained Nodes in the Out-
put Controls.

Note

Transient - Constrained Nodes is the preferred option, as the


Mode-Superposition results file size will be smaller and the process time
shorter.

Otherwise, the output of these options are controlled by the RSOL


option of the OUTRES command. Set Calculate Reactions = Yes
in the Output Controls.
Random Vibration To enable the output, set Calculate Reactions = Yes in the Output
Response Spectrum Controls of the upstream Modal analysis.

Mesh Connection

Reaction
Output Controlled By
Type
Static
Transient - The output of these options are controlled by the NLOAD option of the
Full OUTRES command.
Modal
To enable the output, set Nodal Forces = Yes in the Output Controls.
Transient -
Mode-Superposition

Geometry

Reaction
Output Controlled By
Type
Static The underlying element options are controlled by the NLOAD option of the
OUTRES command.

Release 2020 R1 - © ANSYS, Inc.


1295
Using Results

Reaction
Output Controlled By
Type
To enable the output, set Nodal Forces = Yes in the Output Controls.

Transient - Note
Full
Mechanical supports geometry scoping for vertices, edges,
and faces only.

Note

A limitation exists when the scoping of a Force Reaction or Moment Reaction probe is
applied to a geometry entity (Location Method = Geometry Selection) that shares
more than one body. The (unscoped) elements that are adjacent to the scoped body
contribute to the probe's results.

Surface

Reaction
Output Controlled By
Type
Static
The output of these options are controlled by the NLOAD option of the
Transient -
OUTRES command.
Full
Transient - To enable the output, set Nodal Forces = Yes in the Output Controls.
Mode-Superposition

Support Requirements and Limitations


• Force Reaction probes support Cartesian or cylindrical coordinate systems. Moment Reaction probes
support Cartesian coordinate systems only.

• A Moment Reaction probe cannot be scoped to a Grounded Spring.

• For the Moment Reaction probe, the Summation property is available for most Location Method property
selections and enables you to select Centroid or Orientation System for your scoped entity. If your selected
Location Method does not display this property, the application automatically uses the centroid of the
scoped entity for the moment calculation.

• A reported reaction may be inappropriate if that support shares a face, edge, or vertex with another support,
contact pair, or load. This is because the underlying finite element model will have both loads and supports
applied to the same nodes.

If a model contains two or more supports that share an edge or vertex, use caution in evaluating the
listed reaction forces at those supports. Calculation of reaction forces includes the force acting along
bounding edges and vertices. When supports share edges or vertices the global summation of forces
may not appear to balance. Reaction forces may be incorrect if they share an edge or face with a
contact region.

Release 2020 R1 - © ANSYS, Inc.


1296
Structural Results

• For a Moment Reaction scoped to a contact region, the location of the summation point may not be exactly
on the contact region itself.

• If you set Extraction equal to Contact (Underlying Element) or Target (Underlying Element) in the Details
view of either a Force Reaction or Moment Reaction probe, the reaction calculations work by summing
the internal forces on the underlying elements under a contact region. These probes can also extract reaction
data from surface effect elements. The application creates surface effect elements during the solution process
to simulate loads, such as pressures. However, the application does not currently display surface effect ele-
ments from the Mesh object or the Connections object.

Therefore, a reported reaction may be inappropriate on a contact face if that face shares topology
with another contact face/edge or external load (such as a force or fixed support), which would
contribute to the underlying elements' internal force balance. In addition, during a Transient analysis,
inertial and damping forces are also included. Another possible scenario could arise for MPC contact
of solid surfaces. In this case, if a gap is detected, the solver may build constraints on an additional
layer into the solid mesh from the TARGET elements. This produces a more accurate response but
will invalidate any reactions from the underlying solid elements of the TARGET elements. If symmetric
contact is chosen, be careful to verify which side becomes active for the TARGET elements so that
the correct reaction can be determined.

• When scoping Force Reaction or Moment Reaction probes to geometry, it is possible that there may be
elements (and as a result, element-based reactions) that are currently unavailable for summing purposes.
For example, you scope a pressure to a face on your geometry. The solution process also applies surface
effect elements to the same face to simulate the pressure loading. The probes, scoped to geometry, currently
cannot extract reaction data from the surface effect elements and therefore, in the case of this example,
only the underlying solid/shell/line elements of the original mesh contribute reaction data to the probe
results.

• For Modal analysis, reaction results in damped modal analysis provide a By field option in the result definition
to compute results based on Mode Number, Phase of Maximum, and Maximum Over Phase.

• For a Harmonic Response analysis, reaction results support all options of the result definition available for
other harmonic results, and are reported based on the nearest frequency results available; no interpolation
is done.

• In order to evaluate reactions successfully for a standalone Mode Superposition Harmonic Response analysis
that has the Clustering property set to On, you need to also make sure that either the Stress, Strain,
Nodal, or the General Miscellaneous properties in the Analysis Settings>Output Controls are also set
to Yes.

• Reaction results sweep through a phase period of 0o and 360o at a specified increment. In previous releases
of Mechanical (14.5 and earlier), the default value for this increment was 1 o in order to determine the Phase
of Maximum and the Maximum Over Phase values. For Harmonic Response analyses only, the phase incre-
ment can be controlled using the Phase Increment option. A Phase Increment entry can be between 1o
and 10o. The default Phase Increment value is 10o but for legacy database results it is 1o.

• For Random Vibration and Response Spectrum analysis, reaction results can only be scoped to a Remote
Displacement boundary condition. Animation of reaction results is not supported for modal and harmonic
analysis.

• Since Beam Connections are, by definition, three dimensional in nature, the reactions object scoped to
grounded beams may produce reactions in all three directions/axes for two-dimensional analysis. The Tab-

Release 2020 R1 - © ANSYS, Inc.


1297
Using Results

ular Data view will reflect the reactions in all three axes, while the Results view will only reflect values in two
axes. The total reactions will be calculated taking into account the reaction components in all three axes.

• For a force reaction scoped to a contact region, if you set Extraction = Contact (Contact Element), the re-
action calculations come directly from the contact elements themselves. This results in accurate force reactions
even when the contact region overlaps with other boundary conditions, such as other contact regions,
supports, etc. Characteristics of the Contact (Contact Element) setting are that MPC contact is not supported,
nor are reactions from the Target (Underlying Element) side. This feature should only be used with
Asymmetric contact and requires that Contact Miscellaneous be set to Yes in the Output Controls. A
limitation of the Contact (Contact Element) setting is when you use linear contact (that is, either Bonded
or No Separation contact types) with loads that are unrealistically very high or very low in magnitude. These
situations can produce inaccurate force reactions.

Furthermore, in certain rare cases that involve large or concentrated initial interference and/or thermal
expansion applications, the reactions calculated by the contact element option may differ from those
calculated by the underlying elements. If you experience such as scenario, the underlying element
approach is more accurate. Try to tighten the tolerances of the Newton-Raphson Option property
under the Nonlinear Controls (p. 900) category of the Analysis Settings (also see the CNVTOL
command) to improve the contact element reaction calculations.

• When a probe is scoped to a Mesh Connection, the Mechanical application reports the following reactions:

– Forces and Moments summed from the element nodal forces and moments in the result file.

– The Extraction detail determines which elements (Master or Slave) contribute to the force or moment
sum.

• The Surface Location Method enables you to study reactions on cutting planes. You can extract generated
member forces and reactions through a model by using a reaction probe scoped to a Surface (p. 666). For
this probe type, you must explicitly select the body or bodies (via the Geometry property) to be sliced. You
then specify for the Extraction property based upon whether you want to study the nodes in front or behind
the plane. The Force Reaction probe operates the on elements cut by the plane (and only nodes on those
elements which are on the selected side of the plane). Currently, surface probes cannot intersect a plane
strain or an axisymmetric model and consequently no results display for this scoping.

Important

Do not apply reaction probes to cutting planes that intersect a boundary condition because
the reported reactions become unreliable.

Note

Surfaces used in reaction probes do not currently intersect all geometries, such as line
bodies, joints, springs, and MPC contact.

Joint Probes
The joint type determines the available result types. Refer to the Joint Types (p. 750) section for a discus-
sion of joint types and the free degrees of freedom. The following table presents each of the joint probe
results available through the Result Type drop down menu in the Details view.

Release 2020 R1 - © ANSYS, Inc.


1298
Structural Results

Joint Probe Result Type Applicable Joint Type(s)


Total Force All
Total Moment All except Slot and Spherical
Relative Displacement All except Revolute, Universal, and Spherical
Relative Velocity All except Revolute, Universal, and Spherical
Relative Acceleration All except Revolute, Universal, and Spherical
Relative Rotation All except Translational
Relative Angular Velocity All except Translational
Relative Angular Acceleration All except Translational
Damping Force Bushing
Damping Moment Revolute, Cylindrical, and Bushing
Constraint Force Revolute, Cylindrical, and Bushing
Constraint Moment Revolute, Cylindrical, and Bushing
Elastic Moment Revolute, Cylindrical, and Bushing
Elastic Force Bushing
Friction Force Translational, Cylindrical
Friction Moment Revolute, Cylindrical

Joint Probe Characteristics and Requirements


Review the following characteristics and requirements to ensure that you properly configure your result.

• A joint defines the interface between two bodies. One of the bodies is referred to as a Reference body and
the other as the Mobile body. The results from the joint measure the relative motion of the mobile body
with respect to the reference body.

• A joint definition also includes specification of a local “reference” coordinate system for that joint. All results
from the joint are output in this reference coordinate system.

• The reference coordinate system moves with the reference body. Depending on the motion of the reference
body it might be difficult to interpret the joint results.

• All of these results have X, Y, and Z components in the reference coordinate system.

• Relative rotation is expressed in Euler angles. When all three rotations are free, the general joint cannot report
an angle that accounts for the number of turns. A typical behavior will be to switch from +π radians to -π
radians for increasing angles passing the π limit, as illustrated below.

• For spherical and general joints the output of relative rotations is characterized by the Cardan (or Bryant)
angles; the rotation around the joint Y axis is limited to between -90 degrees to +90 degrees. When this
rotation magnitude value reaches 90 degrees, the output may “jump” to the opposite sign.

Release 2020 R1 - © ANSYS, Inc.


1299
Using Results

• The convention for the deformations differs for joints in a Rigid Dynamics analysis vs. those in a Transient
Structural analysis. For the Rigid Dynamics type, the reference of zero deformation is taken after the model
has been assembled, and the initial conditions have been applied. For the Transient Structural analysis type,
the initial location of bodies is used as reference, before applying initial conditions.

• When you request a force or moment at a specific time point by setting Display time = time value in the
Details view of a Joint probe, the force or moment will be displayed by an arrow in the Geometry window.
Force will use a single arrowhead and moment will use double arrowhead.

• Joints compute no reactions forces or moments for the free degrees of freedom of the joint. However, Dis-
placement, Velocity, Acceleration, Rotation, Rotational Velocity and Rotational Acceleration conditions -
generate forces and moments, that are reported in the constraint force and moment.

• Joint forces and moment conditions are not reported in the joint force and moment probe.

• Joint force and moment are by definition the action of the reference body on the moving body. For the
ANSYS solver, the joint constraint forces and moments are reported in the joint reference coordinate system.
The elastic forces/moments and damping forces/moments in the joints are reported in the reference and
mobile axes of the joint which follow the displacements and rotations of the underlying nodes of the joint
element. When using the ANSYS Rigid Dynamics solver, the joint forces and moments components are always
reported in the joint reference coordinate system.

• For analyses that use the Mechanical APDL solver, joint force and moment probes are not supported for
Body-Body fixed joints when rigid bodies are present in the model. If these outputs are important, consider
forcing the use of Joint elements via the Solver Element Type (p. 761) property for the fixed joint.

Response PSD Probe


The Response PSD probe provides a spectrum response of a structural component subjected to a
random excitation. Response PSD is plotted as square of spectrum response over excitation frequency
range. The plot provides an information as to where the average power is distributed as a function of
frequency. The square root of the area under the response PSD is the so-called root-mean-square (RMS)
value. It is a one-sigma, or one-standard-deviation, value in a statistical term. The centroid of the area
under the response PSD probe, with respect to frequency, is referred to as the "expected frequency."

You can use the Response PSD Tool (p. 1303) to control the sampling points of the Response PSD
probe.

The Details View properties and selections for the Response PSD object are described below.

Property Control Description


Definition Type Read-only control: only Response PSD is allowed for this result.
Location The response PSD is a point based result. The location of the point can
Method be provided using geometry selection or coordinate system. For the
geometry selection, only vertex is allowed for the selection. For the
coordinate system, a local/customized coordinate system defining a certain
location can be used for evaluation of the response PSD. It can also be
scoped to a Remote Point if there is one defined in geometry.
Geometry Appears if Scoping Method is set to Geometry Selection.
Orientation Read-only control - only Solution Coordinate System is allowed for
this result.
Location Appears if Location Method is set to Coordinate System.

Release 2020 R1 - © ANSYS, Inc.


1300
Structural Results

Property Control Description


X Coordinate Read-only field that displays coordinate that is based on the Location
property of the coordinate system.
Y Coordinate Read-only field that displays coordinate that is based on the Location
property of the coordinate system.
Z Coordinate Read-only field that displays coordinate that is based on the Location
property of the coordinate system.
Reference Two options are available for the response PSD result evaluation; Relative
to base motion (or relative motion) and Absolute (including base
motion). For the Relative to base motion, the response of any location
in a structural component is calculated in term of a relative motion
between the base and the structural component, and vice versa.
Remote Appears if Location Method is set to Remote Points.
Points
Suppressed Include (No) or exclude (Yes) the result in the analysis.
Options Result Type Result Type: The result types include three basic motion
characteristics (Displacement, Velocity and Acceleration), Stress
(including normal and shear) and Strain (including normal and shear).
Result Selec- Defines the direction, in Solution Coordinate System, in which
tion response specified in the result type is calculated.
Selected Fre- Defines the frequency range for RMS calculation. Options include
quency Range Full (default) and Manual. The Full setting uses the entire excitation
frequency range.
Range Minim- Appears if Selected Frequency Range property is set to Manual.
um This property specifies the minimum frequency of the range.
Range Maxim- Appears if Selected Frequency Range property is set to Manual.
um This property specifies the maximum frequency of the range.
Results RMS Value Read-only field that displays value calculated during solution.
RMS Percent- Read-only field that displays the percentage of the root-mean-square
age of the selected frequency range over the entire available frequency
range.
Expected Fre- Read-only field that displays the value calculated during the solution.
quency

Spring Probes
You can use a probe (p. 1175) to display the following longitudinal result items from a spring.

Elastic Force: The force is calculated as (Spring Stiffness * Elongation). The force acts along the
length of the spring.
Damping Force: Damping force is calculated as (Damping Factor * Velocity) and acts to resist motion.
Elongation: The elongation is the relative displacement between the two ends of the springs. The
elongation could be positive (stretching the spring) or negative (compressing the spring).

Release 2020 R1 - © ANSYS, Inc.


1301
Using Results

Velocity: Velocity is the rate of stretch (or compression) of the spring. This quantity is only calculated
in a Static Structural, Transient Structural, or Rigid Dynamics analysis.

Note

During a Static Structural analysis, velocity is calculated as the difference of the relative dis-
placement of two nodes (defining the spring) divided by the duration of the time step.

Bearing Probes
A Bearing is essentially a two-spring-damper system that is aligned in any two coordinate axes of a
coordinate system; primarily a rotating plane.

For rotations in the X-Y plane, the result items for the first axis are in X direction and the results for the
second axis are in Y direction. The application adds a suffix (number 1 and 2) to each result item. The
X-Z and Y-Z rotation planes also use this convention.

You can use a Bearing probe to display the following result items.

Elastic Force 1
The force is calculated as (Spring Stiffness * Elongation). The force acts along the length of the spring along
the first axis.

Elastic Force 2
The force is calculated as (Spring Stiffness * Elongation). The force acts along the length of the spring along
the second axis.

Damping Force 1
Damping force is calculated as (Damping Factor * Velocity) and acts to resist motion along the first axis.

Damping Force 2
Damping force is calculated as (Damping Factor * Velocity) and acts to resist motion along the second
axis.

Elongation 1
The elongation is the relative displacement between the two ends of the spring in the first axis. The
elongation could be positive (stretching the spring) or negative (compressing the spring).

Elongation 2
The elongation is the relative displacement between the two ends of the spring in the second axis. The
elongation could be positive (stretching the spring) or negative (compressing the spring).

Velocity 1
Velocity is the rate of stretch (or compression) of the spring in the first axis. This quantity is only calculated
in a Transient Structural analysis.

Velocity 2
Velocity is the rate of stretch (or compression) of the spring in the second axis. This quantity is only calculated
in a Transient Structural analysis.

Release 2020 R1 - © ANSYS, Inc.


1302
Structural Results

Beam Probes
The Beam Probe results provide you the forces and moments in the beam from your analysis. Using
the Beam Probe you can determine the Axial Force, Torque, Shear Force at I, Shear Force at J, Moment
at I, Moment at J. You can also add the Force reaction and Moment Reaction probes to view reaction
force moment for the beam. To add beam probes:

1. In the Project Tree, click Solution to make the Solution toolbar available.

2. On the Solution toolbar, click Probe, and then click Beam to add the Beam Probe under Solution.

3. In the Details view, under Definition, click the Boundary Condition list and click the beam you want to
analyze.

4. Under Options, in the Result Selection list, click the result you want to calculate.

Bolt Pretension Probes


When a Bolt Pretension load (p. 967) is applied, the Mechanical application reports the following reac-
tions:

Adjustment: This represents the displacement that occurs from the applied pretension measured at
the point where the bolt is sliced. In Mechanical APDL terms, this is the displacement reported from
the pretension node. This result is also available for reporting regardless of how the bolt is defined.

Working Load/Preload Reaction: This represents a constrained force reaction from the pretension
load. It is the reaction from the applied constraint when a bolt is either specified as Locked, Adjustment,
or Increment, and reports a zero value during a step in which you have applied the preload (since there
is no reaction at the bolt slice during preload step). In Mechanical APDL terms, this is the constrained
reaction reported from the pretension node. This is essentially the sum of all the forces acting through
the pretension cut. This result is only applicable for load steps when the load is defined by either Locked
or Adjustment or Increment.

Generalized Plain Strain Probes


When a Generalized Plane Strain load (p. 976) is applied (2D application), the Mechanical application
reports the following reactions:

• Fiber Length Change: Fiber length change at ending point.

• Rotation X Component: Rotation angle of end plane about x-axis.

• Rotation Y Component: Rotation angle of end plane about y-axis.

• Force: Reaction force at end point.

• Moment X Component: Reaction moment on end plane about x-axis.

• Moment Y Component: Reaction moment on end plane about y-axis.

Response PSD Tool


You can apply a Response PSD Tool to any Random Vibration (p. 235) analysis (only) in order to control
the frequency sampling of Response PSD probes (p. 1300).

Release 2020 R1 - © ANSYS, Inc.


1303
Using Results

Scoping and Result Types


When inserted, the Response PSD Tool automatically generates a Response PSD probe (p. 1300) as its
child object. You then properly scope both objects as desired.

Application
To define results using the Response PSD Tool:

1. Display the Tools drop-down menu on the Solution context toolbar (p. 84) and select Response
PSD Tool or right-click the Solution (p. 1817) object or in the Geometry window and select Insert>Re-
sponse PSD Tool>Response PSD Tool.

2. A Response PSD Tool object is placed under Solution object and includes a Response PSD probe.
As needed, modify the following properties:

• Include All Excitation Frequencies: Options include Yes (default) and No. Selecting Yes includes
all excitation frequencies in the sampling. The No option includes minimum and maximum excitation
frequencies in addition to the frequency samplings for natural frequencies.

• Include User Defined Frequencies: Options include Yes and No (default). Selecting Yes enables
you to manually enter frequencies in the Tabular Data table (User Defined Frequency Steps).

• Clustering Frequency Points: The default value is 20. This property enables you to define the
number of frequencies generated for both sides of the natural frequencies for response PSD result
evaluations. If your response PSD curve contains a number of spikes, you can add more frequency
points to obtain a more accurate RMS result, however; this increases evaluation time.

3. Properly scope the properties of the Response PSD probe (p. 1300).

For additional information, see the object reference page (p. 1801) for the Response PSD Tool.

Gasket Results
Gasket results are structural results associated with ANSYS interface elements. When used with ANSYS
structural elements, interface elements simulate an interface between two materials. The behavior at
these interfaces is highly nonlinear.

To mesh a body using interface elements, highlight the Body object in the tree and set Stiffness Be-
havior (p. 178) to Gasket.

The following gasket results are available in the Mechanical Application:

• Normal Gasket Pressure - corresponding to Mechanical APDL command PLNSOL,GKS,X

• Shear Gasket Pressure - corresponding to Mechanical APDL commands PLNSOL,GKS,XY and PLNSOL,GKS,XZ

• Normal Gasket Total Closure - corresponding to Mechanical APDL command PLNSOL,GKD,X

• Shear Gasket Total Closure - corresponding to Mechanical APDL commands PLNSOL,GKD,XY and
PLNSOL,GKD,XZ

These results are only available in the solution coordinate system (p. 1196).

Release 2020 R1 - © ANSYS, Inc.


1304
Structural Results

Campbell Diagram Chart Results


A Campbell diagram chart result is only valid in Modal analyses. The Campbell diagram chart result is
mainly used in rotor dynamics for rotating structural component design. When a structural component
is rotating, an inertial force is introduced into the system. The dynamic characteristics of the structural
component change as a result of the inertia effect, namely, gyroscopic effect. To study changes in dy-
namic characteristics of a rotating structure, more than one solve point in Rotational Velocity (p. 931) is
required.

Prerequisites
In addition to being applicable to only Modal analyses, you must ensure that the following Analysis
Settings are activated in order to properly apply a Campbell Diagram. Select the Analysis Settings
object in your Modal Analysis and perform the following settings:

• Under Solver Controls: Damped = Yes.

• Under Rotordynamics Controls:

– Coriolis Effect = On

– Campbell Diagram = On

In addition, a Rotational Velocity (p. 931) boundary condition must be created in order to properly scope
the Campbell Diagram.

Applying a Campbell Diagram


To insert a Campbell diagram chart result, highlight the Solution object in the tree, then select Campbell
Diagram from the Solution Context Toolbar (p. 84), or right-click the object and choose Insert>Campbell
Diagram.

The following is an example of a Campbell diagram result chart:

Release 2020 R1 - © ANSYS, Inc.


1305
Using Results

In this chart, each line represents a frequency evolution of a whirl mode with respect to increased rota-
tional velocities. The whirl frequency value of an eigenmode at each rotational velocity is also listed in
the table. For each whirl mode, it is either labeled as forward (FW) or backward (BW) whirl direction. In
some cases, when there is no evident whirl direction, the whirl frequency is labeled as UNDETERMINED.
If a whirl mode is identified as FW, the rotating structural component whirls the same direction as the
rotation direction, and vice versa. If a whirl mode is evaluated to be unstable (marked as UNSTABLE),
the whirl orbit will evolve into a divergent trajectory, instead of an elliptical trajectory.

In addition to whirl modes, a line (black color) of any ratio between whirl frequency and rotational ve-
locity is plotted. The intersection between this line and each whirl mode is indicated with a red triangular
marker. The rotational velocity corresponding to this intersection is called critical speed. At critical speed,
the rotating structural component will experience a peak as the rotating frequency resonates with the
natural whirl frequency.

The Campbell diagram chart result can be customized in Details of Campbell Diagram as follows:

Scope
• Rotational Velocity Selection: This field displays the user-defined Rotational Velocity of the analysis for
which the Campbell diagram chart result is evaluated. If one is not defined, the field is highlighted in yellow
and displays the value None.

Release 2020 R1 - © ANSYS, Inc.


1306
Structural Results

Campbell Diagram Controls


• Y Axis Data: The data type options include: Frequency (default), Stability, Logarithmic Decrement, and
Modal Damping Ratio.

• Critical Speed: Option for users to display critical speeds. The default is Yes. Requires you to provide a value
in the Ratio field. The option is only valid for frequency.

• Ratio: Value used to evaluate critical speeds. The default value is 1.0.

• Sorting: Option to display data in a sorted mode manner when some modes are crossing/intercepting each
other. The default is Yes.

• Stable Motion Sign: This option displays when you specify Logarithmic Decrement for the Y Axis Data
property. This option controls the sign of Logarithmic Decrement value for stable motion. The options include
Stable - Negative (default) and Stable - Positive.

Note

Any change made in these fields requires a result re-evaluation.

Axis

Note

Two different unit types, rad/s and RPM, are available to define rotational velocity in the
chart. The selection can be made in Units toolbar.

• X Axis Label: Allows users to provide a customized label for rotational velocity.

• X Axis Range: There are two options to display the rotational velocity data range; Program Controlled and
User Defined. The default setting is Program Controlled, which uses minimum and maximum determined
by the system. The option of User Defined allows users to provide a customized range to be used in the

Release 2020 R1 - © ANSYS, Inc.


1307
Using Results

chart. The minimum and maximum values are displayed in the X Axis Minimum and X Axis Maximum
fields following the result evaluation.

• X Axis Minimum: Minimum rotational velocity value is displayed according to the selection made in X Axis
Range.

• X Axis Maximum: Maximum rotational velocity value is displayed according to the selection made in X
Axis Range.

• Y Axis Label: Allows users to provide a customized label for Frequency, Stability, Logarithmic Decrement,
or Modal Damping Ratio depending on the selection made in Y Axis Data.

• Y Axis Range: The options include Program Controlled and User Defined, to display the frequency, stability,
logarithmic, or modal damping ratio value range depending on the selection made in Y Axis Data property.
The default setting, Program Controlled, uses the minimum and maximum determined by the system. The
option of User Defined enables you to provide a customized range. The minimum and maximum values
are displayed in the Y Axis Minimum and Y Axis Maximum fields following the result evaluation.

• Y Axis Minimum: Minimum frequency, stability, logarithmic decrement, or modal damping ratio value is
displayed according to the selection made in Y Axis Range property.

• Y Axis Maximum: Maximum frequency, stability, logarithmic decrement, or modal damping ratio value is
displayed according to the selection made in Y Axis Range property.

Acoustic Results
The following result options are supported for acoustic analyses:

Result Description
Pressure Nodal pressures are calculated as part of the overall nodal solution. This corresponds
to Mechanical APDL command PLNSOL,PRES.
Total The acoustic total velocity is calculated by Mechanical APDL as the resultant of the
Velocity pressure gradient components. This corresponds to Mechanical APDL command
PLNSOL,PG,SUM.
Directional The acoustic directional velocity is calculated by Mechanical APDL as the
Velocity corresponding component of the pressure gradient. The available directions are
X, Y, and Z. This corresponds to Mechanical APDL command PLNSOL,PG, X/Y/Z.
Kinetic Acoustic kinetic energy in element. This corresponds to Mechanical APDL command
Energy PLNSOL,KENE.
Potential The acoustic potential energy in the element. This corresponds to Mechanical APDL
Energy command PLNSOL,MENE.

Release 2020 R1 - © ANSYS, Inc.


1308
Acoustic Results

The following result options are supported for Harmonic Acoustic analyses:

Result Description
Sound The Acoustic Sound Pressure Level is calculated as part of the overall nodal
Pressure solution. This corresponds to Mechanical APDL command PLNSOL,SPL.
Level
A-Weighted The Acoustic A-Weighted Sound Pressure Level is calculated as part of the overall
Sound nodal solution. This corresponds to Mechanical APDL command PLNSOL,SPLA.
Pressure
Level
Frequency The Acoustic Frequency Band SPL is calculated for the requested nodes. This
Band corresponds to Mechanical APDL command PRAS,BSPL.
SPL
A-Weighted The Acoustic A-Weighted Frequency Band SPL is calculated for the requested
Frequency nodes. This corresponds to Mechanical APDL command PRAS,BSPA.
Band
SPL
Far The far field parameters at the requested nodes in spherical coordinate system
Field are calculated based on the equivalent source principle. This corresponds to
Mechanical APDL command PLFAR.

Refer to the Far Field Results (p. 1309) section (next section) as well as the Reviewing Analysis Results
section of the Mechanical APDL Acoustic Analysis Guide for more information.

Far Field Results


The far sound pressure field and far-field parameters (for example, radiation patterns, directivity, radiated
power, radiation efficiency, and target strength) are essential for sound radiation or sound scattering
analysis. The equivalent source surface principle using Green’s function allows us to evaluate these
parameters.

The surface equivalence principle enables you to calculate the pressure fields beyond the FEA domain.
It states that the pressure field exterior to a given surface can be exactly represented by an equivalent
source placed on that surface and allowed to radiate into the region external to that surface. Refer to
Far Sound Pressure Field and Far-Field Parameters topic in the Mechanical APDL Acoustic Analysis Guide
for more information.

Release 2020 R1 - © ANSYS, Inc.


1309
Using Results

Where:

r = far-field observation position.


rs = equivalent source position on the enclosed surface.

The following Far Field results are available in Mechanical:

• Far Field SPL

• Far Field A-Weighted SPL

• Far Field Maximum Pressure

• Far Field Phase

• Far Field Directivity

• Far Field Maximum Scattered Pressure

• Far Field Target Strength

• Far Field Sound Power Level

Important

If your Harmonic Acoustics analysis specifies an Incident Wave Source (p. 1042) excitation:

• The Far Field Sound Power Level and Far Field Directivity results are not supported when the
Incident Wave Location property is set to Outside the Model (default).

• In order to post process the Far Field Sound Power Level and Far Field Directivity results, the
Scattering Field Formulation property must be set to On. Refer to the Scattering Controls (p. 897)
section for additional information.

Release 2020 R1 - © ANSYS, Inc.


1310
Thermal Results

• The Far-Field Maximum Scattered Pressure and Far Field Target Strength results are not supported
when the Incident Wave Location property is set to Inside the Model.

Note

• Currently, Far Field results are not:

– Supported for animation.

– Supported for user Defined Results.

– Calculated at points on the finite element model. The Geometry window legend displays the
minimum and maximum values but no contours are displayed on the elements.

• Except for the Sound Power Level Far Field result, all Far Field Results are evaluated for a single
frequency or a single set specified by the user. If a specified frequency is not contained in the
result file frequency history, then the nearest frequency from the file is used.

• The Far Field Sound Power Level evaluates at all frequencies and the minimum and maximum
displayed in the Geometry window legend represent the extremes over all frequencies.

• The following capabilities are disabled if you have imported or restored an archive file (that does
not include a result file).

– Exporting Far Field Results to an ASCII file.

– The Worksheet and Tabular Data upon clicking a Far-Field Result.

Re-solve the project in order to restore these post processing capabilities.

Thermal Results
The following thermal result topics are addressed in this section:
Temperature
Heat Flux
Heat Reaction
Error (Thermal)
Thermal Flow Results
Thermal Probes
Thermal Contact Results

Thermal Probes (p. 1314) can be used to determine the following results:

• Temperature

• Heat Flux

Release 2020 R1 - © ANSYS, Inc.


1311
Using Results

• Heat Reaction

Note

Currently, thermal analyses do not support the Contact Tool (p. 1268).

Temperature
In a steady-state or transient thermal analysis, temperature distribution throughout the structure is
calculated. This is a scalar quantity.

Scoping allows you to limit the temperature display to particular geometric entities. Similarly scoping
allows you to get reactions at specific boundary condition objects. Temperature results can be displayed
as a contour plot. You can also capture the variation of these results with time by using a probe.

Heat Flux
The Mechanical application calculates the heat flux (q/A, energy per unit time per unit area) throughout
the body. Heat flux can be output as individual vector components X, Y or Z.

You can display the X, Y, and Z components of heat flux in different coordinate systems.

Scoping allows you to limit the heat flux display to particular geometric entities. Similarly scoping allows
you to get reactions at specific boundary condition objects. Heat flux results can be displayed as a
contour plot. You can also capture the variation of these results with time by using a probe.

Plots of Vector Heat Flux


A Vector Heat Flux plot provides the direction of heat flux (relative magnitude and direction of flow)
at each point in the body.

The following graphic illustrates an example showing a high temperature area at the top and a low
temperature area at the bottom. Note the direction of the heat flow as indicated by the arrows.

Release 2020 R1 - © ANSYS, Inc.


1312
Thermal Results

Request Vector Heat Flux plots in the same way that you would request any other result. After inserting
the result object in the tree and solving, click the Graphics button (p. 89) in the Result context toolbar.

Heat Reaction
You can obtain heat reaction (q, energy per unit time) at locations where a temperature, imported
temperature, convection, or radiation boundary condition is specified. Heat reaction is a scalar.

To obtain a heat reaction result, insert a Reaction probe (p. 1161) and specify an existing Boundary
Condition, Geometry, Contact Region, or Surface construction geometry. See Thermal Probes (p. 1314)
for more information.

Error (Thermal)
The description of this result is the same as Error (Structural) (p. 1232) except that heat flux is the basis
for the errors instead of stresses.

Thermal Flow Results


You use the following flow-based result types for 2D and 3D thermal fluid flow analyses. Your model
must include a line body (p. 498) that you specify as Thermal Fluid for these result types to be available
for selection.

• Fluid Flow Rate: rate of fluid flow through the specified Line Body.

• Fluid Heat Conduction Rate: heat flow rate due to conduction within the fluid.

See FLUID116 in the Mechanical APDL Element Reference. The Output Data topic examines the solution
output for these results.

Release 2020 R1 - © ANSYS, Inc.


1313
Using Results

Thermal Probes
The following thermal probe types are available.

Probe Type Applicable Analysis Types Output


Temperature Steady-state thermal, transient thermal Temperature: overall

Heat Flux Steady-state thermal, transient thermal Heat Flux: X axis, Y axis, Z axis

Heat Reaction Steady-state thermal, transient thermal Heat: overall

Radiation Steady-state thermal, transient thermal Outgoing Net Radiation, Emitted


Radiation, Reflected Radiation,
(see note below) Incident Radiation

Release 2020 R1 - © ANSYS, Inc.


1314
Thermal Results

Probe Type Applicable Analysis Types Output

Note

• Refer to the Probe Details View (p. 1179) section for additional information about the above scoping
options.

• If you receive a negative value for the Outgoing Net Radiation result, then the application is
detecting that heat is entering the scoped entity.

• For 2D plane stress models the Radiosity Solver method assumes an infinite third dimension so
the Radiation Probe results will be proportional to the Workbench model thickness.

• For plane and cyclic symmetries the Radiation Probe results are calculated for the full symmetry
model.

See the Probes (p. 1175) section for further information.

Thermal Contact Results


If your model contains Contact Regions, you can define the contact results as listed below under the
Construction object or the Solution object by inserting a Contact Tool. See the Reviewing the Results
section of the Mechanical APDL Contact Technology Guide for additional information.

Thermal Flux: available only for evaluating contact conditions after solution. This data represents the
total heat flux at the contact surface.

Status: status codes include:

• -3: MPC bonded contact.

• -2: MPC no-separation contact.

• 0: open and not near contact.

• 1: open but near contact.

• 2: closed and sliding.

• 3: closed and sticking.

The labels Far, Near, Sliding, and Sticking are included in the legend for Status.

Note

• MPC-based contact definitions use negative values. They indicate the intentional removal of one
or more contact constraints to prevent over-constraint.

• Contact that has been deactivated via Auto Asymmetric behavior will be displayed with a status
of Far-Open. Results for deactivated pairs can be suppressed in the Contact Tool by changing
Both to either Contact or Target as necessary.

Release 2020 R1 - © ANSYS, Inc.


1315
Using Results

Please review the descriptions, restrictions, and caveats for contact results and displays that are included
in the Contact Results (p. 1243) section under Structural Results (p. 1224).

Magnetostatic Results
A magnetostatic analysis offers several results items for viewing. Results may be scoped to bodies and,
by default, all bodies will compute results for display. You can use the Details view to view vector results
in several ways. Magnetic Flux Density, Magnetic Field Intensity, and Force represent the magnitude of
the results vector and can be viewed as a contour or as a directional vector. Any directional solution
represents direction vector components (X, Y, Z) of the vector. They may be displayed as a contour.

The following electromagnetic result topics are addressed in this section:


Electric Potential
Total Magnetic Flux Density
Directional Magnetic Flux Density
Total Magnetic Field Intensity
Directional Magnetic Field Intensity
Total Force
Directional Force
Current Density
Inductance
Flux Linkage
Error (Magnetic)
Magnetostatic Probes

Magnetostatic Probes (p. 1319) can be used to determine the following results:

• Flux Density

• Field Intensity

• Force Summation

• Torque

• Energy

• Magnetic Flux

Known Limitation

In some instances, during the solution process for magnetic analyses, the application may automatically
generate new elements that are not included in the original mesh or within a geometry body. Further-
more, these elements may contain magnetic force (FMAG) results.

These elements are considered to be supplementary elements. If one of these supplementary elements
share a node with an element from the original mesh, the forces from the supplementary elements can
contribute to the force value at the shared node.

Regardless of whether you scope results to a body, the supplementary elements may still contribute
to the force results at nodes of the scoped body.

Using the /POST1 command, you can counteract this effect by unselecting the element type associated
with the supplementary elements with the command string: ESEL,U,TYPE.

Release 2020 R1 - © ANSYS, Inc.


1316
Magnetostatic Results

Electric Potential
Electric potential represents contours of constant electric potential (voltage) in conductor bodies. This
is a scalar quantity.

Total Magnetic Flux Density


Magnetic Flux Density is computed throughout the simulation domain and is a vector quantity. Selecting
this option allows you to view the magnitude of the vector as a contour or as a directional vector.

Directional Magnetic Flux Density


Magnetic Flux Density vector components are computed throughout the simulation domain. Selecting
this option allows you to view individual vector components (X, Y, Z) as a contour.

Total Magnetic Field Intensity


Magnetic Field Intensity is computed throughout the simulation domain and is a vector quantity. Selecting
this option allows you to view the magnitude of the vector as a contour or as a directional vector.

Directional Magnetic Field Intensity


Magnetic Field Intensity vector components are computed throughout the simulation domain. Selecting
this option allows you to view individual vector components (X, Y, Z) as a contour.

Total Force
Total Force results represent electromagnetic forces on bodies. This is a vector quantity. Selecting this
option allows you to view the magnitude of the vector as a contour or as a directional vector.

Directional Force
Vector components of force and torque are computed throughout the simulation domain. They are
meaningful only on non-air bodies. Selecting this option allows you to view individual vector force
components (X, Y, Z) as a contour. The total summed forces and torque are available in the Details view.
For example, requesting the z component of directional force/torque will report the net force acting in
the z direction and the net torque acting about the z axis of the specified coordinate system.

Current Density
Current density can be computed for any solid conductor body. It is displayed as a vector and is best
viewed in wireframe mode. You can use the Vector toolbar to adjust the vector arrow viewing options.
You can use the element-aligned option in the Vector toolbar for current density vectors, but not the
grid-aligned option.

Inductance
Inductance can be computed for conductor bodies. It is defined as a measure of the differential change
in flux linkage to the differential change in current. This is represented by the equation below, where
dψ is the differential change in flux linking conductor j produced by a differential change in current
for conductor i. Note that this is valid for linear and nonlinear systems, the inductance will be a function
of current.

Release 2020 R1 - © ANSYS, Inc.


1317
Using Results

Inductance is often used as a parameter in electric machine design and in circuit simulators.

A conductor body must have a current load to be considered in inductance calculations. Inductance
results are presented in the Worksheet View. The results are presented in table form. The example below
shows inductance results for a two-conductor system. The diagonal terms represent self-inductance,
while the off-diagonal terms represent mutual inductance. In this case, L 11 = 1e - 4, L22 = 8e - 4, L12 =
L21 = 4e - 4 Henries.

Cond1 Cond2
(H) (H)
Cond1 1e-4 4e-4
Cond2 4e-4 8e-4

The Details view for inductance allows you to define a Symmetry Multiplier. Use this if your simulation
model represents only a fraction of the full geometry. The multiplier should be set to compensate for
the symmetry model. For example, if you create a half-symmetry model of the geometry for simulation,
set the Multiplier to '2.' Changing the multiplier will update the Worksheet results.

Note

• Computing inductance can be time-consuming and should only be used if needed.

• Loads (Voltage, and Current) must be constant when Inductance is specified. Tabular and function
loads are not supported.

• Inductance can only be used with a single step, single substep solution. User settings to the
contrary will be overridden.

• Inductance requires the Direct solver setting (default) for the Solver Type property of Analysis
Settings. User settings to the contrary will be overridden.

Flux Linkage
Flux linkage can be computed for any system incorporating a conductor. Solving for flux linkage calculates
the flux, ψ, linking a conductor. This is commonly referred to as the "flux linkage." For nonlinear systems,
the flux linkage will be a function of current. Flux linkage is also a function of stroke (e.g., displacement
of an armature).

Flux linkage is often used to compute the emf (electromotive force) in a conductor, defined using the
equation below, where V is the electromotive force, typically expressed in volts.

Conductor bodies must have defined current loads to be considered in flux linkage calculations. Flux
linkage results are presented in the Worksheet View. The results are presented in table form. The example
below shows flux linkage results for a two-conductor system.

Release 2020 R1 - © ANSYS, Inc.


1318
Magnetostatic Results

Flux Linkages
(Wb)
Cond1 5e-4
Cond2 10e-4

The Details view for flux linkage allows you to define a Symmetry Multiplier. Use this if your simulation
model represents only a fraction of the full geometry. The multiplier should be set to compensate for
the symmetry model. For example, if you create a half-symmetry model of the geometry for simulation,
set the Multiplier to '2.' Changing the multiplier will update the Worksheet results.

Note

• Computing flux linkage can be time-consuming and should only be used if needed.

• Loads (Voltage, and Current) must be constant when flux linkage is specified. Tabular and function
loads are not supported.

• Flux linkage can only be used with a single step, single substep solution. User settings to the
contrary will be overridden.

• Flux linkage requires the Direct solver setting (default) for the Solver Type property of Analysis
Settings. User settings to the contrary will be overridden.

Error (Magnetic)
The description of this result is similar to Error (Structural) (p. 1232) except that flux density is the basis
for the errors instead of stresses.

When all materials are linear, Workbench uses relative permeability (MURX, MURY, MURZ) values which
are available in the material properties.

When nonlinear materials are present, Workbench does not extract relative permeability from the ma-
terial properties. Instead, for a given element, Workbench first sums the flux density vectors of the result
nodes to form a vector called B . Workbench next sums the field intensity vectors of the result nodes
to form a vector called H .

MURX, MURY, and MURZ are all assigned the value ( |B|/|H| ) / MUZERO, where:

• |B| is the length of the B vector,

• |H| is the length of the H vector,

• MUZERO is free space permeability.

If the H vector has a zero length, the contribution of this element to the energy error will be set to 0.

Magnetostatic Probes
The following magnetostatic probe types are available.

Release 2020 R1 - © ANSYS, Inc.


1319
Using Results

Probe Type Applicable Analysis Output Characteristics


Types
Flux Density Magnetostatic Flux Density: X axis, Scope to:
Y axis, Z axis body.

Scope by:
bodies, location
only, vertex,
edge, face.

Orientation
coordinate
system: any;
defaults to
Global
Cartesian.
Field Intensity Magnetostatic Flux Intensity: X axis, Scope to:
Y axis, Z axis body.

Scope by:
bodies, location
only, vertex,
edge, face.

Orientation
coordinate
system: any;
defaults to
Global
Cartesian.
Force Summation Magnetostatic Force Sum: X axis, Y Scope to:
axis, or Z axis; body.
Symmetry Multiplier
Scope by:
bodies.

Orientation
coordinate
system: any;
defaults to
Global
Cartesian.
Torque Magnetostatic Torque: 1 (p. 1321) X Scope to:
axis, Y axis, or Z axis; body.
Symmetry Multiplier
Scope by:
bodies.

Orientation
coordinate
system: any;
defaults to

Release 2020 R1 - © ANSYS, Inc.


1320
Electric Results

Probe Type Applicable Analysis Output Characteristics


Types
Global
Cartesian.

Summation:
Orientation
coordinate
system.
Energy Magnetostatic Magnetic Co-energy Scope to:
body.

Scope by:
System or per
body.
2
Magnetic Flux Magnetostatic Magnetic Flux Scope to:
(p. 1321) body.

Scope by:
edge.

Note

A limitation exists when the scoping of a Force Summation or a Torque probe is applied
to a geometry entity (Location Method = Geometry Selection) that shares more than
one body. The (unscoped) elements that are adjacent to the scoped body contribute
to the probe's results.

1 - Torque results represent the torque on a body due to electromagnetic forces. Torque is specified
about the origin of a coordinate system. By default, the global coordinate system is used. To change
the specification point, create a local coordinate system and specify the results about the new origin.
The torque result is listed in the Details view.

2 - Magnetic Flux is computed along the edge scoping. The scoping should produce a single continuous
path along a model edge. Flux is reported as magnitude only.

See the Probes (p. 1175) section for further information.

Electric Results
The following electric result types are available:

Result Type Description


Electric Represents contours of constant electric potential (voltage) in conductor bodies. This is
Voltage a scalar quantity.
Total Electric Is computed throughout the simulation domain and is a vector sum quantity. Selecting
Field Intens- this option allows you to view the total magnitude of the vectors as a contour.
ity

Release 2020 R1 - © ANSYS, Inc.


1321
Using Results

Result Type Description


Directional Its vector components are computed throughout the simulation domain. This option
Electric Field allows you to view individual vector components (X, Y, Z) as contours.
Intensity
Total Current Can be computed for any solid conductor body. It is displayed as a vector and is best
Density viewed in wireframe mode. You can use the Vector toolbar to adjust the vector arrow
viewing options. You can use the element-aligned option in the Vector toolbar for current
density vectors, but not the grid-aligned option.
Directional Its vector components are computed throughout the simulation domain. This option
Current allows you to view individual current density vector components (X, Y, Z) as contours.
Density
Joule Heat Occurs in a conductor carrying an electric current. Joule heat is proportional to the square
of the current, and is independent of the current direction.

Note

This result when generated by non-zero contact resistance is not


supported.

Electric Probes (p. 1322) can be used to determine the following results:

• Electric Voltage

• Field Intensity

• Current Density

• Reaction

Electric Probes
The following electric probe types are available.

Probe Type Applicable Analysis Output Characteristics


Types
Electric Voltage Electric Voltage Scope to: body.

Scope by: bodies,


location only,
vertex, edge, face.
Field Intensity Electric X axis, Y axis, Z axis, Scope to: body.
Total
Scope by: bodies,
location only,
vertex, edge, face.

Orientation
coordinate system:
any; defaults to
Global Cartesian.

Release 2020 R1 - © ANSYS, Inc.


1322
Fatigue Results

Probe Type Applicable Analysis Output Characteristics


Types
Current Density Electric X axis, Y axis, Z axis, Scope to: body.
Total
Scope by: bodies,
location only,
vertex, edge, face.

Orientation
coordinate system:
any; defaults to
Global Cartesian.
Joule Heat Electric Analysis and Power Scope to: body
Thermal-Electric Analysis only.

Scope by: body.


Reaction Electric Current: overall Scope to: body.

Scope by:
Boundary Condition.

Refer to the Probe Details View (p. 1179) section for additional information about the above scoping op-
tions. Also see the Probes (p. 1175) section for further information.

Fatigue Results
Fatigue provides life, damage, and safety factor information and uses a stress-life or strain-life approach,
with several options for handling mean stress and specifying loading conditions. An example of the
strain-life approach is a part/body with notch where, although the nominal response is elastic, the local
response may present as a plastic. Review the following sections with regards to fatigue material
properties, the theory of the calculations associated with the material properties, loading conditions,
and results.
Fatigue Material Properties
Fatigue Stress Life versus Strain Life
Frequency-Based Fatigue
Fatigue Analysis Application
Fatigue Results

Fatigue Material Properties


Engineering Data contains example materials which may include fatigue curves populated with data
from engineering handbooks. You can also add your own fatigue curves. The Fatigue Tool will use the
information from these curves for each material in the model when calculating life, damage, safety
factors, etc. If Young's Modulus is temperature dependent, then the fatigue calculations are carried out
using the Young's Modulus computed at the reference temperature of the body.

For the strain-life approach, the materials must have Strain-Life Parameters defined. For the Stress-Life
approach, the materials must have Alternating Stress defined. To add this data to a material follow the
Add Material Properties procedure (see Perform Material Tasks in Engineering Data).

Release 2020 R1 - © ANSYS, Inc.


1323
Using Results

Alternating Stress
The alternating stress, or stress-life (SN), mean curve data can be defined for a mean stress or r-ratio. The
Interpolation method (Log-Log, Semi-Log, or Linear) can be defined. The curve data must be defined
to be greater than zero.

• Mean Stress

Use this definition if experimental SN data was collected at constant mean stress for individual
SN curves.

• R-Ratio

Use this definition if multiple SN curves were collected at a constant r-ratio. The r-ratio is defined
as the ratio of the second loading to the first: r = L2 / L1. Typical experimental r-ratios are -1 (fully
reversed), 0 (zero-based), and .1 (to ensure that a tensile stress always exists in the part).

It is possible to define multiple SN curves to account for different mean stress or r-ratio values. The
values of mean stress/r-ratio are only important if multiple curves are defined and the SN-Mean
Stress Curves correction using experimental data option is chosen in the Fatigue Tool

Strain-Life Parameters
The following four strain-life parameter properties and the two cyclic stress-strain parameters must have
data defined:

• Strength Coefficient

• Strength Exponent

• Ductility Coefficient

• Ductility Exponent

• Cyclic Strength Coefficient

• Cyclic Strain Hardening Exponent

S-N Curve
For a Frequency-Based Fatigue analysis, the S-N Curve material properties enable you to examine frequency-
based fatigue formulations using either a linear or bi-linear curve for Stress (S) versus the number of life
cycles (N). Material property options include:

• Linear

Use this definition for single slope SN curve data.

• Bi-Linear

Use this definition for when you have two sloped of SN curve data.

Refer to the next section, Fatigue Stress Life Versus Strain Life (p. 1325), for additional information about
strain-life parameters.

Note that in Engineering Data, in the Display Curve Type drop-down menu, you can plot either a
Strain-Life or Cyclic Stress-Strain curve.

Release 2020 R1 - © ANSYS, Inc.


1324
Fatigue Results

Fatigue Stress Life versus Strain Life


Within the ANSYS fatigue module, the first decision that needs to be made in performing a fatigue
analysis is which type of fatigue analysis to perform, Stress-life or Strain-life. Stress-life is based on em-
pirical S-N curves which are modified by a variety of factors. Strain-life is based upon the Strain Life
Relation Equation where the Strain-life Parameters are values for a particular material that best fit the
equation to measured results. The Strain Life Relation Equation requires a total of 6 parameters to define
the strain-life material properties: four strain-life parameter properties and the two cyclic stress-strain
parameters. The Strain Life Relation Equation is shown below:

The two cyclic stress-strain parameters are part of the equation below:

Where:

= Total Strain Amplitude


= 2 x the Stress Amplitude
= Modulus of Elasticity
= Number of Cycles to Failure
= Number of Reversals to Failure

And the parameters required for a Strain Life analysis include:

= Fatigue Strength Coefficient


= Fatigue Strength Exponent (Basquin’s Exponent)
= Fatigue Ductility Coefficient
= Fatigue Ductility Exponent
= Cyclic Strength Coefficient
= Cyclic Strain Hardening Exponent

Note in the above equation, total strain (elastic + plastic) is the required input. However, running a finite
element analysis to determine the total response can be very expensive and wasteful, especially if the
nominal response of the structure is elastic. An accepted approach is to assume a nominally elastic re-
sponse and then make use of Neuber’s equation to relate local stress/strain to nominal stress/strain at
a stress concentration location.

To relate strain to stress we use Neuber's Rule:

Release 2020 R1 - © ANSYS, Inc.


1325
Using Results

Where:

= Local (Total) Strain

= Local Stress

= Elastic Stress Concentration Factor

= Nominal Elastic Strain

= Nominal Elastic Stress

The Fatigue Tool (p. 1692) assumes nominal elastic behavior and therefore , and by simultaneously
solving Neuber's equation along with cyclic strain equation, we can calculate the local stress/strains
(including plastic response) given only elastic stress input. Note that this calculation is nonlinear and is
solved using iterative methods. In addition, ANSYS fatigue calculations use a value of 1 for the Elastic
Stress Concentration Factor ( ), assuming that the mesh is refined enough to capture any stress con-
centration effects. in this case is not be confused with the Stress Reduction Factor option which is
typically used in a Stress-life analysis to account for factors such as reliability and size effects.

Frequency-Based Fatigue
Mechanical enables you to perform Frequency-Based Fatigue analyses using the Harmonic Response
and Random Vibration analysis types or using a combination of the two. Refer to the Frequency-Based
Fatigue Material Properties (p. 1327) and Frequency-Based Fatigue Result Methods (p. 1330) sections for
additional technical details for Frequency-Based Fatigue calculations.

Random Vibration Analysis


When analyzing the dynamic response of the structure, the application uses the frequency domain
for calculations and therefore loading is a function of frequency or random vibrations. Examples of
this include:

• Electronic vibration in PCB board

• Automobile engine vibrations

• Vibrations of a helicopter in flight

• Vibrations of a shaker table

• Natural vibrations of structures due to sea waves or winds

Harmonic Response Analysis


If the response of the system is harmonic in nature, not random, the application uses the maximum
stress response for a either a single target frequency or sweeping multiple target frequencies, along
with the duration of exposure to calculate the fatigue effects.

Combination Analysis
You can also choose to calculate fatigue damage from Random Vibration and Harmonic analyses and
then create User-Defined results (p. 1340) to combine the effects in order to analyze the total damage
to the system.

Release 2020 R1 - © ANSYS, Inc.


1326
Fatigue Results

Frequency-Based Fatigue Material Properties


All Frequency-Based Fatigue formulations are driven by the material’s relationship between Stress (S)
and number of life cycles (N). This S-N relation can be defined in the Engineering Data Workspace using
any of the following:

• Linear S-N Curve (p. 1327)

• Bi-linear S-N Curve (p. 1328)

• S-N Curve Table (p. 1329)

Important

• For Frequency-Based Fatigue calculations, you need to employ at least one of the SN Curve
formulations listed above in order to proceed with a solution.

• For both the Linear S-N Curve and the Bi-linear S-N Curve, the reference units for the para-
meters is [Pa]. No other unit or unit system is currently supported.

• In the various S-N Curve formulas covered here, the "S" value always refers to Stress Amp-
litude.

As long as you define material properties using one of the above formulas, you can perform Frequency-
Based Fatigue calculations.

Note

• In the Harmonic Response fatigue analysis, the S-N Curve Table will take precedence and it will
be used if available. If the table is not present, then the solver will use either the Linear/Bilinear
parameters, whichever is present.

• If all are defined, linear or bi-linear takes precedence over table for frequency domain fatigue.

Linear S-N Curve Formula


This is a single segment S-N Curve formula of the form:

Release 2020 R1 - © ANSYS, Inc.


1327
Using Results

Where:

A = Fatigue Strength Coefficient


m = Fatigue Strength Exponent
S = Stress Amplitude (in Pa)

Note

The value "m" is the inverse negative slope of the Linear S-N Curve.

Bi-Linear S-N Curve Formula


This is a two segment S-N Curve formula of the form:

&

Where:

A = First Fatigue Strength Coefficient


m = First Fatigue Strength Exponent
C = Second Fatigue Strength Coefficient

Release 2020 R1 - © ANSYS, Inc.


1328
Fatigue Results

r = Second Fatigue Strength Exponent


SQ = Stress Amplitude at Transition Point (in Pa)
NQ = Number of cycles at Transition Point

Using the Derive from property in Engineering Data Workspace, select one of two methods of
definition:

• Coefficients and Exponents: Users define A, m, C, and r.

• Transition Point: define m, r, NQ, and SQ.

All other properties are automatically calculated.

Note

The "m" and "r" values are the inverse negative slopes of the Bilinear S-N Curve.

S-N Curve Table


As illustrated below the default data for the S-N Curve is contained in the Engineering Data Workspace
tabular data of corresponding Alternating Stresses and Cycles of life.

Note

If only the SN table is provided (and not the Linear/Bilinear parameters themselves), then
the solver will use the first and last points of the table to perform a linear interpolation using
equation and arrive at the required parameters of A and m. Once the A and m values
are obtained, we can proceed with the solution normally. If either of the parameters (Lin-
ear/Bilinear) are provided directly through the material definition, they will be used directly.
(The table, if present, will be ignored in this case).

Release 2020 R1 - © ANSYS, Inc.


1329
Using Results

Frequency-Based Fatigue Result Methods


There are three different formulations of Frequency-Based (Spectral) Fatigue that are currently supported.

Steinberg Formulation
Steinberg Formulation utilizes all three stress occurrences (1σ, 2σ, 3σ) and their rate of occurrence along
with the Miner’s rule in order to compute the total fatigue damage of the system.

Where:

= actual number of cycles at or below the 1σ level (0.6831 ).


= actual number of cycles at or below the 2σ level (0.271 ).
= actual number of cycles at or below the 3σ level (0.0433 ).
= allowable number of cycles (from fatigue curve) at 1σ, 2σ, 3σ stress levels.

are obtained by using the S-N relation and the (1σ, 2σ, 3σ) stresses to find the corres-
ponding number of cycles. If the Bilinear curve is used, the solver chooses the appropriate curve to
interpolate on, based on the value of the stresses.

is defined as the statistical frequency which is obtained as follows:

Where:

Release 2020 R1 - © ANSYS, Inc.


1330
Fatigue Results

= RMS Velocity Result

= RMS Displacement Result

Narrow Band Formulation


Narrow Band formulation is a generalized method where the stress ranges are assumed to have a Rayleigh
distribution. The formula to calculate Fatigue damage is given by,

Where:

= Statistical frequency
t: Exposure Duration
σ: Equivalent Alternating Stress
: Gamma function.
A, m: SN curve properties from the equation NSm = A, where S = Stress Amplitude.

If we are using the Bilinear form of the SN curve, this formula changes to:

where:

and:

is the stress point of intersection of the two SN Curves.

= lower incomplete gamma function.

Wirsching Formulation
The Wirsching Formulation can be described as a correction factor to the Narrow Band Formulation in order
to account for Wideband scenarios. Instead of using a different, more complicated method for Wideband
cases, we calculate Fatigue Damage using Narrow Band formulation and simply apply the Wirsching cor-
rection factor to it, as shown:

Where is the wide band correction factor.

Release 2020 R1 - © ANSYS, Inc.


1331
Using Results

Where:

= 0.926-0.033
= 1.587 - 2.323
= Bandwidth Factor

= Irregularity Factor
= Spectral Moments

is the fatigue strength exponent obtained from the Linear SN Curve.

Since Wirsching does not have a specialized formula for the Bilinear SN Curve, the average of the
two fatigue strength exponents (m and r) is used in the Bilinear case.

Fatigue Analysis Application


After you have defined the stress-life or strain-life curves for all materials in your model, you can choose
your fatigue options and run the fatigue analysis.

The Fatigue Tool option is available from the Tools menu on the Solution Context Toolbar (p. 84)
or through the right-click context menu.

Worksheet View
The Worksheet displays by default when you insert the Fatigue Tool during a Static Structural or Har-
monic Response analysis. It displays default data, in graph form, based on the property settings of the
object. The display changes as you make changes to the associated properties. In addition, this graph-
ical Worksheet display is available for the options of the Graph Results menu. See the Fatigue Tool
(Group) (p. 1692) object reference page for additional information.

Property Definition
Once inserted into the tree, based on your analysis type, define the Details View properties as described
below:

• Fatigue Strength Factor (Kf ) (p. 1333)

• Loading Type (p. 1333)

• Scale Factor (p. 1334)

• Analysis Type (p. 1334)

• Mean Stress Theory (p. 1334)

• Method Selection (p. 1334) (Random Vibration analysis only)

• Stress Component (p. 1334)

• Exposure Duration (p. 1335) (Random Vibration and Harmonic Response analyses only)

• Frequency Selection (p. 1335) (Harmonic Response analysis only)

• Frequency (p. 1335) (Harmonic Response analysis only)

Release 2020 R1 - © ANSYS, Inc.


1332
Fatigue Results

• Sweep Rate (p. 1335) (Harmonic Response analysis only)

• Units Name (p. 1335)

• 1 “Unit” is Equal To (p. 1336)

• Bin Size (p. 1336)

• Use Quick Rainflow Counting (p. 1336)

• Infinite Life (p. 1336)

• Maximum Data Points To Plot (p. 1336)

Fatigue Strength Factor (Kf)


This property defines the fatigue strength reduction factor. This setting enables you to adjust the stress-
life or strain-life curve(s) by a specified factor while the fatigue analysis is running. The default value is
1. You set the property by making an entry or you can use the slider feature associated with the property.
The slider represents the entry range from minimum (0.01) to maximum (1). You use this property to
account for a "real world" environment that may be harsher than a rigidly-controlled laboratory envir-
onment in which the data was collected. Common fatigue strength reduction factors to account for
such things as surface finish can be found in design handbooks.

Loading Type
The options of the Type property are described below. Their availability is based upon your analysis
type.

• Zero-Based (r=0)

• Fully Reversed (r=-1)

• Ratio

• History Data

• Non-proportional Loading (available only for stress-life applications)

The Zero-Based (r=0), Fully Reversed (r=-1), and Ratio options are all constant amplitude, proportional
loading types and are graphically illustrated in the Worksheet.

The History Data option enables you to import a file containing the data points. This option is a non-
constant amplitude proportional loading type. This data is depicted in a graph on the Worksheet. You
can specify the number of data points this graph will display using the Maximum Data Points To Plot
(p. 1336) property in the Options category.

The Non-proportional Loading option is a non-proportional constant amplitude loading type for
models that alternate between two different stress states (for example, between bending and torsional
loading). Problems such as an alternating stress imposed on a static stress can be modeled with this
feature. Non-proportional loading is only supported for Fatigue Tool objects in a Solution Combination
(p. 1370) where exactly two environments are selected.

Release 2020 R1 - © ANSYS, Inc.


1333
Using Results

Scale Factor
This setting scales the load magnitude. For example, if you set this to 3, the amplitude (and mean) of
a zero-based loading will be 1.5 times the stress in the body. The graph in the Worksheet window updates
to reflect this setting. This option is useful to see the effects of different finite element loading magnitudes
without the need to repeatedly run the complete structural analysis. Note that this scale factor is applied
after the stresses have been collapsed from a tensor into a scalar. Therefore, any multiaxial stress collapse
methods that are sensitive to the sign (Von-Mises, Maximum Shear, Maximum Principal) may not give
the same answer had the scale factor been applied to the environment load itself.

This setting scales the load magnitude. For example, if you set this to 3, the amplitude (and mean) of
a zero-based loading will be 1.5 times the stress in the body. The graph in the Worksheet window will
update to reflect this setting. This option is useful to see the effects of different finite element loading
magnitudes without having to run the complete structural analysis repeatedly. Note that this scale
factor is applied after the stresses have been collapsed from a tensor into a scalar. Thus any multiaxial
stress collapse methods that are sensitive to the sign (Von-Mises, Maximum Shear, Maximum Principal)
may not give the same answer had the scale factor been applied to the environment load itself.

Analysis Type
Define the fatigue analysis as either Stress Life or Strain Life.

Mean Stress Theory


This setting specifies how the mean stress effects should be handled.

• If Analysis Type is set to Stress Life, choose from None (default), Goodman, Soderberg, Gerber, and Mean
Stress Curves. The Goodman, Soderberg, and Gerber options use static material properties along with S-
N data to account for any mean stress while Mean Stress Curves use experimental fatigue data to account
for mean stress. You can specify the default setting for this property using the Mechanical application Fatigue
settings (p. 110) in the Options dialog box (p. 105).

• If Analysis Type is set to Strain Life, choose from None, Morrow, and SWT (Smith-Watson-Topper).

Note

A sample plot of each of these theories is shown at the bottom of the Worksheet view. This
plot does not use live data, but is rather a generic representation of each theory. For more
information on these theories, see "Metal Fatigue In Engineering" by Ralph I. Stephens, et.
al.

Method Selection
This property is only available for Random Vibration analyses. The options include: Narrow Band,
Steinberg (default), and Wirsching. This setting specifies the method to calculate the Probability Density
Function (PDF) from the available PSD stress response.

Stress Component
Because stresses are multiaxial but experimental fatigue data is usually uniaxial, the stress must be
converted from a multiaxial stress state to a uniaxial one. A value of 2 times the maximum shear stress
is used. You can choose from several types, including component stresses, von Mises, and a signed von

Release 2020 R1 - © ANSYS, Inc.


1334
Fatigue Results

Mises, which takes the sign of the absolute maximum principal stress. The signed von Mises is useful
for accounting for any compressive mean stresses.

Exposure Duration
This property is only available for Random Vibration and Harmonic Response analyses. It specifies the
duration (in time) the loading is applied. The resulting damage is for this entire duration. The default
setting is one second (1). This means that the calculated damage is based on damage per second.

In a Harmonic Response analysis, the number of cycles is internally calculated as the Exposure Duration
multiplied by the chosen frequency.

Frequency Selection
This property is only available for Harmonic Response analyses. You use this property to select a analysis.
Options include:

• Single Frequency (default): This option specifies that only the stress at the defined Frequency is con-
sidered for the fatigue analysis.

• Multiple Frequencies: This option enables you to manually specify frequency values and their corres-
ponding Exposure Durations in the Tabular Data window. Stresses at each of these distinct frequencies
are considered for the fatigue analysis and fatigue damage is accumulated.

• Sine Sweep: This option enables you to manually specify frequency values and their corresponding
Scale Factors in the Tabular Data window. A Sine Sweep analysis is performed from the lowest to
highest frequency value in steps of 0.5 Hz using the Sweep Rate and the appropriate amplitude scaling
at each step. The fatigue damage is accumulated.

Frequency
This property is only available for Harmonic Response analysis. It specifies the frequency (in Hz) for
which the stress response is calculated and used for the fatigue analysis. The phase angle for which the
maximum stress occurs is automatically chosen for a chosen frequency.

Sweep Rate
The Sweep Rate property is only available for Harmonic Response analysis. It is only available when the
Sine Sweep option is selected for the Frequency Selection property. This property specifies the rate of
frequency sweep in Hz/s units.

Units Name
This property enables you to specify the name for the Life Units. The unit options include:

• cycles • hours

• blocks • days

• seconds • months

• minutes • User Defined

Release 2020 R1 - © ANSYS, Inc.


1335
Using Results

User Defined

Selecting the User Defined option displays the Custom Units Name field. Enter the name for your
customized unit name in this field. The specified unit is reflected in the Details view for all applicable
fatigue settings.

1 “Unit” is Equal To
Where "unit" is either cycle or block based on the Units Name selection. Modify the field’s value based
on the desired number of cycles or blocks for the units.

Bin Size
This option appears only if Type is set to History Data (non-constant amplitude loading). This setting
defines how many divisions the cycle counting history should be organized into for the history data
loading type. Strictly speaking, this is number specifies the dimensions of the rainflow matrix. A larger
bin size has greater precision but will take longer to solve and use more memory.

Use Quick Rainflow Counting


This option appears only if Type is set to History Data (non-constant amplitude loading). Since rainflow
counting is used, using a “quick counting” technique substantially reduces runtime and memory, espe-
cially for long time histories. In quick counting, alternating and mean stresses are sorted into bins before
partial damage is calculated. This means that with quick counting active, calculations will be performed
for maximum of binsize. Thus the accuracy will be dictated by the number of bins. Without quick
counting, the data is not sorted into bins until after partial damages are found and thus the number
of bins will not affect the results. The accuracy of quick counting is usually very good if a proper number
of bins are used when counting. To see the effects of using quick counting, compare the results of
constant amplitude loading to simulated constant amplitude loading from a load history file. With quick
counting off, the result should match exactly but with quick counting on, there will be some error de-
pending on the bin size and alternating stress value in relation to the midpoint of the bin the count is
sorted into.

Infinite Life
Stress Life Analysis

This option appears only if Type is set to History Data (non-constant amplitude loading) and defines
what life will be used if the stress amplitude is lower than the lowest stress on the SN curve. It may be
important in how damaging small stress amplitudes from the rainflow matrix are.

Strain Life Analysis

Since the strain-life method is equation based it has no built-in limit, unlike stress-life for which the
Fatigue Tool uses a maximum life equal to the last point on the SN curve. Thus to avoid skewed contour
plots showing very high lives, you can specify Infinite Life in a strain-life analysis. For example, if you
set a value of 1e9 cycles as the Infinite Life, the maximum life reported is 1e9.

Maximum Data Points To Plot


This option is only applicable for History Data loading and allows you to specify the number of data
points to display in the corresponding graph that appears in the Worksheet. The default value is 5000
points. The graph displays the full range of points and all points are used in the analysis. However, de-

Release 2020 R1 - © ANSYS, Inc.


1336
Fatigue Results

pending on the value you set, every second or third point may not be displayed in the interest of
avoiding clutter and making the graph more readable.

Fatigue Results
After you have included the Fatigue Tool in your analysis, you can then choose from among several
results options. Any of these results can be scoped (p. 919) to individual parts or faces if desired. To select
the fatigue solution items, you must be under a Solution object. Click Fatigue Tool either on the
toolbar or via a right-mouse click and select any of the following options:

• Life (p. 1337)

• Damage (p. 1337)

• Safety Factor (p. 1337)

• Biaxiality Indication (p. 1338)

• Equivalent Alternating Stress (p. 1338)

• Rainflow Matrix (History Data only) (p. 1338)

• Damage Matrix (History Data only) (p. 1338)

• Fatigue Sensitivity (p. 1339)

• Hysteresis (p. 1340)

Life
This result contour plot shows the available life for the given fatigue analysis. If loading is of constant
amplitude, this represents the number of cycles until the part will fail due to fatigue. If loading is non-
constant, this represents the number of loading blocks until failure. Thus if the given load history rep-
resents one month of loading and the life was found to be 120, the expected model life would be 120
months.

In a constant amplitude analysis, if the alternating stress is lower than the lowest alternating stress
defined in the S-N curve, the life at that point will be used.

Damage
Fatigue damage is defined as the design life divided by the available life. The default design life may
be set through the Options dialog box (p. 105). A damage of greater than 1 indicates the part will fail
from fatigue before the design life is reached.

Safety Factor
This result is a contour plot of the factor of safety (FS) with respect to a fatigue failure at a given design
life. The maximum FS reported is 15.

Release 2020 R1 - © ANSYS, Inc.


1337
Using Results

Biaxiality Indication
This result is a stress biaxiality contour plot over the model that gives a qualitative measure of the stress
state throughout the body. A biaxiality of 0 corresponds to uniaxial stress, a value of -1 corresponds to
pure shear, and a value of 1 corresponds to a pure biaxial state.

For Non-proportional loading, you can choose between average biaxiality and standard deviation of
biaxiality in the Details view.

Equivalent Alternating Stress


The Equivalent Alternating Stress contour queries the S-N curve. This result is not valid if the loading
has non-constant amplitude, (i.e., Loading Type = History Data). The result is useful for cases where
the design criterion is based on the equivalent alternating stress that you specify.

Important

If you specify a Mean Stress Theory and static failure is predicted, the reported equival-
ent alternating stress is reported as 1e32 Pa (this value is always reported when there
is static failure).

Rainflow Matrix (History Data only)


This graph depicts how many cycle counts each bin contains. This is reported at the point in the specified
scope with the greatest damage.

The Navigational Control at the bottom right-hand corner of the graph can be used to zoom and pan
the graph. You can use the double-sided arrow at any corner of the control to zoom in or out. When
you place the mouse in the center of the Navigational Control, you can drag the four-sided arrow to
move the chart points within the chart.

Damage Matrix (History Data only)


Similar to the rainflow matrix, this graph depicts how much relative damage each bin has caused. This
result can give you information related to the accumulation of the total damage (such as if the damage
occurred though many small stress reversals or several large ones).

Release 2020 R1 - © ANSYS, Inc.


1338
Fatigue Results

The Navigational Control at the bottom right hand corner of the graph can be used to zoom and pan
the graph. You can use the double-sided arrow at any corner of the control to zoom in or out. When
you place the mouse in the center of the Navigational Control, you can drag the four-sided arrow to
move the chart points within the chart.

Fatigue Sensitivity
This plot shows how the fatigue results change as a function of the loading at the critical location on
the scoped region. Sensitivity may be found for life, damage, or factory of safety. For instance, if you
set the lower and upper fatigue sensitivity limits to 50% and 150% respectively, and your scale factor
to 3, this result will plot the data points along a scale ranging from a 1.5 to a 4.5 scale factor. You can
specify the number of fill points in the curve, as well as choose from several chart viewing options (such
as linear or log-log).

The Navigational Control at the bottom right hand corner of the graph can be used to zoom and pan
the graph. You can use the double-sided arrow at any corner of the control to zoom in or out. When
you place the mouse in the center of the Navigational Control, you can drag the four-sided arrow to
move the chart points within the chart.

To specify a result item, you must be under a Solution object.

Release 2020 R1 - © ANSYS, Inc.


1339
Using Results

Hysteresis
In a strain-life fatigue analysis, although the finite element response may be linear, the local elastic/plastic
response may not be linear. The Neuber correction is used to determine the local elastic/plastic response
given a linear elastic input. Repeated loading will form close hysteresis loops as a result of this nonlinear
local response. In a constant amplitude analysis a single hysteresis loop is created although numerous
loops may be created via rainflow counting in a non-constant amplitude analysis. The Hysteresis result
plots the local elastic-plastic response at the critical location of the scoped result (the Hysteresis result
can be scoped, similar to all result items). Hysteresis is a good result to help you understand the true
local response that may not be easy to infer. Notice in the example below, that although the load-
ing/elastic result is tensile, the local response does venture into the compressive region.

Loading/Elastic Response:

Corresponding Local Elastic Plastic Response at Critical Location:

User Defined Results


This section examines the purpose, operation, and use of the User Defined Result feature of Mechan-
ical.
Overview
Characteristics
Application
Node-Based Scoping
User Defined Result Expressions
User Defined Result Identifier

Release 2020 R1 - © ANSYS, Inc.


1340
User Defined Results

Unit Description
User Defined Results for the Mechanical APDL Solver

Overview
The User Defined Result feature allows you to derive user defined result values by performing math-
ematical operations on results obtained following a solution.

Mechanical can generate user defined results, based on the analysis type. The user defined results can
be derived from any number of fundamental results stored on the result file. You display these results
using the Solution Worksheet (p. 48). Using this feature, most of the results stored in the result file
display in the worksheet as illustrated in this example.

Refer to the following sections for descriptions of user defined result entries in the worksheet:

• User Defined Results for the Mechanical APDL Solver (p. 1350)

• User Defined Results for Explicit Dynamics Analyses

Characteristics
General:

• All analysis types and solver targets can produce User Defined Results. A User Defined Result may be unique
to a particular solver and analysis. After clicking on the Solution object, you must click the Worksheet to
produce the complete listing of the results that are applicable to the analysis type and solver being used.

• All result types can be combined except for results which have different dimensions. For example, displace-
ment vectors, which contain 3 items, cannot be added to stress tensors, which contain 6 items.

• User Defined Results which are elemental (such as stress or strain results) can be displayed as averaged or
unaveraged results (p. 1200). It takes Mechanical longer to display a result which is not averaged.

Like most result types that display using contours, user defined results:

• Are scoped to a geometry (vertex, edge, face, body), named selection (geometry, node-based, or element-
based), path, or surface. However, you cannot scope user defined results based on Contacts to a path or
surface.

• Require a set, time, and frequency/phase, to be fully specified (depending on the analysis type).

• Requires the selection of Response Type (Displacement/Velocity/Acceleration/Other Result) option for


Random Vibration and Response Spectrum analysis types.

Release 2020 R1 - © ANSYS, Inc.


1341
Using Results

• In a Random Vibration Analysis, you need to select a Scale Factor to get a result corresponding to the
Probability (read-only).

• Display minimum/maximum values and a Graph.

• Display nodal averaged data.

• Can be added to a Chart (p. 1162)

• Can be examined using probe annotations, slice planes, isosurface, etc.

• Can be cleared.

• Can be duplicated.

Unlike other contour results, user defined results:

• Can have a variable unit category assigned to its contour.

• Become obsolete if a user defined result is dependent upon another user defined result that has been
modified, cleared, or deleted. In this instance, the graphic of the geometry displays without results.

• User defined results cannot employ Probes.

• User defined results cannot link to multiple environments and cannot employ the Solution Combination
feature.

Application
Apply a User Defined Result using one of the following methods:

• Select the User Defined Result toolbar button.

• Right-click the Solution (p. 1817) object and the select the User Defined Result option.

• Display the Solution Worksheet (p. 48) following a Solve, right-click the mouse on the desired row of the
table, and then select Create User Defined Result.

Until you become familiar with this feature, it is recommended that you insert user defined results using
the worksheet. This makes sure that results are valid and applicable for the particular analysis type and
solver being used. As illustrated below, right-clicking the mouse on a row of the worksheet displays an
option to create a user defined result.

Release 2020 R1 - © ANSYS, Inc.


1342
User Defined Results

Note

NMISCxxx and SMISCxxx results are not displayed in the worksheet and can only be accessed
by typing in the keyword directly. See User Defined Results for the Mechanical APDL Solv-
er (p. 1350) for details.

Selecting this option places a User Defined Result object for the specified result in the tree as a child
of the Solution object, as shown in the example below. Compared to the other two methods for inserting
a User Defined Result, this technique automatically completes field data in the Details view. Note that
the new result object’s name appears in the Expression (p. 1345) field of the Details view. Except for an
Identifier (p. 1348), all remaining details are also automatically generated based on the information
provided by the result type, such as Input Unit System (U.S. Custom) and Output Unit (Displacement).

If you create a user defined result and do not use the worksheet as the origin, you need to manually
enter an Expression and also define the Output Unit. These fields display with a yellow highlight to
indicate the required entries. See the User Defined Result Expressions (p. 1345) and Unit Description (p. 1350)
sections for more information.

Release 2020 R1 - © ANSYS, Inc.


1343
Using Results

Once a user defined result is created, the advantage of the feature is your ability to further define ex-
pressions using mathematical operators. For example, you can enter the mathematical combination
UX+UY in the Expression (p. 1345) field and then retrieve a new result.

Node-Based Scoping
In regard to usage, suppose two user defined results (with identifiers A and B, respectively) are scoped
to ScopeA and ScopeB. The algorithm to draw the contours for C = A + B (scoped to ScopeC) proceeds
as follows:

• The results A and B are combined on all common bodies (determined from ScopeA and ScopeB and
referred to as CommonBodies).

Release 2020 R1 - © ANSYS, Inc.


1344
User Defined Results

• The scope (ScopeC) of the newly defined result C is then employed: the contours of C are drawn on
the intersection of ScopeC and CommonBodies.

Note, each of ScopeA, ScopeB, and ScopeC can be any set of geometric entities: vertices, edges, faces,
bodies, or named selections (consisting of geometric entities or even nodes in the mesh).

Example 8: Nodal Scoping

Assumptions: A is scoped to bodies 1 and 2 and B is scoped to two faces, one in body 2 and one in
body 3. The combination C = A+B is scoped to two vertices, one in body 2, and the other in body 3.

Result: A+B will be computed on nodes common to the underlying bodies of A and B; these nodes will
exist only in body 2. Then the combination C = A + B will be displayed only on the vertex belonging
to body 2 (the one belonging to body 3 is not in the intersection of the two original scoping bodies).

User Defined Result Expressions


The term “expression” has more than one use when defining user defined results. An expression is:

• Primarily, the combination of mathematical values, based on syntax rules (p. 1346) and the available math
operations (p. 1347).

• A column displayed on the Solution Worksheet that indicates the result type.

• An entry field in the Details view of a user defined result where you enter mathematical values, such as
UX+UY+UZ.

Note

You can use user defined result expressions across multiple combinations of environments
with limited functionality by using a Design Assessment (p. 1491) system. However, you can
not use it within standard Solution Combinations.

The example of the Solution Worksheet shown below highlights the Expression column.

When a User Defined Result is applied (p. 1342), the content of the above column populates the Expres-
sion field of the user defined result's Detail View. In this case, UX.

Release 2020 R1 - © ANSYS, Inc.


1345
Using Results

The content of the Expression field can be modified using mathematical operators to further define
the expression. As shown below, you can combine the X, Y, and Z components and then retrieve a new
customized result.

Expression Syntax
Expressions support the following syntax:

• Operands: ( ‘+’, ‘-‘,’*’, ‘/’, ‘^’, ‘**’)

• Functions: (sqrt(), min()…) - always use lower case

• Numbers: (scalar quantities such as 1.0, 25, -314.23, or 2.5e12)

Release 2020 R1 - © ANSYS, Inc.


1346
User Defined Results

• Identifiers (p. 1348): unique user defined names

Supported Mathematical Operations


The following is a list of the mathematical operations currently supported for user defined results. The
shorthand notation "s" defines a single-valued quantity (constant values such as 1.34) and "a" defines
an array. An array is distinguished by its dimension which includes the length, based on the number
of rows (that is, number of nodes or elements), and the width, consisting of 1, 3, or 6 columns depending
on the type of result stored.

• Addition (+): s1+s2, a1+a2, a+s (s+a is not supported)

• Subtraction (-): s1-s2, a1-a2, a-s

• Multiplication (*): s1*s2, a1*a2, a*s, s*a

• Division (/): s1/s2, a1/a2, a/s

• Power of (^ or **): s1^s2, a1^a2, a^s, s^a, (undefined if s1 = 0 and s2 < 0 or if s1<0 and s2 is a non-integer).
The characters "**" perform the same action as the caret symbol (^) and you can use them interchangeably.

• Log base ten (log10): log10(s), log10(a), (s and a > 0.0)

• Square root (sqrt): sqrt(s), sqrt(a), (s and a should be >= 0.0)

• Dot product (dot): dot(a1,a2) (results in a single-column array consisting of the inner products, one for each
row of a1 and a2; thus, a1, a2 should have the same dimensions)

• Cross product (cross): cross(a1,a2) (a1, a2 must have 3 columns)

• Add Comp (addcomp): addcomp(uvectors) = ux + uy + uz (If the argument uvectors has 3 columns, they
are added to produce a single-column array. If the argument is a single-column array, the result will be a
scalar summing all the array entries.)

• Maximum (max): s = max(s1,s2), a = max(a1,a2)

• Minimum (min): s = min(s1,s2), a = min(a1,a2)

• Absolute Value (abs): s = abs(s1), a=abs(a1)

• Trigonometric Functions (sin, cos, tan): sin(s), cos(s), tan(s), sin(a), cos(a), tan(a) (s and a are both in radians)

• Inverse Trigonometric Functions (asin, acos, atan): asin(s), acos(s), atan(s), asin(a), acos(a), atan(a) (return
values are in radians; where -1 <= s <= 1 and -1 <= a <=1 for asin and acos)

• atan2: atan2(s1,s2), atan2(a1,a2) (return values are in radians; calculates the arctangent of s1/s2 or a1/a2
and uses the sign of the arguments to determine the quadrant of the returned angle)

Note

• The current expression list does not allow input parameters from the Parameter Workspace. Only
output parameters are allowed for Min and Max values of a user defined result.

• All operations involving two vector arrays must have the same dimensionality.

Release 2020 R1 - © ANSYS, Inc.


1347
Using Results

• Any result whose expression contains the addcomp function needs to be scoped to exactly one
body.

• You cannot perform mathematical operations directly within the Design Assessment system.
However, the Design Assessment system provides the ability to use python scripts to combine
results from various environment using highly complex, user defined mathematical functions.

User Defined Result Identifier


Each user defined result you create can be assigned a unique name using the Identifier field in the
Details view as illustrated below.

User defined identifiers:

• Can begin with a letter or an underscore character.

• Can contain any number of letters, digits, or underscores.

• Are not case insensitive - however, functions (p. 1347) should always use lowercase (sqrt, max, min, etc.).

Release 2020 R1 - © ANSYS, Inc.


1348
User Defined Results

• Are not affected by the order in which they are entered. For example, for Identifiers A and B, the expression
for:

– User defined Result 1 can equal: B = 2*A, and:

– User Defined Result 2 can equal: A = UX

It is recommend that you use the proper order and try to define dependents first. For example, define
A, B, C and then D = A^2+B^2+C^2

• Cyclic dependencies are blocked, such as the following:

– User Defined Result 1: A = UX + C

– User Defined Result 2: C = 2 * A - 1

• Correspond to an array over all nodes (or all elements):

– Length = number of nodes (or elements)

– Width = 1, 3, or 6 columns

An Identifier, together with Expression content (UX, UY, etc.), can be used in combination with other
user defined results. For example, using the Identifier MyResult, you could create the Expression:
sqrt(MyResult+UX+UY). In addition, if an Identifier is used in an expression, it must be scoped to
the same geometry.

It is recommended that when you assign an identifier to the expression of a user defined result, that
you rename the tree object with the same name/identifier.

Limitations of the User Defined Result Identifier


There are several problematic scenarios that can arise when you use the Identifier of an existing user
defined result to create a new user defined result. For each scenario, changing an item in the Details
view of the new result causes the new result to be unreliable.

For example, the Display Time of a User Defined Result is only relevant when the expression consists
of built-in identifiers. Unlike user defined identifiers, built-in identifiers retain their time dependence
through the evaluation of the expression. To reveal the built-in identifiers for a given solver, examine
the Worksheet view on the Solution folder.

Note that Mechanical may not necessarily issue a warning or error message for these situations.

Suppose the Identifier of the original result is "Original". Further, suppose that the Expression of the
new result is "2 * Original". Consider the following scenarios:

• Different choices of By Time or By Result Set

• Different choices of the value of Display Time or Set

• Different choices of Coordinate System

• Different choices of Yes/No for Calculate Time History

• Different choices for Use Average

Release 2020 R1 - © ANSYS, Inc.


1349
Using Results

Unit Description
The units of a user defined result are defined by the following Detail view settings:

• Input Unit System: A read-only field that displays the active Mechanical application unit system. To evaluate
an expression, a user defined result's units must be converted to the Input Unit System. As a result, the ex-
pression is most easily verified when the intervening data is viewed in the Input Unit System.

• Output Unit: The physical dimension assigned to a user defined result. It determines which factors are used
to convert the result from its Input Unit System to the current unit system selection. A large list of unit
types is available. Because you can assign such a wide variety of unit types to a result, it is recommended
that you choose carefully and be consistent.

Units are defined in a two step process.

1. Before you evaluate an expression, the units are converted to the Input Unit System.

2. Once evaluated, values are converted from the input system to the active Mechanical application unit
system using the appropriate factor.

For example, given the following user defined result expressions with MKS (m, kg, N, ºC, s, V, A) units:

• FORCE_MKS=FSUM

• STRESS_MKS=SEQV

• DISP_MKS=USUM

If you change the unit system to CGS (cm, g, dyne, ºC, s, V, A) and create a new user defined result with
Expression =FSUM+SEQV+USUM while assigning Volume as the Output Unit, you will produce the
following user-defined results:

Custom Identifier Expression Input Unit System Output Units


FORCE_MKS FSUM Metric (m, kg, N, s, V, A) Force
STRESS_MKS SEQV Metric (m, kg, N, s, V, A) Stress
DISPL_MKS USUM Metric (m, kg, N, s, V, A) Displacement
VOLUME_CGS FSUM+SEQV+USUM Metric (cm, g, dyne, s, V, A) Volume

The expression VOLUME_CGS is easy to verify for its Input Unit System, CGS. If FSUM=3 dyne, SEQV=17
dyne/cm² and USUM=2 cm, (as seen in when CGS is selected in the Mechanical application),
VOLUME_CGS produces the value 22 cm³. Any subsequent changes to the unit system in the Mechan-
ical application cause each of the user defined results to convert based on their required factors. In this
manner, VOLUME_CGS will use a factor of 1000 to convert from Metric CGS to Metric mm, because it
represents a Volume. FORCE_MKS, STRESS_MKS and DISPL_MKS will convert differently, based on the
selected Output Units.

User Defined Results for the Mechanical APDL Solver


Refer to the PRNSOL and PRESOL command pages in the Mechanical APDL application Commands
Reference for descriptions of most Component and Expression entries in the table. Some other entries
are self-explanatory (SUM for example). VECTORS refer to vector plot (p. 1185) results that include arrows
in the display.

Release 2020 R1 - © ANSYS, Inc.


1350
User Defined Results

The following tables include descriptions of additional user defined result names not included in the
PRESOL/PRNSOL listings. The Solution object Worksheet lists these result options following a solution
(see Application (p. 1342)).

Node-Based Results
The following table lists the available expressions that you can use to define your User Defined Result.
Node-based user defined results are most often associated with degree of freedom solutions (like
nodal reactions).

Name Description
R Nodal rotations in a structural analysis (analogous to PRNS,ROT)
OMG Nodal rotational velocities in a structural transient dynamic analysis (analogous to PRNS,OMG)
DOMG Nodal rotational accelerations in a structural transient dynamic analysis (analogous to
PRNS,DMG)
MVP_AZ Nodal Z magnetic vector potential in an axisymmetric electromagnetic analysis (analogous to
PRNS,A)
LOC Nodal locations (x,y,z)
LOC_DEF Deformed nodal locations (x+ux,y+uy,z+uz)
F Nodal structural forces (reaction)1
M Nodal structural moments (reaction)1
CSG Nodal magnetic current segments (reaction)
HEAT Nodal thermal heat flow (reaction)
AMPS Nodal electric current (reaction)
NDIR Nodal THXY, THYZ, and THZX values. The NDIRVECTORS display consists of triads.
REULER Structural rotations displayed as Euler triads.

1 - When user defined results FX, FY, FZ, FSUM, and FVECTORS (and MX, MY, MZ, MSUM, and MVECTORS)
are scoped to a path, then it is possible that no contours will be displayed. The reason is that these
types of forces/moments are solved only at constrained nodes. The result value at a path point is inter-
polated from the nodal values of the elements that contain the path point. If a path point touches an
element in which some nodes have undefined reactions, then Mechanical cannot properly interpolate
the nodal values for the path point. No contour color is displayed at such a path point.

Element-Based Results
The following table lists the available expressions that you can use to define your element-based User
Defined Result. Element-based user defined results can exist at the nodes (like stress and strain) or can
exist at the centroid (like volume).

Name Description
SPSD Element nodal equivalent stress as calculated by the solver.
ELEMENTAL_REAL
Element real data from the Mechanical APDL R command.
EPCREQV_RST Element nodal equivalent creep strain as calculated by the solver.
EPELEQV_RST Element nodal equivalent elastic strain as calculated by the solver.
EPPLEQV_RST Element nodal equivalent plastic strain as calculated by the solver.

Release 2020 R1 - © ANSYS, Inc.


1351
Using Results

Name Description
EPTTEQV_RST Element nodal equivalent total strain (plus thermal strain) as calculated by the solver, that
is, EPTTEQV_RST is total mechanical and thermal strain: EPTTEQV_RST = EPELEQV_RST +
EPPLEQV_RST + EPCREQV_RST + EPTHEQV_RST.
EPTOEQV_RST Element nodal equivalent total strain as calculated by the solver, that is, EPTOEQV_RST is
total mechanical strain: EPTOEQV_RST = EPELEQV_RST + EPPLEQV_RST + EPCREQV_RST.
ETOP Element nodal densities used for topological optimization (same as TOPO).
BEAM Element nodal beam stresses: direct, minimum bending, maximum bending, minimum
combined, maximum combined.
SVAR Element nodal state variable data.
CONTJHEA Element nodal Joule heat for CONTA174.
CONTFORC Element nodal contact normal forces for CONTA175.
BEAM_AXIAL_FElement nodal axial force vectors for BEAM188/189.
BEAM_BENDING_M
Element nodal bending moment vectors for BEAM188/189.
BEAM_TORSION_M
Element nodal torsion moment vectors for BEAM188/189.
BEAM_SHEAR_F
Element nodal shear force vectors for BEAM188/189.
PIPE_INTERNAL_PRESSURE
Internal pressure at integration point for PIPE288.
PIPE_EXTERNAL_PRESSURE
External pressure at integration point for PIPE288.
PIPE_EFFECTIVEffective
_TENSION tension at integration point for PIPE288.
PIPE_HOOP_STRESS
Maximum Hoop Stress at integration point for PIPE288/PIPE289.
ENFO Element nodal reaction forces for structural analyses.
ENMO Element nodal reaction moments for structural analyses.
EHEAT Element nodal heat values for thermal analyses.
CURRENTSEG Element nodal magnetic current segments.
VOLUME Element volumes.
ENERGY Element potential and kinetic energies.
RIGID_ANG Element Euler angles for MASS21 elements (rotation about x-axis, rotation about y-axis,
rotation about z-axis).
CONTSMISC Element summable miscellaneous data for contact elements. CONTSMISC is completely
analogous in implementation to SMISC (see “User Defined Results Not Displayed in
Worksheet” below), except that CONTSMISC, for display purposes, extrapolates the single
elemental value to the corner nodes.
CONTNMISC Element non-summable miscellaneous data for contact elements. CONTNMISC is completely
analogous in implementation to NMISC (see “User Defined Results Not Displayed in
Worksheet” below), except that CONTSMISC, for display purposes, extrapolates the single
elemental value to the corner nodes.
EDIR Elemental THXY, THYZ, and THZX values: (1) currently only angles of first node in solution
record are employed; (2) the EDIRVECTORS display consists of triads.
ECENT Element centroids (x,y,z)
PNUMTYPE Element type reference numbers.
PNUMREAL Real constant set numbers.
PNUMMAT Material set numbers.

Release 2020 R1 - © ANSYS, Inc.


1352
User Defined Results

Name Description
PNUMSEC Section numbers.
PNUMESYS Element coordinate system numbers (note: a 0 value corresponds to the global Cartesian
system).
PNUMELEM Mechanical APDL element ID.
PNUMENAM Mechanical APDL element identifying number (such as 181 for SHELL181 elements).
CONTPNUMTYPE
Element type reference numbers for contact elements.
CONTPNUMREAL
Real constant set numbers for contact elements.
CONTPNUMMAT
Material set numbers for contact elements.
CONTPNUMSECSection numbers for contact elements.
CONTPNUMESYS
Element coordinate system numbers for contact elements.
CONTPNUMELEM
Mechanical APDL Element ID for contact elements.
CONTPNUMENAM
Mechanical APDL element identifying number for contact elements.
SMISC Element summable miscellaneous data.
NMISC Element non-summable miscellaneous data.
EFFNU_ZERO_ EPTOEQV
lement nodal equivalent total strain (EPEL + EPPL + EPCR) as calculated by the
post-processor.

For average results, the solver averages the element nodal component strains at
common nodes and performs a Von Mises calculation with effective Poisson's Ratio
set to ZERO.
EFFNU_ZERO_ EPTTEQV
lement nodal equivalent total strain plus thermal strain (EPEL + EPPL + EPCR + EPTH)
as calculated by the post-processor.

For average results, the solver averages the element nodal component strains at
common nodes and performs a Von Mises calculation with effective Poisson's Ratio
set to ZERO.
LAYNUMBER Number of layers, as defined by the section database, for a shell element. If no section
database exists, the number of layers is displayed as zero.
LAYTHICK Thickness of a layer, as defined by the section database, for a shell element. The layer
number is specified using the Layer property. If the Layer property is set to Entire
Section, the thickness of the entire element is displayed.
LAYMATERIAL Material number for an element, displayed in a manner similar to Mechanical APDL's
graphic for /PNUM,MAT,1. If a shell element contains layers defined by the section
database and if the Layer property is set to a layer number greater than 0, then the
material number for the layer is displayed.
LAYANGLE Angle of a layer's coordinate system with respect to the element coordinate system,
as defined by the section database, for a shell element. The layer number is specified
by the Layer property. If the Layer property is set to Entire Section, a value of zero
is displayed.
LAYOFFY Section offset in the Y direction, as defined by the section database, for a shell element.
The Y offset is the same for all layers.
THERMAL_FLUID_HT_COND_RATE
Rate of fluid flow through a specified Line Body (p. 498).
THERMAL_FLUID_FLOW_RATE
Heat flow rate due to conduction within the fluid of a Line Body.
MESH_ELEMENT_QUALITY
Composite quality of meshed elements.

Release 2020 R1 - © ANSYS, Inc.


1353
Using Results

Name Description
MESH_ASPECT_RATIO
Aspect ratio for triangles and quadrilaterals of meshed elements.
MESH_JACOBIAN_RATIO
Jacobian Ratio of meshed elements.
MESH_WARPING_FACTOR
Warping Factor of meshed elements.
MESH_PARALLEL_DEVIATION
Parallel Deviation of meshed elements.
MESH_MAXIMUM_CORNER_ANGLE
Maximum Corner Angle of meshed elements.
MESH_SKEWNESS
Skewness of meshed elements.

Note

The section database is created by the Mechanical APDL SECDATA command.

Using this data, you can explicitly define your user defined result, such as total deformation by using
the component deformations across all of the nodes in the model, identified by UX, UY, and UZ. You
can use these component values to mathematically produce a user defined result for total deformation:
SQRT(UX^2+UY^2+UZ^2).

Notes

For complete descriptions of the mesh-based element results listed above, see the Mesh Metric section
in the Meshing User's Guide.

If the Display Option is set to Averaged, then for the results ENFO, EHEAT, and CURRENTSEG, the result
at each node represents the sum (or contributions) of all the elements that contain the node.

If the Display Option is set to Unveraged, the ENFO result is analogous to PLES,FORCE.

SPSD is a User Defined Result that is unique to the Mechanical APDL result file. For any element that
supports stresses, the SPSD result represents the equivalent stress, for each corner node in the element,
as stored on the result file. Hence, SPSD is the equivalent stress as calculated by the Mechanical APDL
solver for the corner nodes. For this result, SPSD is the expression displayed in the Type column and
Stress is displayed in the Output Unit column. Prior to release 13.0, SPSD represented the equivalent
stress as calculated from component stresses during postprocessing, that is, it was not calculated by
the Mechanical APDL solver.

By default, Contact Results (p. 1243) (accessible through User Defined Results (p. 1340) via CONTSTAT or
CONTFLUX) are not written to the result file in a thermal analysis.

Displays of /PNUM results are analogous to EPLOTs with the following commands in Mechanical APDL:

• /PNUM,TYPE,1

• /PNUM,REAL,1

• /PNUM,MAT,1

• /PNUM,SEC,1

• /PNUM,ESYS,1

• /PNUM,ELEM,1

Release 2020 R1 - © ANSYS, Inc.


1354
User Defined Results

For example, the range of the values of the PNUMTYPE result vary from the smallest element type to
the largest element type, as created by ANSYS ET commands.

Note

• PNUM results are available for all analysis types.

• When you are analyzing shell elements, the PNUMMAT result displays a Material Number for each
layer when the following conditions are met:

– The shell element contains layers defined by the section database (via SECDATA command).

And...

– The Layer property of the User Defined Result is set to a number greater than 0.

• Mechanical supports up to 64 SVAR results (SVAR1, ..., SVAR64). If you define more than 64 SVAR
results, the solver ignores all entries.

For non-linear analyses, user defined results corresponding to Mechanical APDL PLES commands with
NL as an Item are available with the following components:

SEPL, SRAT, HPRE, EPEQ, PSV, PLWK, CRWK, ELWK, SGYT, and PEQT

Although there are no user defined results with SEND in Mechanical, you can use the following:

Use This For This


NLPLWK PLES,SEND,PLASTIC
NLCRWK PLES,SEND,CREEP
NLELWK PLES,SEND,ELASTIC

User Defined Results Not Displayed in Worksheet


For the Mechanical APDL solver, there are User Defined Results associated with summable miscellaneous
data (SMISC) and non-summable miscellaneous data (NMISC) on the result file. These results are not
listed in the Solution Worksheet. Because this data can be voluminous, by default, Mechanical does not
write it to the result file for all element types in the model (examples of MISC records always written
to the result file include beam, joint, and spring element types). You activate miscellaneous output for
all elements or just contact elements using the Output Controls (p. 904) available in the Details of the
Analysis Settings (p. 873) object. Mechanical has adopted a convention that miscellaneous data for
contact elements be called CONTSMISC and CONTNMISC. This means that SMISC and NMISC data will
only display on non-contact elements and that CONTSMISC and CONTNMISC data will only display on
contact elements. You can also request and store state variables such as USERMAT or USERCREEP if you
wish to utilize user-defined materials. Like miscellaneous data, SMISC and NMISC, the state variables do
not display in the Solution Worksheet. You access state variables using the expression field entry SVAR
followed by the state variable number.

To display these results:

1. Click on the User Defined Result toolbar button.

Release 2020 R1 - © ANSYS, Inc.


1355
Using Results

2. In the Details view Expression field, type the string SMISC or NMISC followed by the sequence number
which indicates the desired datum.

For example, to display the 2nd sequence number for SMISC, enter SMISC2 for the Expression. The
graphics contour display will be similar to the Mechanical APDL display for the command PLESOL,SMISC,2.
When you evaluate this result, the Details view will show no units and no coordinate system for this
data. That is, no unit conversions and no coordinate transformations are performed. If you enter a data
expression that does not exist on the result file, the result will not be evaluated. To display the 2nd
sequence number for summable miscellaneous data on scoped contact elements, enter CONTSMISC2
for the Expression.

Limitations of Vector Displays


The following limitations are associated with vector display for user defined results:

• BEAM_SHEAR_FVECTORS (based upon section shear forces, SFy and SFz, in the BEAM188 SMISC record).

• BEAM_BENDING_MVECTORS (based upon the bending moments, My and Mz, in the BEAM188 SMISC
record).

The beam is defined by nodes I(end 1) and J(end 2) and an optional orientation node K. Depending
upon direction from node I to node J, the displayed vector for these results may be flipped 180 degrees.

Result Utilities
The following topics related to result utilities are covered in this section.
Automatic Result Creation for All Result Sets
Adaptive Convergence
Animation
Capped Isosurfaces
Dynamic Legend
Exporting Results
Generating Reports
Renaming Results Based on Definition
Results Legend
Results Toolbar
Solution Combinations

Automatic Result Creation for All Result Sets


For a solved result in the tree Outline the contextual (right-click) menu Create Results at All Sets enables
you to automatically create one or more results, that are grouped, for all of the available result sets for
the selected result item. The associated result sets are read from the solver generated result file.

Note

This feature is not supported for:

• Design Assessment, Explicit Dynamics, Response Spectrum, Random Vibration, or Topology


Optimization analyses

• Probe Results

Release 2020 R1 - © ANSYS, Inc.


1356
Result Utilities

• Fracture Tool

• Fatigue Tool

• Composite Failure Tool

Example Application
The following example illustrates the process for using this feature. This example includes multiple load
steps, as shown in the first image.

Once solved, the Tabular Data is as follows.

You select a desired result, right-click, and select Create Results at All Sets. The application automat-
ically creates a result for each time point.

Release 2020 R1 - © ANSYS, Inc.


1357
Using Results

Adaptive Convergence
See the Adaptive Convergence (p. 1411) topic in the Understanding Solving section of the ANSYS Mechan-
ical User's Guide.

Animation
The Animation feature displays in the Graph window when you select a result object in the Mechanical
application. Here is an example of the Graph window with a result object selected.

The specific Animation functions are presented below.

Control Description
Play: Initiates a new animation.

Pause: Pauses an existing animation. Choosing Play after Pause


does not generate new animation frames. When the animation
(same toolbar location as Play) is paused, as you move the cursor across the graph, the cursor's
appearance changes to a double horizontal arrow when you
hover over the current frame indicator. With the cursor in this
state, you can drag the frame indicator to define a new current
frame. The result graphic will update accordingly.

Release 2020 R1 - © ANSYS, Inc.


1358
Result Utilities

Control Description
Stop: Halts a result animation. Choosing Play after Stop
generates new animation frames.
Previous Frame and Next Frame: These two buttons reverse or
advance the animation frame by frame.
Distributed: For static analyses, frames display linearly
interpolated results. Frame 1 represents the initial state of the
model and the final frame represents the final results calculated
by the solver.

For stepped and transient analyses, the frames in Distrib-


uted mode are distributed over a time range selected in
the graph.1 (p. 1360)
Result Sets: (available only for stepped and transient simulations)
Frames represent the actual result sets that were generated by
the solver.1 (p. 1360)
Frame Markers: display what time points are being used in the
animation by placing a vertical line at the time points.
Select the number of frames in the animation.

Select the desired amount of time for the entire animation.

Export Video File: Saves animation as an AVI file.

Note

• When exporting an AVI file, make sure that you keep


the Mechanical module window in front of other
windows until the exporting is complete. Opening
other windows in front of the module window before
the exporting is complete may cause those windows
to be included in the AVI file capture.

• The Export Video File feature is not supported for


the Linux platform.

Update Contour Range at Each Animation Frame: By


default, the animation feature displays the global range of
result values over all of the available frames. When you
select this option, you animate the result on a frame by
frame basis. That is, the animation changes so that at each
frame, the entire range of result values for that frame (only)
is used. Therefore, for each frame, the application displays
the minimum and maximum values for the result, at that
frame, for the contour values of the legend and for the
contour result. As a result, the legend dynamically changes
from frame to frame and the result contours always display
the full range of colors from blue (or the color representing

Release 2020 R1 - © ANSYS, Inc.


1359
Using Results

Control Description
the minimum value on the legend) to red (or the color
representing the maximum value on the legend).
Damped Modal Animation: Turns on time decay animation of
complex modes in a Modal Analysis (p. 227) that has damping
applied. This button is not available (grayed out) for any of the
following:

• Any analysis type other than modal.

• Any modal analysis whose Damped setting (under Solver


Controls (p. 877)) is set to No.

• Any modal analysis whose Damped setting is set to Yes, and


whose Solver Type is set to Reduced Damped, and Store
Complex Solution is set to No.

Zoom to Fit Animation: When turned on, Mechanical loops


through all the time steps to compute an auto scale factor
that will accommodate the displacement for a full range of
time steps and ensure that they will fit nicely in the screen.
For more information on auto scale factors, see Result
Context Toolbar (p. 84).

When turned off, Mechanical uses the current result scale


factor for animation. While this option results in increased
animation speed, you may experience some distortion if the
current display time has a displacement that is much smaller
than the peak displacement through which the animation
occurs.

1 - For stepped and transient simulations, as you move the cursor across the graph, the cursor's appear-
ance changes to a scope icon for solved solution points.

Animation Behavior
Depending upon the type of simulation that you perform, the behavior of the resulting animation varies.

For a static analysis with one time step or a Modal analysis, the animation progresses forward and then
backwards in a continuous motion.

For simulations that have more than one associated time or step range, the animation begins at the
initial time or step value, progresses to the final set, and then stops and starts at zero again (forward
animation only).

For transient and stepped simulations that have an associated time or step range, the animation begins
at the initial time or step value, progresses to the final set, and then stops and starts at zero again. It
does not traverse backward as it does for static simulations.

As illustrated below, you may also select a specific time period to animate that is a subset of the total
time. To do so, drag the mouse through the time period in the graph. The selected time period turns
blue. Click the Play button to animate only through that period. While that specific period is playing,

Release 2020 R1 - © ANSYS, Inc.


1360
Result Utilities

you can right-click the mouse to receive the options to Pause, Stop, or to Zoom To Range, which ex-
pands the defined period across the entire graph.

The following demo is presented as an animated GIF. View online if you are reading the PDF version of the
help. Interface names and other components shown in the demo may differ from those in the released
product.

Note

• In a dynamic analysis, probe animation for joints is only supported if there is at least one rigid
body. See Probes (p. 1175).

• For a Modal analysis, rigid bodies are not currently auto-scaled during animations and as a result
may not display accurately.

• When animating mode shapes with color contours, be aware that the shapes are animated by
scaling the displacements from 1 to 0 to -1 to 0 to 1 in a full cycle, but the corresponding contours
are animated by scaling their values from 1 to 0 to 1 to 0 to 1 over the same cycle. You can correct
this display limitation by setting a variable (p. 122) (TreatModalAsComplex = 1)

Capped Isosurfaces
The Capped IsoSurfaces display represents mainly a set of all points that equal a specified result value
within the range of values for the result with additional features. This option provides three display
selections. A display based on all points of a specified result, all points equal to and less than the specified
result, and all points equal to and greater than the specified result value. You select this option from
the Geometry drop-down menu on the Result Context Toolbar (p. 84).

The option has a corresponding toolbar as shown below.

The value for the isosurface is set by the slider or entry field (specified result value) on the toolbar. The
slider represents the range from minimum to maximum for the selected result.

The three toolbar buttons control what you wish to display, and include:

IsoSurface
This button displays isosurface values equal to the specified slider or entry field value.

Release 2020 R1 - © ANSYS, Inc.


1361
Using Results

Top Capped IsoSurface


This button displays isosurface values that are less than the specified slider or entry field value.

Bottom Capped IsoSurface


This button displays isosurface values that are greater than the specified slider or entry field value.

Release 2020 R1 - © ANSYS, Inc.


1362
Result Utilities

Note

Because of internal tolerance calculations, there are times when this view feature may present
color inconsistencies between what is shown on the results legend versus what is displayed
in the Geometry window.

Dynamic Legend
The dynamic legend feature helps you display result ranges and contour colors associated with visible
elements. You can use the dynamic legend feature when you slice a body (p. 154) or hide bodies in an
assembly. When you apply the dynamic legend feature to a sliced body, Mechanical repositions the
Min and Max annotations to the lowest and highest result values displayed on the sliced body. For
models that include multiple bodies the maximum and minimum result values can occur at the joined
surfaces even if these surfaces are not visible.

As illustrated in the sequence below for an example slice, to update the legend and view the result
ranges for the visible elements: right-click the legend and select Adjust to Visible.

Note

When you are viewing a result using the Capped Isosurfaces option (via the Geometry
(p. 87) drop-down menu on the Result Context Toolbar (p. 84)), and the minimum or
maximum value of a result occurs on the inside of your geometry and not on the exter-
ior, the Adjust to Visible option will not display expected contour colors.

Release 2020 R1 - © ANSYS, Inc.


1363
Using Results

Adjusting the legend to visible elements only updates the legend colors, values, the Min and Max values
as well as the annotations for these values, and adds the label "Custom" to the legend annotation in-
formation.

A change to the visibility of a part, displaying all parts again for example, or removing parts from the
current display, adds the label "Custom Obsolete" to the legend annotation information. This indicates
that the custom display is no longer accurate. It is displaying the values of the previous display (legend
colors and values, the Min and Max values and annotation location, etc.), shown above, associated with
a part being hidden. You need to select the Adjust to Visible option again to re-display the contours
or select the Reset All option to display the original contours.

Release 2020 R1 - © ANSYS, Inc.


1364
Result Utilities

To restore the legend display for the entire body after you disable the slice or hide command, right-
click the legend, and then click Reset All to view the result ranges for the entire body. If you do not
reset the legend to show result range for the entire body after disabling the slice or hide command,
Mechanical displays the out of range values with colors not included in the legend.

Note

This dynamic legend behavior does not apply to Probe annotations.

Exporting Results
The data associated with result objects can be exported in Text (.txt) and Excel (.xls) file format by
right-clicking on the desired result object and selecting the Export option. Once executed, you define
a filename and then select the file type. An Excel file automatically opens providing the node numbers
and the corresponding result data.

Release 2020 R1 - © ANSYS, Inc.


1365
Using Results

Exporting Node Results


In addition to a general export of all result data, you can also manually select results for one or more
nodes and export data for those nodes only.

To export node results:

1. Select the desired result object.

2. Select the Node filter on the Graphics Toolbar (p. 70).

3. As needed, select a desired selection tool in the Select Mode menu (also on the Graphics Toolbar (p. 70)).

You may wish to review the Selecting Nodes (p. 137) section of the Help.

4. Select the desired nodes on the result plot.

5. In the graphics window, right-click the mouse and select Export Node Results. You are prompted to save
the data in .txt format. You may also select to save the data as an Excel file. Once you save the file, an
Excel file automatically opens providing the node numbers and the corresponding result data.

Note

• Path Results (p. 1168), Surface Results (p. 1173), and Crack-based results do not support this feature.

• Results scoped to elements or element-based named selections do not support this feature.

Generating Reports
See the Report Preview (p. 31) section.

Renaming Results Based on Definition


The option Rename Based on Definition is available when you right mouse click any result (under
Solution objects), or any Result Tracker (p. 1405) (under Solution Information (p. 1395) objects). When
you choose this option, the Mechanical application automatically renames the result or Result Tracker
based on the selected parts (for example, Temperature can be renamed to Temperature - Tube, or
Directional Deformation can be renamed to Directional Deformation - All Bodies).

Results Legend
By default the results legend displays the following information:

Object Title
This is the name of the selected tree object. Place your cursor over the legend and right-click the
mouse to display the following options:

• Named Legends: a name can represent the following data:

– Number of contours

– Color scheme

Release 2020 R1 - © ANSYS, Inc.


1366
Result Utilities

– Color overrides per band

– Value break per break, either automatic or numeric


Use the Named Legends option to create new named legends or to manage existing ones that
can be edited independently. See the steps shown below.

• Vertical: view the result contours color spectrum vertically (default).

• Horizontal: view the result contours color spectrum horizontally.

• Date and Time: toggle Date and Time on and off.

• Max, Min on Color Bar: shows extremes when checked. If unchecked, they appear in the title book.

• Logarithmic Scale: displays result values.

• High Fidelity: Use this option when color display issues (p. 1369) occur on the model due to custom-
ization. For example, when you are interactively probing a contour result that has a customized
legend and the interval between adjacent bands is much smaller (at least less than one thousandth)
compared with the full min-max range, this option replots and improves the synchronization of
the values of the probes with the colors on the model as well as the corresponding color/range in
the legend.

• All Scientific Notation: displays result values.

• Digits: specifies the number if significant digits for result values. The default is 3. Options include
2 through 8.

• Independent Bands: Use to set the alarm color representing the maximum/minimum contour
range. The following choices are available:

– None (default)

– Top

– Bottom

– Top and Bottom

• Color Scheme: used to change the color spectrum. The choices available are:

– Rainbow (default)

– Reverse Rainbow

– Grayscale

– Reverse Grayscale

– Reset Colors

• Semi transparency

• Adjust to Visible

• Reset All

Release 2020 R1 - © ANSYS, Inc.


1367
Using Results

Type
The result type of the selected tree object.

Units
A display of the current Unit system

Time
The current solution time step for the result.

Time Stamp
The time that the result was solved.

New Named Legends


By selecting New, an input dialog box displays to specify a name. Future edits use this new name. You
can create an independent variation of a named legend by choosing Unnamed or New. The option
Unnamed is the default. The Unnamed option indicates that the legend can be edited independently.

Managing Named Legends


The Named Legends dialog box allows you to manage styles. Options included:

• Import

• Export

• Rename

• Delete

Checked named legends appear in the legend context menu by default for new databases only.

Customizing the Contour Range


Placing the mouse pointer over a contour color of the legend and right-clicking the mouse provides
the following additional context menu options:

• Custom Color: a pop-up color appears when you right-click a color band. The same color can be used
for more than one band.

• Automatic Color: the default color is restored.

Placing the mouse pointer over a value on the legend and right-clicking the mouse provides the following
additional context menu options:

• Edit: enables you to enter a custom value. Double clicking a value also performs this edit action.

• Automatic Value: the value calculated by the program.

In addition, selecting a contour color or a value on the legend displays plus (+) and minus (-) buttons.
These buttons enable you to set the number of bands between the bottom and top of the contour.
The number of bands can range from 4 to 14.

Release 2020 R1 - © ANSYS, Inc.


1368
Result Utilities

Customization Limitation
If you customize the legend between adjacent bands and the interval is very small, for example, less
than one thousandth of the entire range, the contour colors may not correctly reflect the ranges in the
legend. A result is illustrated below.

Determining the difference between the maximum and the minimum, we get: 46.592 - 0.00032942 =
46.592. The interval between the customized interval is: 0.01 - 0.0087912 = 1.2088 e-3. This is the interval
between each of the subsequent color bands (orange through blue). Dividing the first interval by the
interval of the subsequent bands: 46.592/1.2088 e-3 = 38,543. The first interval is nearly 40,000 times
greater than the subsequent intervals. This is a clear example of the issue of legend customization in-
volving very small intervals.

Therefore, customizing the legend at the second contour color with a value of 0.01, the coloring plotting
experiences a limitation and the model becomes entirely red. The legend values are correct, but the
coloring of the model becomes inaccurate.

Displaying the context menu and selecting High Fidelity replots the model's coloring accurately, as
shown in the final image.

Original Contours

Range Customized

High Fidelity Synchronization

Release 2020 R1 - © ANSYS, Inc.


1369
Using Results

Results Toolbar
Refer to the Result Context Toolbar (p. 84) section under Context Toolbar (p. 77).

Solution Combinations
You can create solutions that are calculated from other solutions. These are derived from the addition
of results coming from one or more environments, each of which can include a multiplication coefficient
that you supply. Included are nonlinear results, which are a simple addition of values. The calculated
values cannot be parameterized.

Only Static Structural analyses are available for solution combination selections.

The Design Assessment (p. 1491) system provides a more powerful Solution Selection (p. 1541) capab-
ility, allowing you to combine results from a greater variety of upstream analysis systems and perform
additional post processing functions using external scripts.

Note

• Choosing Update Project from the Project Schematic will not solve a Solution Combination in
the Mechanical application.

• If you have multiple result objects specified under the Solution Combination folder that are
scoped to individual, and different, bodies, and these results have the Average Across Bodies
property set to Yes, the application automatically calculates the average across all of the (different)
scoped bodies. This is in contrast to how the application normally calculates the average
across bodies. Wherein, the application calculates the average across the specified body only.

To Create a Solution Combination Object You can insert one or more Solution Combination objects
under the Model object. Under the Solution Combination object, you can add the following results
types:

• Stress Tool

• Fatigue Tool

• Contact Tool (for the following contact results: Frictional Stress, Penetration, Pressure, and Sliding Dis-
tance)

• Beam Tool

• Beam Results

• Stresses

• Elastic Strains

• Deformations

Each solution object contains its own configuration spreadsheet, available through the Worksheet
View.

Release 2020 R1 - © ANSYS, Inc.


1370
Result Utilities

When setting up a Solution Combination, you select the Environment Objects you wish to add together
from a drop-down list of all available environments. At least one environment must be checked. Enter
the multiplication coefficient you wish for each environment.

The results values shown for these objects are derived from the same results objects in the referenced
environments, including any defined multiplication coefficients. The basic formula for calculating the
results is:

(multiplication coefficient 1 X value from environment 1) + (multiplication coefficient 2


X value from environment 2) + etc.

Note

You can specify a coordinate system in the Details view of the Solution item for which you
request a solution combination. The default is the Global Cartesian Coordinate system. The
solution item at each result set identified in the Worksheet view is calculated in the specified
coordinate system and then solution combination is carried out.

If you request solution combination for derived quantities such as equivalent/principal stresses
as well as total displacement, the following two step procedure is used:

1. Solution combination is carried out to compute component results first.

2. The requested result items are then derived from the components.

In addition:

Release 2020 R1 - © ANSYS, Inc.


1371
Using Results

• Equivalent strains (including elastic, thermal, plastic, creep, total, and total plus thermal
equivalent strains) are read from the result file and are used directly in the linear combination
formulation. The component strains (X, Y, Z, XY, YZ, XZ) are not used. This procedure is
similar to using the Mechanical APDL SUMTYPE,PRIN command.

• Using the equivalent strains from the result file may lead to unexpected (or even negative)
results.

Release 2020 R1 - © ANSYS, Inc.


1372
Understanding Solving
The overall procedure for obtaining a solution in the Mechanical application is as follows:

1. Specify the solver type and other settings as applicable in the Details view of the Analysis Settings object.

2. For background solving capabilities (p. 1376) other than My Computer, Background, use the RSM Cluster
Configuration application to define cluster configurations that enable you integrate with an established
compute cluster. This step may be done for you by a person designated as the RSM administrator, and will
result in the availability of RSM queues, which map to cluster queues.

3. For solving capabilities other than standard My Computer options, create solve process settings (p. 1377)
to utilize the RSM queues created in Step 2. The appropriate RSM Queue for your computing environment
may be provided by your RSM administrator.

4. Initiate the solve. You can simply click the Solve button to use the default solve process settings or display
the drop-down menu to select specific solve process settings.

Note

Make sure that the project file path in which the solve is performed does not have Japan-
ese Script. Having Japanese characters in file path may result in improper solutions as
the solution may be performed application temporary folder rather than in Scratch Solver
Files Directory (p. 911).

• To solve all analyses, highlight the Project object, then choose Solve.

• To solve all analyses for a model, highlight the Model object, then choose Solve.

• To solve a particular analysis, highlight any of the following objects, then choose Solve:

– The particular analysis object (for example, Static Structural).

– The Solution object.

– Child objects of the Solution object.

Release 2020 R1 - © ANSYS, Inc.


1373
Understanding Solving

If you initiate a background (p. 1376) solve, and the project has not been initially saved, you will be
prompted to save the project first.

Note

For a background solve process setting, you still see the Meshing dialog box because
meshing will first be run locally and in synchronous mode before the solve is sent to the
queue. Meshing locally allows the same mesh to be used in each solve if multiple Solutions
are being solved simultaneously under a single Model, rather than re-meshing for each solve.
For both synchronous and background solves, you can check your mesh before solving
through a right mouse click on the Mesh object and selecting Preview Mesh in the context
menu.

A Solution Status window in the Mechanical application monitors solution progress for synchronous
solutions. Conventional progress bars are displayed in this window along with a Stop Solution button
and an Interrupt Solution button. You have two choices when halting the progress of the Mechanical
APDL solver in the Solution Status window. If you would like the solver to halt immediately and forego
writing any outstanding restart points, click the Stop Solution button. If, instead, you would like to allow
the solver to complete its current iteration and record outstanding restart points, click the Interrupt
Solution button (available for static structural and transient structural analyses). Neither case affects
previous restart points.

Note

When running a solution in the background (p. 1376), the RMB option Disconnect Job from
RSM is available from the Solution folder. The option becomes visible once you submit the
job to the RSM. This option disconnects mechanical from the RSM job and the application
returns to the beginning of the solution process. You cannot disconnect the job while it is
running.

Note

If you are familiar with Mechanical APDL functionality, clicking the Interrupt Solution button
places a file named file.abt in the working directory.

Any error messages are displayed in the Messages window (p. 58) immediately after attempting the
solution. If you interrupt the solution, a confirmation message is displayed in the Messages window.

When a solution is in progress in the Mechanical application, you can freely access the Engineering
Data tab and review data. The engineering data used in the solution will be in read-only mode as indic-
ated by a lock icon.

The following characteristics apply to background configurations where the RSM user interface is used
to monitor solutions:

• While a background solution is in progress for a branch, that branch will be in a read-only state with the
exception that result objects can be deleted during this time. Other branches can be edited freely.

• You can cancel a running job and reset the state of the tree by selecting Solution in the tree and choosing
Stop Solution in the context menu (right mouse button click). Note that this will immediately kill the job

Release 2020 R1 - © ANSYS, Inc.


1374
and not attempt to bring back any solver files (if solving on a compute server). Use Evaluate Results (p. 1404)
or Retrieve (p. 1404) first if you wish to bring back any files from the server.

• An alternative to canceling a job is to choose Interrupt Solution in the context menu. As in a synchronous
solution, this will allow the solver to complete its current iteration and record outstanding restart points.

• A green down arrow status symbol (p. 9) indicates that a solution is ready for download and/or loading
into the Mechanical application. This does not indicate the success or failure of a solve.

• When the green down arrow is displayed to indicate results are ready for download, choose Get Results
from the context menu to perform the download, if necessary, and load results into the Mechanical applic-
ation.

In the event of a network connection loss to the Remote Solve Manager, the Get Results function
prompts you with a warning message to address the connection issue. You can perform the Get
Results operation and retrieve your results information once you re-establish a connection.

If you do not wish to retrieve your results, simply select Disconnect Job from RSM from the RMB
context menu as described above.

Note

When using a Local solve process setting and a solve is in progress, do not reboot or log
off the Windows client machine. If you reboot or log off, the connection to the Linux job will
be lost and results will not be retrievable. If the Linux job has completed, then rebooting or
logging off is safe.

The mathematical model is applied and the results are evaluated. When the compute server is a remote
machine, the model is applied and results are evaluated on that machine.

You can rename Solution or Solution Information (p. 1395) objects and items under these objects using
a right mouse button click and choosing Rename. You then type a new name for the object (similar to
renaming a file in Windows Explorer).

If you are using a Mechanical Wizard (p. 170), you must be sure that all the tasks in the wizard are

complete ( ) before you try to solve.

To view your solution, select View Results from the Mechanical Wizard (p. 170). Or, click the result and
the solution appears in the Geometry Window (p. 26).

You can use the postprocessing features during solve (p. 1404) when the solve process is on a remote
computer or as a background process.

Related Solving Topics


Additional topics include:
Solve Modes and Recommended Usage
Using Solve Process Settings
Solution Restarts
Solving Scenarios
Solution Information Object
Postprocessing During Solve

Release 2020 R1 - © ANSYS, Inc.


1375
Understanding Solving

Result Trackers
Adaptive Convergence
File Management in the Mechanical Application
Solving Units
Saving your Results in the Mechanical Application
Writing and Reading the Mechanical APDL Application Files
Converting Boundary Conditions to Nodal DOF Constraints (Mechanical APDL Solver)
Resolving Thermal Boundary Condition Conflicts
Solving a Fracture Analysis

Solve Modes and Recommended Usage


Workbench includes capabilities for efficiently solving various kinds of analyses taking CPU usage and
solving time into consideration. The following table defines the various solve “modes” available and
includes references to recommended usages and associated solve process settings. Further details are
discussed in the various other sections under Understanding Solving (p. 1373).

Solve Start Solve Monitor Recommended Solve Process Remote Solve


Mode Mode Usage Settings Manager (RSM)
Involvement
In Process - The Synchronous - Analyses that are My Computer No[1 (p. 1377)]
solve starts and The solve runs not expected to be
finishes on your and finalizes extremely CPU
computer in the within the same intensive.
directory where Workbench
your project session.
resides.
Out of Process - Asynchronous - Analyses involving My Computer, Back- Yes
The solve starts The solve is not large models or a ground
and finishes restricted to run large amount of
either on another and finalize processing time
computer, or on during any and machine
your computer particular resources,
but in a directory Workbench excluding linked
that is separate session.[2 (p. 1377)]analyses and
from the one analyses that
where your involve multiple
project resides. convergence
loops.[3 (p. 1377)]
Synchronous - Analyses involving My Computer, Back- Yes
The solve runs large models or a ground, then click
and finalizes large amount of Advanced... button
within the same processing time and check Solve in
Workbench and machine synchronous mode
session. resources, (ANSYS only).
including linked
analyses and
analyses that
involve multiple
convergence
loops.

Release 2020 R1 - © ANSYS, Inc.


1376
Using Solve Process Settings

[1] - Exceptions are the Rigid Body Dynamics and Explicit Dynamics solvers. Both solvers use RSM for
the In Process mode.

[2] - When solving in asynchronous mode, you are free to continue working independently of the solve
job, or close the Workbench session and retrieve the solution results at a later time. You can even shut
down your computer if the job has been submitted to a remote cluster (See RSM Cluster Configuration
and Using Solve Process Settings (p. 1377)). An asynchronous solution is queued with other solutions and
can run either on your local machine or on a more powerful remote machine. Background solutions
are recommended for large models or simulations that require a large amount of processing time and
machine resources. Sending the Solve to a remote cluster can increase productivity when a high-end
server is available on your network.

[3] - Though not recommended for a linked analysis using this solve mode combination, you can solve
a linked analysis or an analysis involving multiple convergence loops provided you solve each analysis
separately, that is, you must obtain the first solution, then choose Get Results from the context menu
in the first analysis before obtaining the solution in the second analysis. The Out of Process and Syn-
chronous mode combination is recommended for these types of analyses because the solve can occur
from a single user action. Also, asynchronous solutions involving linked analyses that are initiated from
the Project Schematic by choosing Update will automatically achieve the same effect as choosing Get
Results, thus providing another method for solving linked analyses from a single user action. See the
Understanding Solving (p. 1373) help section for additional information.

Using Solve Process Settings


Solve process settings are individual solving configurations (p. 1376) that you set up prior to initiating
solves. Settings include specifying a synchronous or background solve, as well as solve manager machine
and queue designations for background configurations. Using the Solve Process Settings dialog box,
you can:

• Add a remote solve process

• Add a portal-based solve process

• Specify a default solve process

• Modify existing solve process settings

• Delete an existing solve process

• Rename a solve process

You access the Solve Process Settings dialog by selecting the Solve Process Settings option from
the Tools menu in the Mechanical application window. The dialog displays as illustrated below based
on your solve process selection.

My Computer: The default setting. When using this setting, the application solves and finalizes the
solution on the local computer in the current Workbench session.

Release 2020 R1 - © ANSYS, Inc.


1377
Understanding Solving

My Computer, Background: selecting this setting, solves on the local machine but is not restricted to
finalizing in a particular Workbench session. You need more than one solver license to use this setting.
However, you can perform Rigid Dynamics and Explicit Dynamics analyses with one solver license by
selecting the Use Shared License, if possible option on the Advanced Properties dialog box.

Portal: When using this setting, the application solves and finalizes the solution through an EKM Portal.

Release 2020 R1 - © ANSYS, Inc.


1378
Using Solve Process Settings

Note

The solve process in red indicates that the process is selected as the default solve process
and persists across Workbench sessions.

Solve Process Options


Adds a new remote handler, where you can specify the remote queue you
Add Queue
want to use.
Add Portal Creates a connection to an EKM Portal.
Set As Default Specifies the solve process as Default across workbench sessions.
Rename Renames the selected solve process.
Delete Deletes the selected solve process.

Note

You must have a unique name for each Solve process.

Solve Process Settings


RSM Queue Specifies the name of the queue configured using RSM Configuration or the
name of the queue on the specified Portal.
Cluster Configura- Read-only field that reports the Cluster configuration name specified for the
tion Queue in the Remote Solve Manager.
Cluster Queue Read-only field that reports the Cluster queue name specified for the Queue
in the Remote Solve Manager.
Portal Connection Specifies the name of the portal connection to be used.
Portal Queue Submitting a solution to an EKM Portal also specifies an associated Portal
Queue. Each Portal Queue contains a cluster queue configuration. This
configuration determines the resources used to execute the solution.

If the Queue field does not contain any options, check the connection to the
portal as well as the Portal queue configuration.

Release 2020 R1 - © ANSYS, Inc.


1379
Understanding Solving

Job Name Specify the Solve Cluster job name. See the Remote Solve Manager
documentation for more details.

Note

Your Job Name must adhere to the following naming requirements:

• Acceptable naming characters include alphanumeric characters


(letter or numbers) as well as the following characters:
~#%^&,'()-_+=/<>.

• The job name must begin with a letter or a number (i.e. an


alphanumeric character).

• The maximum length of a job name is 16 characters.

License Specifies the name of a valid ANSYS product license (ANSYS Professional or
higher) to be used for the solution on the server.

Note

• You must specify a valid ANSYS product license because a separate


instance of an ANSYS application is being used.

• The license from your current ANSYS Workbench client session cannot
be accessed from the remote ANSYS application executable.

Note

• Settings are not available when you select the built-in My Computer solve process.

• RSM Queue fields are required for all remote background configurations.

• When you submit a job to a Remote Queue and you have not defined corresponding credentials
in the Accounts section of the RSM Configuration, you are prompted with the Remote Solve
Cache Credentials dialog box. Enter your User Name and Password to continue.

• See the Submitting Solutions section of the Workbench User's Guide for additional information
for using the Remote Solve Manager during your solution processes.

Advanced Properties

Selecting the Advanced button on the Solve Process Settings dialog displays one of the following
Advanced Properties dialog boxes. The available options are based on whether you select My Computer
or My Computer, Background.

Release 2020 R1 - © ANSYS, Inc.


1380
Using Solve Process Settings

My Computer My Computer, Background

The Advanced Properties are described below.

Distribute Solution (if pos- This option is selected by default. It enables and disables the ability
sible) for a distributed solution.

Note

This option supports the Mechanical APDL Solver and


Explicit Dynamics Solver only. For specific support
specifications for the Mechanical APDL Solver, see the
Supported Analysis Types and Features section of the
Mechanical APDL Parallel Processing Guide for more
information.

Max number of utilized cores Sets the number of cores to use during the solution. The default
is value is 2. Entering 0 does not send any request to the
Mechanical APDL solver related to the number of cores to use. For
shared-memory solutions, if you specify a number greater than the
number of cores in the node, the highest available number of cores
is used. However, for Distributed ANSYS solutions, you cannot
specify a number greater that the available number of physical
processors.

For more information on parallel processing in Mechanical APDL,


see HPC Licensing in the Parallel Processing Guide.

Release 2020 R1 - © ANSYS, Inc.


1381
Understanding Solving

For Explicit Dynamics analyses, this setting is used to determine


the number of cores unless this has been specified in the Additional
Command Line Arguments.

Note

• Available only for the Mechanical APDL and Explicit


Dynamics solvers.

• In order to run an Explicit Dynamics solve in parallel, you


need an ANSYS Mechanical HPC license. To run the
Mechanical APDL solver in parallel, you need an HPC license
for additional cores after the first 2.

• For Explicit Dynamics analyses, this setting is used to


determine the number of cores unless this has been
specified in the Additional Command Line Arguments.

Use GPU Acceleration (if pos- Provides access to the Graphics Processing Unit (GPU) acceleration
sible) capability offered by Mechanical APDL, including support for the
NVIDIA and Intel acceleration cards. To enable this feature, you
must select NVIDIA or INTEL from the drop-down menu.

See the Help Section: Requirements for the GPU Accelerator in


Mechanical APDL in the Windows and Linux installation guides
for specific card requirements.
Number of utilized GPU Specifies the number of GPU accelerator devices to be used when
devices the Use GPU acceleration property is set to use a valid accelerator
type. This value can be an integer in the range of 1 to 20. The
default value is 1. For additional information, see the GPU
Accelerator Capability section of the Mechanical APDL Parallel
Processing Guide.
Manually specify Mechanical Helps you specify the amount of system memory, in MB, used for
APDL solver memory settings the ANSYS application workspace and database.

Note

This setting can also be used to specify memory use for


the ABAQUS and Samcef solvers. For more information,
see Memory Tuning the Samcef Solver (p. 1384) and
Memory Tuning the ABAQUS Solver (p. 1384).

Additional Command Line Specifies arguments that you would normally enter into a command
Arguments line input, for example, -machine option for a distributed solution.

Release 2020 R1 - © ANSYS, Inc.


1382
Using Solve Process Settings

Custom Executable Name Specifies a custom ANSYS application solver executable name and
(with path) path. This executable will be used for the ANSYS application solve
rather than using the default.

Note

Depending on the requirements of your operating


system, you may need to specify the path in
quotations.

Manually specify Linux set- Enter a valid User Name and Working Folder to override the RSM
tings compute server proxy settings.

Note

• You must have write access to this folder on all potential


compute proxies in the queue.

• To use the RSM settings, leave this field blank.

Use Shared License, if pos- Enables the use of a Shared License


sible
Note

• This option works only for Explicit Dynamics and Rigid


Dynamics analysis. For more information, see Shared
Licensing

• License sharing is only possible within a single Workbench


session with the solver running on the same machine. A
remote solve on another machine via RSM will require a
license for the Workbench session and a license for the
remote solve.

License Queuing: Wait Instruct the Mechanical APDL solver to wait for an available license
for Available License when solving remotely via RSM.
Solve in synchronous mode Select to mimic the default My Computer behavior while leveraging
(Mechanical APDL solver the computation power of a remote machine. See this section from
only) the Mechanical APDL help for more information: HPC Licensing in
the Parallel Processing Guide. For Explicit Dynamics analyses, this
setting is used to determine the number of processors unless this
has been specified in the Additional Command Line Arguments.

Note

• Applicable only for Mechanical APDL solver.

Release 2020 R1 - © ANSYS, Inc.


1383
Understanding Solving

• Requires an additional license.

Clear the check box to deliberately download results from a remote


machine (by issuing Get Results on a right-mouse click the Solu-
tion object). This precludes the solution of linked analyses or
multiple convergence loops automatically on a single click of the
Solve button. This is the default and allows the user to close the
Mechanical editor or solve an unrelated analysis. See the
Understanding Solving (p. 1373) help section for additional
information.

OK - Commits all changes in the Solve Process Settings dialog box and closes the dialog box. You
must choose OK for the Solve Process Setting configurations to be used when you initiate the solve.

Cancel - Closes the dialog box and ignores all changes.

Memory Tuning the Samcef Solver


Memory settings for the Samcef solver are specified using the Manually specify Mechanical APDL
solver memory settings option. The default value for the Workspace setting is 600 MB, and the default
value for Database is 300 MB. The amount of memory allocated to the Samcef solver is determined by
the following rules:

• The value of the Workspace option is the total memory available to the solve process.

• The Database memory cannot exceed 35% of the total system memory of the node. If it exceeds this value,
it is reset to 35% of the total system memory.

• If the processor architecture is 32-bit, the total memory available to the solve process cannot exceed 1 GB.

• If Database is 0, Workbench automatically sets it to 300 MB.

• If Workspace is 0, Workbench automatically sets it to twice the Database setting.

Before launching the Samcef executable, the SAM_ZONE environment variable is set to the value of
the total memory (Workspace) in words, where 1 MB = 125000 words. The SAM_DBRAM environment
variable is set to the ratio (in percent) between the Database and Workspace setting. The default value
is 50%.

Memory Tuning the ABAQUS Solver


Memory settings for the ABAQUS solver are specified using the Manually specify Mechanical APDL
solver memory settings option. The default value for the Workspace setting is 512 MB, and the default
value for Database is 256 MB. The amount of memory allocated to the ABAQUS solver is determined
by the following rules:

• The value of the Workspace option is the total memory available to the solve process.

• The Database memory cannot exceed 35% of the total system memory of the node. If it exceeds this value,
it is reset to 35% of the total system memory.

• If the processor architecture is 32-bit, the total memory available to the solve process cannot exceed 1 GB.

Release 2020 R1 - © ANSYS, Inc.


1384
Solution Restarts

Workbench tunes ABAQUS memory by changing keywords and values in the ABAQUS_v6.env file in
the solve working directory:

• If the ABAQUS release number is less than 6.8, the keyword pre_memory is set to the Database value and
the keyword standard_memory is set to the Workspace value.

• If the ABAQUS release number is greater than or equal to 6.8, the keyword memory is set to the Workspace
value and the Database value is ignored.

Workbench does not change the memory values if they are out of bounds for the ABAQUS solver.

Solution Restarts

Note

Solution Restarts are supported in Static Structural (p. 339) and Transient Structural (p. 384)
analyses only. However, they are not supported in a Static Structural analysis when computing
fracture parameters. See the Computation of Fracture Parameters discussion in the Solving
a Fracture Analysis (p. 1472) section for more information.

The solution process is composed of a sequence of calculations that predict a structure’s response when
applied to a specific analysis type and loading condition. Restarts provide the ability to continue an
initial or existing solution which can save time during the solve phase. This feature facilitates a variety
of workflows, which include:

1. Pausing or stopping a job to review results and then restarting the job.

2. Review and correction of a non-converging solution. Solution parameters in the analysis settings could be
fine-tuned or adjusted allowing the solution to proceed while retaining prior solution progress. Similarly
a load history can be modified to aid in the convergence.

3. Extending a solution that has already completed, for example, to allow system transients to progress further
into time.

4. Submitting post processing instructions into Mechanical APDL after the model has been fully solved (see
below).

The following topics are covered in this section:

• Restart Points (p. 1386)

• Generating Restart Points (p. 1386)

• Retaining Restart Points (p. 1386)

• Viewing Restart Points (p. 1386)

• Using Restart Points (p. 1387)

• Deleting Restart Points (p. 1388)

• Modifications Affecting Restart Points (p. 1388)

• Loads Supported for Restarts (p. 1392)

Release 2020 R1 - © ANSYS, Inc.


1385
Understanding Solving

• Conditions Supported for Restarts (p. 1393)

• Solution Information Files During Restart (p. 1393)

Restart Points
Solution restarts are based on the concept of a restart point. Each restart point can be considered as a
snapshot of the system solution state at a discrete point along the sequence of calculations. The solver
stores this state of the solution in a restart file on disk. Every restart file on disk will have a corresponding
restart point in the Mechanical GUI. See Viewing Restart Points (p. 1386) below.

A solution can only be restarted from an available restart point. It is thus important to understand how
to work with these restart points.

Generating Restart Points


Restart points are automatically created by Mechanical depending on the analysis type. The program
controlled option will create one restart point at the last successful solve point for a nonlinear analysis.
However, you may directly control their frequency to alter the balance between flexibility and disk usage
with the Restart Controls (p. 885) group of the Analysis Settings object. Restart points could be generated
at all substeps or specific substep intervals in the analysis or at none at all.

Note

• You can manually interrupt a solution and preserve any restart points that may have been pro-
duced from a converged iteration by clicking the Interrupt Solution button on the Solution
Status window.

• A stand-alone linear analysis will not produce any restart points with the program controlled
option. It has to be explicitly turned on using the manual setting. However, if the analysis is linked
to a follow on modal analysis, it will generate restart points by default.

Retaining Restart Points


An incomplete solution (for example, a convergence failure) will always retain the restart points. However,
for a complete solution, this is controlled by Retain Files After Full Solve property located in the Details
view of Analysis Settings under Restart Controls. This property is set to No by default and hence will
delete all restart points after the solution is completed. It can be set to Yes which will retain the restart
files for the current project. Alternatively, there is a global option to control the restart points after a
successful solve Tools> Options> Mechanical> Analysis Settings and Solution> Restart Controls
and it applies to all projects.

Viewing Restart Points


Once restart points are generated, they will be visible in several forms. For an overview, select the
Analysis Settings object and refer to the Graph window where restart points are symbolized by trian-
gular markers atop the timeline. The Tabular Data window lists the restart points within each load
step.

A restart point is color coded to distinguish between replayable and a non-replayable. A replayable
solution is one which will produce the exact solution when run from start to finish or completed incre-

Release 2020 R1 - © ANSYS, Inc.


1386
Solution Restarts

mentally using intermediate restart points. A blue triangle indicates a replayable restart point. A red
triangle indicates a potentially non-replayable restart point and can only be used in manual mode.

Note

The Initial Restart Point does not represent a restart file on disk. It is only a place holder to
facilitate selection to run the solution from the beginning even when other restart points
are available.

Using Restart Points


You can manually choose the restart point to be used in a solution. Alternatively, you can configure
Mechanical to suggest one for you. To allow Mechanical to automatically select a restart point, set Restart
Type to Program Controlled. If you prefer a different point, you may specify it directly by setting Restart
Type to Manual and by:

• Choosing Current Restart Point in the Details view of the Analysis Settings object.

• Selecting the desired marker on the Graph window and choosing Set Current Restart Point in the context
menu.

• Selecting the desired cell in the Tabular Data window and choosing Set Current Restart Point in the
context menu.

The Current Restart Point in the Restart Analysis group of the Analysis Settings object will indicate
which restart point will be used the next time a solution is attempted. The current restart point in the
graph/timeline window will be denoted with a double triangle in the timeline.

The program controlled setting takes a conservative approach to guarantee a replayable solution and
will always select the last replayable restart point. In manual mode, the software will not automatically
change the current restart point and has to be selected explicitly. Picking a non-replayable restart point
in manual mode is only recommended for experienced users who understand the implications of the
results produced.

Release 2020 R1 - © ANSYS, Inc.


1387
Understanding Solving

Mechanical automatically tracks how restart points are affected as you work and modify your model.
So they may get flagged as non-replayable (red triangle) or be removed altogether depending on the
operation. See Modifications Affecting Restart Points (p. 1388) for details.

Also see Restart Analysis (p. 884) under Configuring Analysis Settings (p. 873).

Note

• An analysis should use the same units (set at the beginning of a solve) throughout the solve in-
cluding all restarts. If the units are changed at any restart point, the solve is aborted and an error
message is displayed.

• Named Selections (p. 583) created/modified following the solution process are not recognized
during a restart. For example, you may wish to list the nodes of a newly created Named Selection
using the Command (p. 1475) feature. Because the Named Selection’s geometric data was not
defined during the initial solution process, no data is available for the command to process.

Deleting Restart Points


In order to delete existing restart points, you may use the Delete All Restart Points in the context
menu at the Environment and Solution folders. For more granularity, one or more restart points may
also be deleted by selecting them on either the Graph or Tabular Data windows and issuing Delete
Restart Points.

Note

The Clear Generated Data option in the context menu from either the Solution, Environ-
ment, Model or Project objects also deletes all restart points.

Modifications Affecting Restart Points


The following table summarizes the effects of making changes to the controls of the Analysis Settings
object and the impacts on restart points.

If a change is made to one of the


Then...
following Controls…
Current
Current Restart
All
Restart Point set Non-replayable Restart
Restart
Point to the Restart Points Points
Points
is Set Beginning may be are
are
to of the Available2 (p. 1391)
Unaffected
Deleted
Initial Modified
Load Step
Step Controls Step End
X
Time3 (p. 1391)
Auto Time Stepping X X
Define By X X

Release 2020 R1 - © ANSYS, Inc.


1388
Solution Restarts

If a change is made to one of the


Then...
following Controls…
Current
Current Restart
All
Restart Point set Non-replayable Restart
Restart
Point to the Restart Points Points
Points
is Set Beginning may be are
are
to of the Available2 (p. 1391)
Unaffected
Deleted
Initial Modified
Load Step
Carry Over Time
X X
Step
Time Integration X X
Solver Controls X
Rotordynamics
X
Controls
Restart Controls X
Restart Analysis X
Non Linear
X X
Controls
Output
Stress X
Controls4 (p. 1392)
Strain X
Nodal Force X
Contact
X
Miscellaneous
General
X
Miscellaneous
Store Results At X X
Damping
X
Controls
Analysis Data
Save MAPDL dB X
Management
Delete Unneeded
X
Files
Solver Units X

The following table summarizes the effects of step modifications on restart points.

If a change is made to one of the


Then...
following Controls…
Current Restart Point
All Restart Non-replayable Restart
is set to the Beginning
Points are Points may be
of the Modified Load
Deleted Available2 (p. 1391)
Step
Activate/Deactivate X X

Release 2020 R1 - © ANSYS, Inc.


1389
Understanding Solving

Add Step/Insert Step X


Delete Step X

A solution can be restarted after modification to the load history. However, any other changes to the
definition delete all of the Restart Points.

Note

• Displacements, Remote Displacements, and Nodal Displacements only support Tabular data
modifications. See the Loads Supported for Restarts (p. 1392) topic for a detailed list.

• Changing a Displacement boundary condition may cause the program to return to the initial
restart point, depending upon the change you make. The restart point where the change occurred
is maintained - not deleted. For example, changing the magnitude of either of these loads from
a zero value to a non-zero value, or vice versa, prompts the application to return to the beginning
of the solution process. Similarly, if you change the independent time value of either load, the
solution process restarts from the beginning.

If a change is made to one of the


Then...
following Controls…
Current Restart
Current Restart Point is set to the Non-replayable
Point is Set to Beginning of the Restart Points may be
Initial1 (p. 1391) Modified Load Available2 (p. 1391)
Step
Modify Load
Constant X X
History
Tabular X X
Function X X
Change Load
Type (Constant,
X X
Tabular,
Function)

The following table summarizes the effects of adding/modifying/deleting a Commands (p. 1475) object.
When Restart Points are available, adding a new Commands object defaults to the last step so as to
preserve the Restart Points. Adding a Commands object without Restart Points defaults to first step.

Release 2020 R1 - © ANSYS, Inc.


1390
Solution Restarts

If a change is made to one of the


Then…
following Controls…
Current
Restart Point Non-replayable
All Restart Restart
is set to the Restart Points
Points are Points are
Beginning of may be
Deleted Unaffected
the Modified Available2 (p. 1391)
Load Step
Add/Modify/Delete
Under
Command X X
Environment
Snippets
Under
X
Solution/Results
Under
Model/Trunk X
Objects

Modifications such as adding or changing boundary conditions (for example, scoping changes), con-
straints, initial conditions, or editing model level objects (Geometry, Contact Region, Joint, Mesh) in-
validates and deletes existing Restart Points. The exception is Direct FE loads with a zero magnitude -
Restart Points are retained.

If a change is made to one of the


Then…
following Controls…
All Restart Points are Deleted Restart Points are
Unaffected
Add/Delete
Boundary X
Condition
Add/Delete Direct
Boundary Force (zero) X
Condition
Force (non
X
zero)
Displacement X
Model Level
X
Changes

1
Restart Type specified as Program Controlled.

2
It can only be selected when Restart Type is specified as Manual.

3
When the Step End Time option in the Step Controls (p. 873) category is changed, the restart point
is deleted as well as all the steps after this modified restart points are deleted and are not available,
not even for manual restarts. Exception is the case when Fluid Solid Interface load exists and all the
restart points are retained.

Release 2020 R1 - © ANSYS, Inc.


1391
Understanding Solving

4
It is recommended that you not change Output Controls settings during a solution restart. Modifying
Output Controls settings changes the availability of the respective result type in the results file. Con-
sequently, result calculations cannot be guaranteed for the entire solution. In addition, result file values
may not correspond to GUI settings in this scenario. Settings turned off during a restart generate results
equal to zero and may affect post processing of results and are therefore unreliable.

Note

Restart is not supported for an analysis with Adaptive Convergence (p. 1411). So the presence
of an adaptive convergence will not retain any restart points.

Loads Supported for Restarts


The following table outlines which loads may be modified for a solution restart.

Load Specified As...


Load Type
Constant Tabular Function
Pressure X X X
Line Pressure X X X
Force X X X
Remote Force X X X
Moment X X X
Displacement X X N/A
Remote
X X N/A
Displacement
Rotational Velocity X X X
Rotational
X X X
Acceleration
Bolt Pretension X X N/A
Acceleration X X X
Earth Gravity N/A N/A N/A
Hydrostatic Pressure X N/A N/A
Bearing Load X X N/A
Joint Load X X X
Pipe Temperature X X X
Pipe Pressure X X X
Thermal Condition X X X
Imported Load N/A N//A N/A
Nodal Force X X X
Nodal Pressure X X X
Nodal Displacement X X N/A

Release 2020 R1 - © ANSYS, Inc.


1392
Solving Scenarios

Conditions Supported for Restarts


The Nonlinear Adaptive Region (p. 1112) condition supports restarts. Adding a Nonlinear Adaptive
Region condition to a non-convergent and/or terminated solution may enable the solution to converge.

Solution Information Files During Restart


During a restart, solution information files (input file ds.dat and output file solve.out) from the
previous solve are retained for reference by renaming it just before the restart solve is initiated. The
naming convention is filename_loadstep_substep.ext. For example, if the previous solve oc-
curred at loadstep = 2 and substep = 5, the file name would be ds_2_5.dat and solve_2_5.out.
Files from the initial solve will be named ds_0_0.dat and solve_0_0.dat. Based on the restart
point, Mechanical will ensure that obsolete and invalid solution files are cleaned up.

Restarts and Distributed ANSYS Solutions


For a distributed solution, the application merges all individual result files into a single file at the end
of the solution so that Mechanical can postprocess the results or continue a restarted solution. If you
experience a solution failure, or if the solution is stopped, before the files have been combined, you
can manually recombine the files by executing the COMBINE,RST command from the /AUX2 module
in Mechanical APDL.

Note

The current working directory must include all of the local (file.rst) files.

Distributed ANSYS needs to be launched with the same number of processes that were used
when generating the local results files.

Following the execution of the COMBINE command, the working directory includes a complete results
file (file.rst) and you may use it for any additional Mechanical post-processing or subsequent restarts.

Solving Scenarios
This section describes the various configuration steps involved for the following solving scenarios:

• Solve on the Local Machine within the Workbench process (synchronous) (p. 1393)

• Solve on My Computer in the Background (asynchronous) (p. 1394)

• Solve to a Remote Windows Cluster (p. 1394)

• Solve Directly from My Computer to a Remote Linux Computer (p. 1394)

• Solve to LSF Cluster with Remote Solve Manager (p. 1395)

• Solve to Microsoft HPC Cluster with Remote Solve Manager (p. 1395)

Solve on the Local Machine within the Workbench process (synchronous)


• Use the built-in My Computer solve process setting (p. 1377).

Release 2020 R1 - © ANSYS, Inc.


1393
Understanding Solving

Solve on My Computer in the Background (asynchronous)


• Use the built-in My Computer, Background solve process setting (p. 1377). The option is only functional if
Remote Solve Manager (RSM) was installed along with Workbench. RSM has a built-in “Local” queue and
server for running jobs on the client computer.

Solve to a Remote Windows Cluster

Important

RSM must be installed on your local computer. The RSM launcher service must be installed
and running on the remote cluster submit host. See Installing and Configuring the RSM
Launcher Service for Windows in the Remote Solve Manager User's Guide. The Mechanical
application must be installed on your local computer as well as the cluster execution node
that will be used for the solve.

This step requires the following configuration steps:

1. Define a cluster configuration for the Windows cluster in RSM. Or, if an RSM administrator has already
defined a cluster configuration, load it into your local installation of RSM. See Sharing and Accessing Cluster
Configurations in the Remote Solve Manager User's Guide. The cluster configuration will contain RSM queues
that map to cluster queues.

RSM will use your account credentials to submit the job on your behalf to the cluster submit host.

If jobs will be submitted to a remote Microsoft HPC cluster, refer to Integrating RSM with a Microsoft
HPC Cluster for additional considerations.

2. Create a solve process setting that specifies the cluster configuration and RSM queue defined in step 1
(see Using Solve Process Settings (p. 1377)).

3. Use the Solve Process Setting created in step 3 using the Solve drop-down button on the toolbar.

Solve Directly from My Computer to a Remote Linux Computer

Important

RSM must be installed on your local computer. The RSM launcher service must be installed
and running on the remote cluster submit host. See Installing and Configuring the RSM
Launcher Service for Windows in the Remote Solve Manager User's Guide. The Mechanical
application must be installed on your local computer as well as the cluster execution node
that will be used for the solve.

This step requires the following configuration steps:

1. If your IT policy requires it, you may need to configure RSM to use SSH for job submission to a remote Linux
cluster.

2. Define a cluster configuration for the Windows cluster in RSM. Or, if an RSM administrator has already
defined a cluster configuration, load it into your local installation of RSM. See Sharing and Accessing Cluster
Configurations in the Remote Solve Manager User's Guide. The cluster configuration will contain RSM queues
that map to cluster queues.

Release 2020 R1 - © ANSYS, Inc.


1394
Solution Information Object

3. Create a solve process setting that specifies the cluster configuration and RSM queue defined above (see
Using Solve Process Settings (p. 1377)).

4. Use the Solve Process Setting created above using the Solve drop-down button on the toolbar.

Solve to LSF Cluster with Remote Solve Manager


The configuration from a Mechanical application user perspective is the same as above. A Solve Process
Setting is required that specifies an LSF cluster configuration and queue to which the solve will be
submitted. For RSM and cluster configuration information, see RSM Configuration and RSM Integration
with a Cluster in the RSM User's Guide.

Solve to Microsoft HPC Cluster with Remote Solve Manager


The configuration from a Mechanical application user perspective is the same as above. A Solve Process
Setting is required that specifies a Microsoft HPC cluster configuration and queue to which the solve
will be submitted. For RSM and cluster configuration information, see RSM Configuration and Integrating
RSM with a Microsoft HPC Cluster in the RSM User's Guide.

Solution Information Object


You can track, monitor, or diagnose problems that arise during any solution as well as view certain finite
element aspects of the engineering model, using a Solution Information object, which is inserted
automatically under a Solution object of a new environment or an environment included in a database
from a previous release. You can also manually insert a Solution Information object under a Connections
object for solver feedback.

When you select a Solution Information object in the tree, the following controls are available in the
Details view under the Solution Information category:

Solution Output
The Solution Output property defines how you want solution response results to display. All of the options,
described below, display results in real time as the solution progresses.

Important

The Solution Output property is not applicable to the Connections object.

• Solver Output (default): Displays the solution output file (in text format) from the appropriate solver
(Mechanical APDL, Explicit Dynamics, etc.). This option is valuable to users who are accustomed to re-
viewing this type of output for diagnostics on the execution of their solver of choice.

Choosing any of the following options displays a graph of that option as a function of Cumulative
Iteration/Cycle (availability depends on the solver).

• Force Convergence1 (p. 1398)

• Displacement Convergence1 (p. 1398)

• Rotation Convergence1 (p. 1398)

• Moment Convergence1 (p. 1398)

Release 2020 R1 - © ANSYS, Inc.


1395
Understanding Solving

• Participation Factor Summary: This property displays Participation Factor Summary in the
Worksheet. When selected, the property Summary Type also displays and its options include:

– All (default): All tables are displayed in the Worksheet, including Participation Factor, Effective
Mass, and Cumulative Effective Mass Ratio.

– Participation Factor: Only Participation Factor table is displayed in the worksheet.

– Effective Mass: Only Effective Mass table is displayed in the worksheet.

– Cumulative Effective Mass Ratio: Only Cumulative Effective Mass Ratio table is displayed in
the worksheet.

Participation Factor Summary Contents

Complex eigenvalues are available when the Damping property is set to Yes (except when
the Reduced Damped Solver Type is selected and the Store Complex Solution property
is set to No). When the Damping property is set to No, only the Unsymmetric Solver Type
provides complex Eigenvalues.

When you have a complex eigenvalue solution, the Participation Factor Summary
Worksheet tables display Mode, Frequency, X Direction (Real), Y Direction (Real), Z Direction
(Real), X Direction (Imaginary), Y Direction (Imaginary) and Z Direction (Imaginary). Otherwise
the worksheet tables display Mode, Frequency, X Direction, Y Direction, Z Direction, Rotation
X, Rotation Y and Rotation Z.

Important

The unit system for all of the data displayed in the Participation Factor Summary
Worksheet is the unit system for the Solver Unit System property in the Analysis
Data Management category of the Analysis Settings object.

Note

– The Participation Factor Summary output option is not available when cyclic
symmetry is active.

– If the Campbell Diagram (p. 913) property is set to On in the Modal system's Analysis
Settings (multi-step Modal analysis), the Participation Factor Summary reported
in the Worksheet is for the last rotational velocity/load step.

• Max DOF Increment

• Line Search

• Time

• Time Increment

• CSG Convergence1 (p. 1398) (magnetic current segments)

• Heat Convergence1 (p. 1398)

Release 2020 R1 - © ANSYS, Inc.


1396
Solution Information Object

• Energy Conservation: shows plots of total energy, reference energy, work done, and energy error.

• Momentum Summary: shows plots of X, Y and Z momentum and X, Y and Z impulse for the
model.

• Energy summary: shows plots of internal energy, kinetic energy, hourglass energy and contact
energy.

• Post Output: displays the output of a Post Command snippet (p. 1475).

• Solver Output (default): Displays the solution output file (text) from the appropriate solver (for
example, the Mechanical APDL application, Explicit Dynamics). This option is valuable to users
who are accustomed to reviewing this type of output for diagnostics on the execution of their
solver of choice.

• Solve Script Output: (Design Assessment system only) Displays the log file from the python Solve
script (p. 1553) specified for the current Design Assessment system.

• Evaluate Script Output: (Design Assessment system only) Displays the log file from the python
Evaluate script (p. 1553) specified for the current Design Assessment system.

• Optimization Output: This option displays the solution output (in text format) from the Topology
Optimizer solver (p. 368).

Mechanical also provides the following convergence charts for the Topology Optimization
analysis. These options provide plots (in the Worksheet) for convergence values determined
during the solution. This is useful for determining if the simulation is nearing convergence.
All of these options have a plot for the combined objective value versus the Convergence
Accuracy as defined in the Definition Analysis Settings (p. 355) for the Topology Optimization
environment. Note that individual objective values can occur separately in a multi-step ana-
lysis. These options also include a plot for the convergence of the Response Constraint (p. 362)
that you wish to observe (Mass, Volume, etc.).

– Objective and Mass Response Convergence: This option is the default option for a Topology
Optimization (p. 352) Analysis. This property plots the Mass Response Convergence against
the criterion you specify in the Percent to Retain property of the Mass Constraint object
(Response Constraint (p. 362)). The convergence chart will plot convergence against Percent
To Retain (Min) and Percent To Retain (Max) criterion, if the constraint is defined by Range.

– Objective and Volume Response Convergence: This property plots the Volume Response
Convergence against the criterion you specify in the Percent to Retain property of the Volume
Constraint object (Response Constraint (p. 362)). The convergence chart will plot convergence
against Percent To Retain (Min) and Percent To Retain (Max) criterion, if the constraint is
defined by Range.

– Objective and Global Stress Response Convergence (Static Structural analyses only): Plots
the stress response convergence against the criterion specified in the Maximum property of
the Global Von-Mises Stress Constraint object. For multi-step analyses, the application provides
fields to enable you to choose which Step Number corresponds to the stress constraint you
wish to observe.

– Objective and Local Stress Response Convergence (Static Structural analyses only): Plots the
local stress response convergence against the criterion specified in the Maximum property of
the Local Von-Mises Stress Constraint object. For multi-step analyses, the application provides

Release 2020 R1 - © ANSYS, Inc.


1397
Understanding Solving

fields to enable you to choose which Step Number corresponds to the stress constraint you
wish to observe.

– Objective and Displacement Response Convergence (Static Structural analyses only): Plots
the displacement response convergence against the criterion specified in X Component (Max)/Y
Component (Max)/Z Component (Max) of the Displacement Constraint object. For multi-
step analyses, the application provides fields to enable you to choose which Step Number
corresponds to the displacement constraint you wish to observe.

– Objective and Reaction Force Response Convergence (Static Structural analyses only): Plots
the reaction force response convergence against the criterion specified in X Component (Max)/Y
Component (Max)/Z Component (Max) of the Reaction Force Constraint object. For multi-
step analyses, the application provides fields to enable you to choose which Step Number
corresponds to the reaction force constraint you wish to observe.

– Objective and Natural Frequency Convergence (applicable for Modal analyses): Plots the
Natural Frequency Response convergence against the criterion specified in the Minimum Fre-
quency and Maximum Frequency properties of the Natural Frequency Constraint object
(Response Constraint (p. 362)). The application provides a field to enable you to specify a Mode
Number corresponding to a natural frequency range you wish to observe.

– Objective and Manufacturing Convergence (applicable when criterion is entered for the
Maximum property of the Manufacturing Constraint (p. 359) object): Plots the manufacturing
response convergence against the criterion specified in the Maximum property of the Member
Size category of the Manufacturing Constraint object when the Maximum property is set to
Manual.

Note

• The frequency at which data is written can be specified as a time step frequency or a physical
time frequency. By default information is displayed for every 100 time steps.

• For ease of viewing solutions with many substeps/iterations, the Substep Converged and
Load Step Converged lines are not displayed when the number of lines exceeds 1000. Also,
graphs are shown as lines only, rather than lines and points, when the number of points ex-
ceeds 1000.

1 - All convergence plots include designations where any bisections, converged substeps, converged
steps, or remesh points occur. These designations are the red, green, blue, or orange lines (solid or
dotted) shown in the example below of a Force Convergence plot.

Release 2020 R1 - © ANSYS, Inc.


1398
Solution Information Object

Newton-Raphson Residuals
This property is applicable only to Structural environments solved with the Mechanical APDL application.
It specifies the maximum number of Newton-Raphson residual forces to return. The default is 0 (no residuals
returned). You can request that the Newton-Raphson residual restoring forces be brought back for nonlinear
solutions that either do not converge or that you aborted during the solution. The Newton-Raphson force
is calculated at each Newton-Raphson iteration and can give you an idea where the model is not satisfying
equilibrium. If you select 10 residual forces and the solution doesn't converge, those last 10 residual forces
will be brought back. The following information is available in the Details view of a returned Newton-
Raphson Residual Force object:

• Results: Minimum and Maximum residual forces across the model

• Convergence: Global convergence Criterion and convergence Value

• Information: Time based information

These results cannot be scoped and will automatically be deleted if another solution is run that
either succeeds or creates a new set of residual forces.

Identify Element Violations


This property is a diagnostic tool that enables you to identify and view elements on your model that have
failed to meet certain solver criteria during the solution process. The application generates an error message
and creates Named Selection objects that contain the elements that violate the following criteria:

• Distortion too large (HDST)

• Elements that contain nodes that have near zero pivots (PIVT) for nonlinear analyses

• Plastic/creep strain increment is too large (EPPL/EPCR)

• Elements for which mixed u-P constraints are not satisfied (MXUP) - mixed U-P option of 18x
solid elements only

• Radial displacement (RDSP) is not converged

Release 2020 R1 - © ANSYS, Inc.


1399
Understanding Solving

For the system generated Named Selections that are scoped to the failed elements, the application
generated "name" includes a reference to the specific failed criterion, such as "HDST" for a distortion
that is too large. These Named Selections are placed under the Solution Information object.

The default setting for this property is 0 (no violations are returned). This value can be set to an n,
where n is an integer value greater than 0. This value defines the last n solver iterations for which
the failed elements are stored.

The system generated Named Selections behave as user-defined element-based named selec-
tions (p. 143) and as desired, you can scope results to these named selections. In addition, unlike
other diagnostic features, these Named Selections are not automatically deleted or overwritten
upon subsequent solutions. As needed, you need to delete then manually.

You can find additional details in the Element Components That Violate Criteria topic of the
NLDIAG command section of the Mechanical APDL Command Reference. Also see the Performing
Nonlinear Diagnostics topic in the Nonlinear Structural Analysis section of the Mechanical APDL
Structural Analysis Guide.

Update Interval
This property appears only for synchronous (p. 1376) solutions. It specifies how often any of the result
tracking items under a Solution Information object get updated while a solution is in progress. The default
is 2.5 seconds.

Display Points
This property is not applicable to Connections object. It specifies the number of points to plot for a
graphical display determined by the Solution Output setting (described above).

Display Filter During Solve


This property is applicable only when using Result Tracker filtering in Explicit Dynamics analyses. When
set to Yes, it displays filtered data from Result Trackers in the Worksheet at each refresh interval of the
Result Tracker. As shown below, a legend is included in the Worksheet to help distinguish the filtered data
from the non-filtered data. Typically there are two curves, non-filtered data is displayed in red, and filtered
data is displayed in green.

Solution Output (Design Assessment System Only)


[Not applicable to Connections object] For a Design Assessment system, this property presents the following
options for determining the display of (real time) solution response results.

• Solver Output (default): Displays the solution output file (text) from the appropriate solver (for example,
the Mechanical APDL application, Explicit Dynamics). This option is valuable to users who are accustomed
to reviewing this type of output for diagnostics on the execution of their solver of choice.

Release 2020 R1 - © ANSYS, Inc.


1400
Solution Information Object

• Solve Script Output: Displays the log file from the python Solve script (p. 1553) specified for the current
Design Assessment system.

• Evaluate Script Output: Displays the log file from the python Evaluate script (p. 1553) specified for the
current Design Assessment system.

Note

If an error occurs during a solve when using the ANSYS solver, the Solution Information
worksheet may point you to files (for example, file.err) in temporary scratch folders
whose purpose is for solving only (this is the folder where ANSYS actually ran). After the
solution, these files are moved back to the project structure, so you may not find them in
the scratch folders (or sub-folders).

Viewing Finite Element Connections


During the solution, the Mechanical application will sometimes create additional elements or Constrain
Equations (CE) for certain objects such as a remote boundary condition, spot weld, joint, MPC based
contact, or weak spring. So that you might better understand how the boundary conditions are applied,
the Mechanical application allows you to “view” these connections after a solution is completed. The
following controls are available in the Details view under the FE Connection Visibility category:

• Activate Visibility: Enables control on whether or not the finite element connection data is stored during
the solution. If visualization of the finite element connections will never be desired or to maximize perform-
ance on extreme models in which many constraint equations exist, this feature can be deactivated by setting
the value to No before solving the model. Note that in the case of a multiple step analysis, if constraint
equations are present, they will be reported from the first load step. The default value for this property can
be changed under Tools>Options>Analysis Settings (p. 118).

• Display: Enables control over which finite element connections are to be viewed. The options include:

– All FE Connectors (default)

Release 2020 R1 - © ANSYS, Inc.


1401
Understanding Solving

– CE Based (As illustrated below, outlined or hollow nodes indicate use for calculation purposes only.)

Release 2020 R1 - © ANSYS, Inc.


1402
Solution Information Object

– Beam Based

– Weak Springs

– None: This option is especially useful to separate the constraint equation connections from the beam
connections. The option None is available to assist in avoiding potential performance issues from this
feature.

– Cyclic: For a solution containing a Pre-Meshed Cyclic Region (p. 630), this option displays matching (cyclic)
node pairs if they are detected by the solver.

Release 2020 R1 - © ANSYS, Inc.


1403
Understanding Solving

• Draw Connections Attached To: Based on the availability and visibility of the bodies of your model, this
property provides the following options that draw finite element connection annotations for those nodes
that are involved in constraint equations.

– All Nodes (default): Nodes attached to available bodies.

– Visible Nodes: Nodes attached to visible bodies.

– Any node-based Named Selections (p. 583): Nodes in the selected node-based Named Selection.

• Line Color: Assigns colors to allow you to differentiate connections. The options include:

– Connection Type (default): Displays a color legend that presents one color for constraint equation con-
nections and another color for beam connections.

– Manual: Displays a color that you choose.

– Color: Appears if Line Color is set to Manual. By clicking in this field, you can choose a color from the
color palette.

• Visible on Results: When set to Yes (default), the finite element connections are displayed with any result
plot (with the exception of a base mesh). When set to No, the connections are displayed only when the
Solution Information object is selected.

• Line Thickness: Displays the thickness of finite element connection lines in your choice of Single (default),
Double, or Triple.

• Display Type: enables you to view FE connections as Lines (default) or as Points. If you wish to view the
Points of a specified Named Selection, the nodes belonging to the Named Selection display as solid colors.
Any other associated nodes not belonging to the Named Selection, display with an outline only.

Note

Finite element connection information is not available for Response Spectrum analyses when
the Spectrum Type property is set to Single Point.

Tracking Background Solutions


When running background (p. 1376) solutions, you can check the status of the solution by using the Re-
trieve feature, which is available in a context menu when you right-click the mouse button on the
Solution Information object. A Retrieve button is also available on the Solution Information toolbar.
In rare instances, the Retrieve feature could fail if the necessary files do not become available at a
particular time. Simply choosing Retrieve again will likely solve the issue.

Postprocessing During Solve


This feature is only available when you solve an analysis on a remote computer or as a background
process running as a non-distributed solution. When you run the solution as a background process, you
can add new results under the Solution object or use postprocessing features such as viewing results
contours, animation, min and max labels, and so on.

Postprocessing during a solve allows you to use postprocessing tools while an analysis is still in progress.
This feature is useful for analyses that produce partial results (that is, analyses that produce intermediate

Release 2020 R1 - © ANSYS, Inc.


1404
Result Trackers

results files that are readable but incomplete) such as all Static and Transient Structural, all Static and
Transient Thermal, and Explicit Dynamics analyses.

To postprocess results during a solve:

1. Set up the Remote Solve Manager (RSM) and run a solution. Make sure that the Distribute Solution option
on the Solver Process Setting (p. 1377) dialog is unchecked.

Request results for a specific time by entering the time in the Display Time field within the Details
view of the Solution object.

2. Right-click the Solution object and choose Evaluate All Results.

If you chose a specific time point that is not yet solved, the result of the most recent solved point
will be displayed in the output fields within the Details view.

Note

When using this feature, it is important that you allow adequate time after the solve for the
results files to be created and present before any postprocessing can be successful. Requesting
a postprocessing function too prematurely could generate an error message stating that the
result file could not be opened.

Result Trackers
In addition to the real time solution response graphs you can view from the Solution Information
object, you can also view graphs of specific displacement and contact results as a function of time using
Result Tracker objects. These objects are inserted as branch objects under a Solution Information
object.

Other than contact trackers that read data from the CND file (file.cnd), you cannot add new Result
Trackers to completed solutions. In order to add and solve a new result, you must Clear (p. 1199) the
Solution, add a new Result Tracker, and then resolve the simulation.

Note

• Result Trackers employ the instructions of the Mechanical APDL command, NLHIST.

• Contact Trackers reading from the CND file use the Mechanical APDL command, NLDIAG.

Result Tracker Types


The Result Tracker feature is available for the following:

Structural Result Tracker (p. 1407)

Thermal Result Tracker (p. 1411)

Explicit Dynamics Result Tracker

Release 2020 R1 - © ANSYS, Inc.


1405
Understanding Solving

Adding the Result Tracker Object


To insert a Result Tracker object, select a Solution Information object in the tree and either choose
an option under the Result Tracker drop-down menu in the Solution Information context toolbar, or
click the Result Tracker object, then insert a Result Tracker object.

Note

You can add Contact Result Trackers while the solution is in progress. The application
automatically sets the Enhanced Tracking property to Yes and the property is read-only.
Normal scoping requirements apply.

Result Tracker Features


The following options are offered by the Result Tracker object.

Plotting (p. 1406)

Renaming (p. 1407)

Exporting (p. 1407)

Plotting a Result Tracker


Any of the graphs created by either the Result Tracker or nonlinear convergence items have the fol-
lowing features:

• Multiple Result Tracker objects may be selected at the same time to create a combined chart assuming
they share the same X and Y output types (such as pressure for Y and time for X). An example is shown here:

• The graph can be zoomed by using the ALT key + left mouse button. Moving down and to the right zooms
in, and moving up and to the left zooms out.

Release 2020 R1 - © ANSYS, Inc.


1406
Result Trackers

• A plot can be saved by using the Image Capture toolbar button.

Caution

Because nodes may be rotated in solutions obtained with the Mechanical APDL application,
deformation Result Trackers may not record the expected component of the deformation.
Should this occur, a warning message alerting you to this will appear after the solve in the
Details view of the Solution object, in the Solver Messages field. This situation can occur
when Result Trackers are adjacent to supported faces, lines, or vertices. One possible ap-
proach to avoid this situation is to add 3 deformation Result Trackers, one for each of the
x, y, and z directions. This will ensure that the tracker is showing all deformation of that
vertex of the model.

Renaming a Result Tracker


The Result Tracker has an option for renaming the object based on the result and the scoping. You
choose the option in the context menu (RMB click). This option is useful in having the program create
meaningful names of the result trackers. An example would be Result Tracker 5 being renamed to
Pressure on Contact Region 2.

Exporting a Result Tracker


Result Tracker objects can be exported to an Excel file by selecting Export in the context menu using
a right-mouse button click the Result Tracker object. This option appears in the menu after the solution
is obtained.

Note

You must right-mouse click the selected object in the tree to use this Export feature. On
Windows platforms, if you have the Microsoft Office 2002 (or later) installed, you may see
an Export to Excel option if you right-mouse click in the Worksheet window. This is not
the Mechanical application Export feature but rather an option generated by Microsoft In-
ternet Explorer.

Structural Result Trackers


A Structural Analysis supports the following Result Trackers.

• Deformation (p. 1408)

• Contact (p. 1408)

• Kinetic Energy and Stiffness Energy (p. 1410)

The Details view categories and options for each are described below.

Note

Direct graphical node selection requires you to generate the mesh.

Release 2020 R1 - © ANSYS, Inc.


1407
Understanding Solving

Deformation
The Deformation result tracker tracks displacement for one vertex only using the geometry picker or
a geometry-based Named Selection or a node-based Named Selection for a single node. Details view
categories and properties include:

• Scope

– Scoping Method: options include Geometry Selection or Named Selection.

– Geometry: visible when Geometry Selection is specified as the Scoping Method. This field allows you to
select and define a single vertex or a single node as the geometry.

– Named Selection: visible when Named Selection is specified as the Scoping Method. This field provides
a list of user-defined Named Selections that are either geometry-based or node-based.

• Definition

– Type: Read-only field that displays the type of Results Tracker.

– Orientation: Specifies X-Axis, Y-Axis, or Z-Axis.

– Suppressed: Prior to solving, you can include or exclude the result from the analysis. The default is value
is No.

• Results

– Minimum: Read-only indication of the minimum value of the result tracker type.

– Maximum: Read-only indication of the maximum value of the result tracker type.

Note

When using the Deformation result tracker to graph displacement for a Nonlinear Adaptive
Region (p. 1112), there is a display limitation for the graph. The tracker reads and displays data
contained in the jobname.nlh file. This file contains incremental displacement data collected
after re-meshing occurs. That is, the re-meshed model is considered as a new reference.

Contact
The Contact result tracker is for contact outputs scoped to a given contact pair. Details view categories
and properties include:

Note

You can add Contact Result Trackers while the solution is in progress. The application
automatically sets the Enhanced Tracking property to Yes and the property is read-only.
Normal scoping requirements apply.

Definition
The Definition category includes the following properties.

Release 2020 R1 - © ANSYS, Inc.


1408
Result Trackers

• Type: Specifies the particular contact output. For each of these options, the result tracking is performed
on the Contact side of the pair. If you want to perform the result tracking on the Target side, you should
flip the source and target sides. If this occurs you can change the contact region to Asymmetric (p. 703)
and flip the source and target faces in order to specify the side of interest that is to be the contact side.
If Auto Asymmetric (p. 703) contact is active (either by the Behavior (p. 703) contact region setting
equaling Auto Asymmetric or by the Formulation (p. 707) setting equaling Augmented Lagrange (p. 707)
or MPC (p. 707)) and the contact side is chosen by the program to be disabled, the Results Tracker will
not contain any results (as signified by a value of -2 for Number Contacting output). Contact results
will be valid depending on the type of contact (for example, edge-edge) and the contact formulation.

– Pressure: Maximum pressure.

– Penetration: Maximum penetration.

– Gap: Minimum gap. The values will be reported as negative numbers to signify a gap. A value of zero
is reported if the contact region is in contact (and thus has a penetration). Also, if the region is in far-
field contact (contact faces are outside the pinball radius), then the gap will be equal to the resulting
pinball size for the region.

– Frictional Stress: Maximum frictional stress.

– Sliding Distance: Amplitude of total accumulated sliding when the contact status is sticking or sliding.

– Number Sticking: Number of elements that are sticking.

– Number Contacting (default): Number of elements in contact. A value of -1 means the contact pair
is in far field contact (meaning the faces lie outside the contact pinball region).

– Chattering: Maximum chattering level.

– Elastic Slip: Maximum elastic slip.

– Max Normal Stiffness: Maximum normal stiffness.

– Min Normal Stiffness: Minimum normal stiffness.

– Max Tangential Stiffness: Maximum tangential stiffness.

– Min Tangential Stiffness: Minimum tangential stiffness.

– Contacting Area: The total area of the elements that are in contact.

– Max Damping Pressure: Maximum damping pressure.

– Fluid Pressure: Maximum fluid penetration pressure.

– Min Geometric Sliding Distance: Minimum total sliding distance, including sticking, sliding, and
near-field. For more information, see the GSLID output parameter in the Mechanical APDL Contact
Technology Guide.

– Max Geometric Sliding Distance: Maximum total sliding distance, including sticking, sliding, and
near-field. For more information, see the GSLID output parameter in the Mechanical APDL Contact
Technology Guide.

– Resulting Pinball: Maximum pinball radius.

Release 2020 R1 - © ANSYS, Inc.


1409
Understanding Solving

– Contact Depth: Average contact depth.

– Closed Penetration: Maximum closed (geometrical) penetration.

– Number with Large Penetration: Number of contact points having too much penetration.

– Tangential Damping Stress: Maximum tangential contact damping stress.

– Volume Loss Due to Wear: Total volume lost due to wear for the contact pair (not available for gen-
eral contact).

– Strain Energy: Total strain energy due to contact constraint.

– Frictional Dissipation Energy: Total frictional dissipation energy.

– Stabilization Energy: Total contact stabilization energy.

• Suppressed: Prior to solving, you can include or exclude the result from the analysis. The default is value
is No.

Scope
The Scope category includes the following properties.

• Contact Region: Specifies the particular contact region in the pair. Default names are Contact Region
and Contact Region 2.

• Enhanced Tracking: This property causes your Contact Result Tracker to obtain contact pair-based in-
formation as specified by the Type property (Number Contacting, Penetration, etc.). This takes place
during the solution phase or following a completed solution from the CND file (file.cnd). The default
setting is Yes. See NLDIAG command for additional information.

The No setting reads data from the NLH file. See NLHIST command for additional information.

Note

Enhanced Tracking results are only available when a complete solution is performed
in Mechanical 16.0 or a later version.

Results
The Results category includes the following properties.

• Minimum: Read-only indication of the minimum value of the result tracker type.

• Maximum: Read-only indication of the maximum value of the result tracker type.

Kinetic Energy and Stiffness Energy


The Details view categories and properties for Kinetic Energy and Stiffness Energy include:

• Definition

– Type: Read-only field that displays the type of Results Tracker.

Release 2020 R1 - © ANSYS, Inc.


1410
Adaptive Convergence

– Suppressed: Prior to solving, you can include or exclude the result from the analysis. The default is value
is No.

• Results

– Minimum: Read-only indication of the minimum value of the result tracker type.

– Maximum: Read-only indication of the maximum value of the result tracker type.

Thermal Result Trackers


A Thermal Analysis supports the Temperature Result Tracker only. The Temperature can be applied to
one vertex only using the geometry selection tools or using a geometry-based Named Selection or for
a single node, node-based Named Selection.

Note

Direct graphical node selection requires you to generate the mesh.

The Details view properties and options for the Temperature Result Tracker are described below.

• Definition

– Type: Read-only field that displays the type of Results Tracker.

– Suppressed: Prior to solving, you can include or exclude the result from the analysis. The default is value
is No.

• Scope:

– Scoping Method: Specifies the option Geometry Selection, Named Selection, Global Minimum, or
Global Maximum for a solution point.

– Geometry: visible when Geometry Selection is specified as the Scoping Method. This field allows you to
select and define a single vertex as the geometry or a single node.

– Named Selection: visible when Named Selection is specified as the Scoping Method. This field provides
a list of user-defined Named Selections that are either geometry-based or node-based.

– Global Minimum:

– Global Maximum:

• Results

– Minimum: Read-only indication of the minimum value of the result tracker type.

– Maximum: Read-only indication of the maximum value of the result tracker type.

Adaptive Convergence
You can control the relative accuracy of a solution in two ways. You can use the meshing tools to refine
the mesh before solving, or you can use convergence tools as part of the solution process to refine
solution results on a particular area of the model. This section discusses the latter.

Release 2020 R1 - © ANSYS, Inc.


1411
Understanding Solving

Through its convergence capabilities, the application can fully automate the solution process, internally
controlling the level of accuracy for selected results. You can seek approximate results or adapted/con-
verged results.

This section explains how to interpret accuracy controls.

Converged Results Control


You can control convergence to a predefined level of error for selected results. In the calculation of
stresses, displacements, mode shapes, temperatures, and heat fluxes, the application employs an adaptive
solver engine to identify and refine the model in areas that benefit from adaptive refinement. The cri-
teria for convergence is a prescribed percent change in results. The default is 20%. You can change this
default using the Convergence setting (p. 109) in the Options dialog box (p. 105).

Adaptivity (Refinement of meshes based on solutions)


You can continue to refine the mesh based on a specific solution result. When you pick a result (Equi-
valent Stress, Deformation, Total Flux Density, etc.), indicate that you want to converge on this solution.
You pick a value and the solution is refined such that the solution value does not change by more than
that value.

To add convergence, click the result you added to your solution; for example, Equivalent Stress, Total
Deformation, or Total Flux Density. If you want to converge on deformation, right-click Total Deform-
ation and select Insert> Convergence. In Details View (p. 17), you can specify convergence on either
the Minimum or Maximum value. Additionally, you can specify the Allowable Change between con-
vergence iterations.

Note

• To use Convergence, you must set Calculate Stress to Yes under Output Controls in the Ana-
lysis Settings details panel. However, you can perform Modal and Buckling Analysis without
specifying this option.

• Convergence (p. 1676) objects inserted under an environment that is referenced by an Initial
Condition (p. 1740) object or a Thermal Condition (p. 1139) load object (p. 1746), will invalidate either
of these objects, and not allow a solution to progress.

• When performing an out of process (p. 1376) solution asynchronously, wherein the solve may finalize
during another Workbench session, the application performs only one maximum refinement
loop. As necessary, you must manually perform additional loops. To solve with a single user action,
solve synchronously.

• Results cannot be converged when you have a Mesh Connection object.

• You cannot use Convergence if you have an upstream or a downstream analysis link.

• Convergence is not available when you:

– Import loads into the analysis.

– Activate the Nonlinear Adaptive Region (p. 1112) condition in the analysis.

• Convergence is not supported for:

Release 2020 R1 - © ANSYS, Inc.


1412
Adaptive Convergence

– A model with Layered Sections.

– Design Assessment (p. 1491).

– Solution Combinations (p. 1370).

– Mixed Order Meshing

For an adaptive solution, a solution is first performed on the base mesh, and then the elements are
queried for their solution information (such as deflection, X-stress, Y-stress, etc.). If the element's results
have a high Zienkiewicz-Zhu, or ZZ error (see the Mechanical APDL Theory Reference for more information
on adaptivity theory), the element is placed in the queue to be refined. The application then continues
to refine the mesh and perform additional solutions. Adaptivity will be more robust if your initial mesh
is with tetrahedrons. Adaptive refinement starting from a hex-dominant mesh will automatically result
in a re-meshing of the structure with tetrahedrons. The face mesh given to the tet mesher is the initial
quad mesh split into triangles. That face mesh is then filled with tetrahedrons so it is recommended
that you insert an all tetrahedron mesh method before you start an adaptive solution.

You can control the aggressiveness of the adaptive refinement by adjusting the Refinement Depth
setting under Adaptive Mesh Refinement in the Details view of a Solution object. The default value
is 2 for structural analyses, and 0 for magnetostatic analyses. The range is from 0 to 3. By default, when
adaptive convergence occurs, the program will refine to a depth of 2 elements to help ensure smooth
transitions and avoid excessive element distortion for repeated refinement. However, you can adjust
this refinement depth to a value of 0 or 1 if for a particular problem, the deep refinement is not required
and problem size is a major concern. In general, for mechanical analyses, the default value of 2 is highly
recommended. However, you can lower the value if too much refinement is occurring and is overwhelm-
ing the solution in terms of size of solution time. If you use a value less than 2, be aware of the following:

• Verify that false convergence is not occurring because of too little refinement.

• More refinements may be required to achieve the desired tolerance, which may increase the total solution
time.

The following pictures show the effects of various settings of Refinement Depth on plots of Total De-
formation.

Base Mesh: No Refinement Depth = 0


Refinement

Release 2020 R1 - © ANSYS, Inc.


1413
Understanding Solving

Refinement Depth = 1 Refinement Depth = 2

For magnetostatic analyses, there are additional settings that allow you to change the percentage of
the element selected for adaptive refinement during solution. These settings use an Energy Based
percentage and an Error Based percentage. The internal selection process first uses the Energy Based
percentage to select the number of elements in the full model that have the highest values of magnetic
energy. From this number, it uses the Error Based percentage to select the number of elements with
the highest error in the particular body. Magnetic Error results are also available to display on the
geometry for verification.

These adaptive refinement settings for magnetostatic analyses are in the Refinement Controls group,
located in the Details view of the Solution object, provided you have a Convergence object inserted
under any magnetostatic result (p. 1316). An Element Selection setting in this group has the following
options:

• Program Controlled (default): The percentage of elements selected for adaptive refinement equals the
default values of 10% for the Energy Based percentage and 20% for the Error Based percentage.

• Manual: The percentage of elements selected for adaptive refinement equals the values you enter in the
Energy Based and Error Based fields that appear only when you choose Manual.

Adaptive Convergence in Multiple Result Sets


You can apply adaptive convergence on multiple result sets that may include different loadings or time
points. To do so, create a result for each loading or time point and insert a Convergence object under
each result.

The following example shows Total Deformation results at two time points where a Convergence
object was inserted under each result.

Release 2020 R1 - © ANSYS, Inc.


1414
Adaptive Convergence

ANSYS Workbench Product Adaptive Solutions


Nearly every ANSYS Workbench product result can be calculated to a user-specified accuracy. The spe-
cified accuracy is achieved by means of adaptive and iterative analysis, whereby h-adaptive methodology
is employed. The h-adaptive method begins with an initial finite element model that is refined over
various iterations by replacing coarse elements with finer elements in selected regions of the model.
This is effectively a selective remeshing procedure. The criterion for which elements are selected for
adaptive refinement depends on geometry and on what ANSYS Workbench product results quantities
are requested. The result quantity φ, the expected accuracy E (expressed as a percentage), and the region
R on the geometry that is being subjected to adaptive analysis may be selected. The user-specified ac-
curacy is achieved when convergence is satisfied as follows:

where i denotes the iteration number. It should be clear that results are compared from iteration i to
iteration i+1. Iteration in this context includes a full analysis in which h-adaptive meshing and solving
are performed.

The ANSYS Workbench product uses two different criteria for its adaptive procedures. The first criterion
merely identifies the largest elements (LE), which are deleted and replaced with a finer finite element
representation. The second employs a Zienkiewicz-Zhu (ZZ) norm for stress in structural analysis and
heat flux in thermal analysis.

Table 4: ANSYS Workbench Product Adaptivity Methods

Result Adaptive Criterion


Stresses and strains ZZ norm
Structural margins and factors of safety ZZ norm
Fatigue damage and life ZZ norm
Heat flows ZZ norm
Temperatures ZZ norm
Deformations ZZ norm

Release 2020 R1 - © ANSYS, Inc.


1415
Understanding Solving

Result Adaptive Criterion


Mode frequencies LE

As mentioned above, geometry plays a role in the ANSYS Workbench product adaptive method. In
general, accurate results and solutions can be devised for the entire assembly, a part or a collection of
parts, or a surface or a collection of surfaces. The user makes the decision as to which region of the
geometry applies. If accurate results on a certain surface are desired, the ANSYS Workbench product
ignores the aforementioned criterion and simply refines all elements on the surfaces that make up the
defined region. The reasoning here is that the user restricts the region where accurate results are desired.
In addition, there is nothing limiting the user from having multiple accuracy specification. In other
words, specified accuracy in a selected region and results with specified accuracy over the entire model
can be achieved.

General Notes
Adaptive convergence is not supported for:

• Orthotropic materials.

• Solid shell elements (the SOLSH190 series elements).

Adaptive convergence is not valid:

• For linked environments where the result of one analysis is used as input to another analysis. See the
Define Initial Conditions (p. 186) section for details.

• If a Periodic Region or Cyclic Region symmetry object is defined.

• If an imported load object exists in the environment.

For magnetostatic analyses, Directional Force results allow seeking convergence based on Force
Summation or Torque as opposed to other results converging on Maximum or Minimum values.

Notes About Accuracy


Accuracy acceptance:

• Low levels of accuracy are acceptable for demonstrations, training, and test runs. Allow for a significant level
of uncertainty in interpreting answers. Very low accuracy is never recommended for use in the final validation
of any critical design.

• Moderate levels of accuracy are acceptable for many noncritical design applications. Moderate levels of ac-
curacy should not be used in a final validation of any critical part.

• High levels of accuracy are appropriate for solutions contributing to critical design decisions.

At maximum accuracy, when convergence is not sought, studies of problems with known answers yield
the following behaviors and approximated errors:

• Less than 20% error for peak stresses and strains, and minimum margins and factors of safety.

• Between 5% and 10% error for average (nominal) stresses and elastic strains, and average heat flows.

• Between 1% and 5% error for average stress-related displacements and average calculated temperatures.

Release 2020 R1 - © ANSYS, Inc.


1416
File Management in the Mechanical Application

• 5% or less error for mode frequencies for a wide range of parts.

When seeking highly accurate, converged Results, more computer time and resources will be required
than manual control, except in some cases where the manual preference approaches highest accuracy.

Given the flexible nature of the solver engine, it is impossible to explicitly quantify the effect of a par-
ticular accuracy selection on the calculation of results for an arbitrary problem. Accuracy is related only
to the representation of geometry. Increasing the accuracy preference will not make the material
definition or environmental conditions more accurate. However, specified converged results are nearly
as accurate as the percentage criteria.

Critical components should always be analyzed by an experienced engineer or analyst prior to final
acceptance.

File Management in the Mechanical Application


During the solution, several files are created. Some of these can be deleted after the solution but some
need to be retained for postprocessing or for feeding other subsequent analyses. Since you can perform
several different analyses on a single model or even have several models in the same Mechanical applic-
ation project, you must manage the solution files in a consistent and predictable manner.

Consistent Directory Structure for Mechanical Application Analyses


ANSYS Workbench's file management system keeps multiple databases under a single project. See
Project File Management for a description of the file management system.

Note

The Analysis Settings Details view has an Analysis Data Management (p. 910) grouping
that shows the solution directory location for each analysis.

Solution Files
Default behavior: By default an analysis in the Mechanical application saves only the minimal files re-
quired for postprocessing. Typically these include results files (file.rst, file.rth, file.rmg,
file.psd, file.mcom), input file (ds.dat), output file (solve.out), and some other files that
have valuable information about the solution ( file.BCS, file.nlh, file.gst). Of these only the
results file is generally of significant size.

For Windows users, the solution files folder can be displayed using the Open Solver Files Direct-
ory (p. 910) feature.

Future Analysis: If the results of this analysis are to be used as a load or an initial condition in a sub-
sequent analysis then additional files may need to be saved. Declaring your intent to use this in the
future (p. 910) will automatically save the required files and reuse them in the subsequent analysis. Refer
to Define Initial Conditions (p. 186) for details of these analyses.

Delete Unneeded Files: The solution process creates other files that are typically not needed for
postprocessing or are not used in subsequent analyses. By default, the Mechanical application deletes
these files at the end of solution. However, if for any reason, you want to keep all the files you could
choose to do so (p. 910).

Release 2020 R1 - © ANSYS, Inc.


1417
Understanding Solving

You can use the Output Controls (p. 904) on the analysis settings page to write only the desired result
types to the .rst file (for example, if strains are not needed, you can turn them off which would create
a smaller result file). In addition, for advanced Mechanical APDL application users, Command ob-
jects (p. 1475) can be used to further limit output via the OUTRES command.

An external result file is needed to post results. The following behavior will occur:

• If you save a simulation, any simulation files (result and other required files) will be saved to the new location.

• If you use the Duplicate Without Results option (Environment (p. 1690) and Model (p. 1767) objects only), all
subordinate objects are reproduced with the exception of the data for all result objects. This is based on
the intention that loading changes are performed and the solution process is repeated.

• If you attempt to resolve a previously solved and saved database, the corresponding saved result files are
backed up automatically in case the current solve is not saved.

• The /post1 XML transfer of result files used in previous releases is no longer used so any existing solution
Command objects which were modifying the Mechanical APDL application results to be brought back into
the Mechanical application no longer function.

Solving Units
There are a number of possible unit systems provided for the solution process in the Mechanical applic-
ation. The tables shown below present the solver unit systems for the various quantities. For a given
solution, the application detects the specified unit system in the Units Menu and then converts all
analysis quantities into a consistent unit system prior to sending data to the solver. This makes sure
that the application interprets all unit systems for all quantities correctly for processing as the inputs
and the outputs to the Mechanical APDL application. Note that the GUI may display units that are dif-
ferent than the ones shown below.

Note

• Units of measure specified in Commands objects (p. 1479) are not converted when they are sent
to the solver.

• All magnetostatic analyses solve in the mks system regardless of the user-defined system.

• Note the following Units Menu (p. 67) options.

– Metric (mm, kg, N, s, mV, mA)

– Metric (mm, t, N, s, mV, mA)

– Metric (mm, dat, N, s, mV, mA)


These options differ only by Mass unit: kilogram (kg), metric ton (t), and decaton (dat). However,
the consistent unit system used for the solver is the same for all quantities, i.e. Mass is measured
in tons [t]. For the purposes of this discussion, the following descriptions use only the first option
(mm, kg, N, s, mV, mA), to represent all three of the above interface options.

• All "ton" designations in the table indicate metric ton.

Accelera- Angle (p. 1420) Angular Accelera- Angular Velo- Area (p. 1422)
tion (p. 1419) tion (p. 1421) city (p. 1421)

Release 2020 R1 - © ANSYS, Inc.


1418
Solving Units

Capacit- Charge (p. 1423) Charge Dens- Conductiv- Current (p. 1424)
ance (p. 1422) ity (p. 1423) ity (p. 1424)
Current Dens- Decay Con- Density (p. 1426) Displace- Electric Conduct-
ity (p. 1425) stant (p. 1425) ment (p. 1426) ance Per Unit
Area (p. 1427)
Electric Conduct- Electric Electric Flux Electric Resistiv- Energy (p. 1429)
ivity (p. 1427) Field (p. 1428) Density (p. 1428) ity (p. 1429)
Energy Density Energy Per Film Coeffi- Force (p. 1432) Force Intens-
by Mass (p. 1430) Volume (p. 1431) cient (p. 1431) ity (p. 1432)
Force Per Angu- Fracture Energy Fre- Gasket Stiff- Heat Flux (p. 1435)
lar Unit (p. 1433) (Energy Release quency (p. 1434) ness (p. 1434)
Rate) (p. 1433)
Heat Genera- Heat Rate (p. 1436) Impulse (p. 1436) Impulse Per An- Induct-
tion (p. 1435) gular Unit (p. 1437) ance (p. 1437)
Inverse Inverse Inverse Length (p. 1439) Magnetic Field
Angle (p. 1438) Length (p. 1438) Stress (p. 1439) Intensity (p. 1440)
Magnetic Magnetic Flux Mass (p. 1441) Material Imped- Moment (p. 1442)
Flux (p. 1440) Density (p. 1441) ance (p. 1442)
Moment of Iner- Moment of Iner- Normalized Permeabil- Permittiv-
tia of tia of Value (p. 1444) ity (p. 1445) ity (p. 1445)
Area (p. 1443) Mass (p. 1443)
Poisson's Ra- Power (p. 1446) Pressure (p. 1447) PSD Accelera- PSD Acceleration
tio (p. 1446) tion (p. 1448) (G) (p. 1448)
PSD Displace- PSD PSD Mo- PSD Pres- PSD
ment (p. 1449) Force (p. 1449) ment (p. 1450) sure (p. 1450) Strain (p. 1451)
PSD PSD Velo- Relative Permeab- Relative Permit- Rotational
Stress (p. 1451) city (p. 1452) ility (p. 1452) tivity (p. 1453) Damping (p. 1453)
Rotational Stiff- RS Accelera- RS Displace- RS Strain (p. 1459) RS Stress (p. 1460)
ness (p. 1454) tion (p. 1419) ment (p. 1426)
RS Velo- Seebeck Coeffi- Section Modu- Shear Elastic Shock Velo-
city (p. 1466) cient (p. 1454) lus (p. 1455) Strain (p. 1455) city (p. 1456)
Specific Specific Square Root of Stiffness (p. 1458) Strain (p. 1459)
Heat (p. 1456) Weight (p. 1457) Length (p. 1458)
Stress (p. 1460) Stress Intensity Strength (p. 1459) Thermal Capacit- Thermal Conduct-
Factor (p. 1461) ance (p. 1461) ance - 3D Face
and 2D
Edge (p. 1462)
Thermal Conduct- Thermal Expan- Temperat- Temperature Dif- Temperature
ance - 3D Edge sion (p. 1462) ure (p. 1463) ference (p. 1464) Gradient (p. 1464)
and Ver-
tex (p. 1462)
Time (p. 1465) Translational Velocity (p. 1466) Voltage (p. 1467) Volume (p. 1467)
Damping (p. 1465)

Table 5: Acceleration and RS Acceleration

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meters/second2 [m/s2]

(mks)
cm, g, dyne, oC, s, V, A centimeters/second2 [cm/s2]

Release 2020 R1 - © ANSYS, Inc.


1419
Understanding Solving

Unit System Measured in . . .


(cgs)
mm, kg, N, oC, s, mV, mA millimeters/second2 [mm/s2]

(nmm)
μm, kg, μN, oC, s, V, mA micrometers/second2 [μm/s2]

(μmks)
ft, lbm, lbf, oF, s, V, A feet/second2 [ft/s2]

(Bft)
in, lbm, lbf, oF, s, V, A inches/second2 [in/s2]

(Bin)
mm, mg, ms millimeters/millisecond2 [mm/ms2]

[Explicit Dynamics solvers]


m, kg, s meters/second2 [m/s2]

[ LS-DYNA solver]
mm, t, s millimeters/second2 [mm/s2]

[ LS-DYNA solver]
in,lbf, s inches/second2 [in/s2]

[ LS-DYNA solver]

Table 6: Angle

Unit System Measured in . . .


o
m, kg, N, C, s, V, A radians [rad]

(mks)
cm, g, dyne, oC, s, V, A radians [rad]

(cgs)
mm, kg, N, oC, s, mV, mA radians [rad]

(nmm)
μm, kg, μN, oC, s, V, mA radians [rad]

(μmks)
ft, lbm, lbf, oF, s, V, A radians [rad]

(Bft)

Release 2020 R1 - © ANSYS, Inc.


1420
Solving Units

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A radians [rad]

(Bin)

Table 7: Angular Acceleration

Unit System Measured in . . .


o
m, kg, N, C, s, V, A radians/second2 [rad/s2]

(mks)
cm, g, dyne, oC, s, V, A radians/second2 [rad/s2]

(cgs)
mm, kg, N, oC, s, mV, mA radians/second2 [rad/s2]

(nmm)
μm, kg, μN, oC, s, V, mA radians/second2 [rad/s2]

(μmks)
ft, lbm, lbf, oF, s, V, A radians/second2 [rad/s2]

(Bft)
in, lbm, lbf, oF, s, V, A radians/second2 [rad/s2]

(Bin)

Table 8: Angular Velocity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A radians/second [rad/s]

(mks)
cm, g, dyne, oC, s, V, A radians/second [rad/s]

(cgs)
mm, kg, N, oC, s, mV, mA radians/second [rad/s]

(nmm)
μm, kg, μN, oC, s, V, mA radians/second [rad/s]

(μmks)
ft, lbm, lbf, oF, s, V, A radians/second [rad/s]

(Bft)
in, lbm, lbf, oF, s, V, A radians/second [rad/s]

(Bin)
mm, mg, ms radians/millisecond [rad/ms]

Release 2020 R1 - © ANSYS, Inc.


1421
Understanding Solving

Unit System Measured in . . .


[Explicit Dynamics solvers]
m, kg, s radians/second [rad/s]

[ LS-DYNA solver]
mm, t, s radians/second [rad/s]

[ LS-DYNA solver]
in,lbf, s radians/second [rad/s]

[ LS-DYNA solver]

Table 9: Area

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meters2 [m2]

(mks)
cm, g, dyne, oC, s, V, A centimeters2 [cm2]

(cgs)
mm, kg, N, oC, s, mV, mA millimeters2 [mm2]

(nmm)
μm, kg, μN, oC, s, V, mA micrometers2 [μm2]

(μmks)
ft, lbm, lbf, oF, s, V, A feet2 [ft2]

(Bft)
in, lbm, lbf, oF, s, V, A inches2 [in2]

(Bin)
mm, mg, ms millimeters2 [mm2]

[Explicit Dynamics solvers]


m, kg, s meters2 [m2]

[ LS-DYNA solver]
mm, t, s millimeters2 [mm2]

[ LS-DYNA solver]
in,lbf, s inches2 [in2]

[ LS-DYNA solver]

Table 10: Capacitance

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Farads [F]

Release 2020 R1 - © ANSYS, Inc.


1422
Solving Units

Unit System Measured in . . .


(mks)
cm, g, dyne, oC, s, V, A Farads [F]

(cgs)
mm, kg, N, oC, s, mV, mA microFarads [μF]

(nmm)
μm, kg, μN, oC, s, V, mA picoFarads [pF]

(μmks)
ft, lbm, lbf, oF, s, V, A Farads [F]

(Bft)
in, lbm, lbf, oF, s, V, A Farads [F]

(Bin)

Table 11: Charge

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Coulombs [C]

(mks)
cm, g, dyne, oC, s, V, A Coulombs [C]

(cgs)
mm, kg, N, oC, s, mV, mA milliCoulombs [mC]

(nmm)
μm, kg, μN, oC, s, V, mA picoCoulombs [pC]

(μmks)
ft, lbm, lbf, oF, s, V, A Coulombs [C]

(Bft)
in, lbm, lbf, oF, s, V, A Coulombs [C]

(Bin)

Table 12: Charge Density

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Coulombs/meter2 [C/m2]

(mks)
cm, g, dyne, oC, s, V, A Coulombs/centimeter2 [C/cm2]

(cgs)
mm, kg, N, oC, s, mV, mA milliCoulombs/millimeter2 [mC/mm2]

Release 2020 R1 - © ANSYS, Inc.


1423
Understanding Solving

Unit System Measured in . . .


(nmm)
μm, kg, μN, oC, s, V, mA picoCoulombs/micrometer2 [pC/μm2]

(μmks)
ft, lbm, lbf, oF, s, V, A Coulombs/foot2 [C/ft2]

(Bft)
in, lbm, lbf, oF, s, V, A Coulombs/inch2 [C/in2]

(Bin)

Table 13: Conductivity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Watts/meter * degree Celsius [W/m *
°C]
(mks)
cm, g, dyne, oC, s, V, A dynes/second * degree Celsius [dyne/s *
°C]
(cgs)
mm, kg, N, oC, s, mV, mA ton * millimeters/second3 * degree Celsius
[t * mm/s3 * °C]
(nmm)
μm, kg, μN, oC, s, V, mA picoWatts/micrometers * degree Celsius
[pW/μm * °C]
(μmks)
ft, lbm, lbf, oF, s, V, A slug * feet/second3 * degree Fahrenheit
[(lbm/32.2)ft/s3 * °F]
(Bft)
in, lbm, lbf, oF, s, V, A slinch * inches/second3 * degree Fahrenheit
[(lbm/386.4)in/s3 * °F]
(Bin)

Table 14: Current

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Amperes [A]

(mks)
cm, g, dyne, oC, s, V, A Amperes [A]

(cgs)
mm, kg, N, oC, s, mV, mA milliAmperes [mA]

(nmm)
μm, kg, μN, oC, s, V, mA picoAmperes [pA]

(μmks)
ft, lbm, lbf, oF, s, V, A Amperes [A]

Release 2020 R1 - © ANSYS, Inc.


1424
Solving Units

Unit System Measured in . . .


(Bft)
in, lbm, lbf, oF, s, V, A Amperes [A]

(Bin)

Table 15: Current Density

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Amperes/meter2 [A/m2]

(mks)
cm, g, dyne, oC, s, V, A Amperes/centimeter2 [A/cm2]

(cgs)
mm, kg, N, oC, s, mV, mA milliAmperes/millimeter2 [mA/mm2]

(nmm)
μm, kg, μN, oC, s, V, mA milliAmperes/micrometer2 [mA/μm2]

(μmks)
ft, lbm, lbf, oF, s, V, A Amperes/foot2 [A/ft2]

(Bft)
in, lbm, lbf, oF, s, V, A Amperes/inch2 [A/in2]

(Bin)

Table 16: Decay Constant

Unit System Measured in . . .


o
m, kg, N, C, s, V, A 1/seconds [1/s]

(mks)
cm, g, dyne, oC, s, V, A 1/seconds [1/s]

(cgs)
mm, kg, N, oC, s, mV, mA 1/seconds [1/s]

(nmm)
μm, kg, μN, oC, s, V, mA 1/seconds [1/s]

(μmks)
ft, lbm, lbf, oF, s, V, A 1/seconds [1/s]

(Bft)

Release 2020 R1 - © ANSYS, Inc.


1425
Understanding Solving

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A 1/seconds [1/s]

(Bin)

Table 17: Density

Unit System Measured in . . .


o
m, kg, N, C, s, V, A kilograms/meter3 [kg/m3]

(mks)
cm, g, dyne, oC, s, V, A grams/cm3 [g/cm3]

(cgs)
mm, kg, N, oC, s, mV, mA tons/millimeter3 [t/mm3]

(nmm)
μm, kg, μN, oC, s, V, mA kilograms/micrometer3 [kg/μm3]

(μmks)
ft, lbm, lbf, oF, s, V, A (slug/1)/foot3 [(lbm/32.2)1/ft3]

(Bft)
in, lbm, lbf, oF, s, V, A (slinch/1)/inch3 [(lbm/386.4)1/in3]

(Bin)
mm, mg, ms grams/cm3 [g/cm3]

[Explicit Dynamics solvers]


m, kg, s kilograms/meter3 [kg/m3]

[ LS-DYNA solver]
mm, t, s tons/millimeter3 [t/mm3]

[ LS-DYNA solver]
in,lbf, s (slinch/1)/inch3 [(lbm/386.4)1/in3]

[ LS-DYNA solver]

Table 18: Displacement and RS Displacement

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meters [m]

(mks)
cm, g, dyne, oC, s, V, A centimeters [cm]

(cgs)
mm, kg, N, oC, s, mV, mA millimeters [mm]

Release 2020 R1 - © ANSYS, Inc.


1426
Solving Units

Unit System Measured in . . .


(nmm)
μm, kg, μN, oC, s, V, mA micrometers [μm]

(μmks)
ft, lbm, lbf, oF, s, V, A feet [ft]

(Bft)
in, lbm, lbf, oF, s, V, A inches [in]

(Bin)
mm, mg, ms millimeters [mm]

[Explicit Dynamics solvers]


m, kg, s meters [m]

[ LS-DYNA solver]
mm, t, s millimeters [mm]

[ LS-DYNA solver]
in,lbf, s inches [in]

[ LS-DYNA solver]

Table 19: Electric Conductance Per Unit Area

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Siemens/meter2 [S/m2]

(mks)
cm, g, dyne, oC, s, V, A Siemens/centimeter2 [S/cm2]

(cgs)
mm, kg, N, oC, s, mV, mA Siemens/millimeter2 [S/mm2]

(nmm)
μm, kg, μN, oC, s, V, mA picoSiemens/micrometer2 [pS/μm2]

(μmks)
ft, lbm, lbf, oF, s, V, A Siemens/foot2 [S/ft2]

(Bft)
in, lbm, lbf, oF, s, V, A Siemens/inch2 [S/in2]

(Bin)

Table 20: Electric Conductivity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Siemens/meter [S/m]

Release 2020 R1 - © ANSYS, Inc.


1427
Understanding Solving

Unit System Measured in . . .


(mks)
cm, g, dyne, oC, s, V, A Siemens/centimeter [S/cm]

(cgs)
mm, kg, N, oC, s, mV, mA Siemens/millimeter [S/mm]

(nmm)
μm, kg, μN, oC, s, V, mA picoSiemens/micrometer [pS/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A Siemens/foot [S/ft]

(Bft)
in, lbm, lbf, oF, s, V, A Siemens/inch [S/in]

(Bin)

Table 21: Electric Field

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Volts/meter [V/m]

(mks)
cm, g, dyne, oC, s, V, A Volts/centimeter [V/cm]

(cgs)
mm, kg, N, oC, s, mV, mA milliVolts/millimeter [mV/mm]

(nmm)
μm, kg, μN, oC, s, V, mA Volts/micrometer [V/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A Volts/foot [V/ft]

(Bft)
in, lbm, lbf, oF, s, V, A Volts/inch [V/in]

(Bin)

Table 22: Electric Flux Density

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Coulombs/meter2 [C/m2]

(mks)
cm, g, dyne, oC, s, V, A Coulombs/centimeter2 [C/cm2]

(cgs)
mm, kg, N, oC, s, mV, mA milliCoulombs/millimeter2 [mC/mm2]

Release 2020 R1 - © ANSYS, Inc.


1428
Solving Units

Unit System Measured in . . .


(nmm)
μm, kg, μN, oC, s, V, mA picoCoulombs/micrometer2 [pC/μm2]

(μmks)
ft, lbm, lbf, oF, s, V, A Coulombs/foot2 [C/ft2]

(Bft)
in, lbm, lbf, oF, s, V, A Coulombs/inch2 [C/in2]

(Bin)

Table 23: Electric Resistivity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Ohm * meters [Ohm * m]

(mks)
cm, g, dyne, oC, s, V, A Ohm * centimeters [Ohm * cm]

(cgs)
mm, kg, N, oC, s, mV, mA Ohm * millimeters [Ohm * mm]

(nmm)
μm, kg, μN, oC, s, V, mA teraOhm * micrometers [Tohm * μm]

(μmks)
ft, lbm, lbf, oF, s, V, A Ohm * Cir-mils/foot [Ohm * Cir-mil/ft]

(Bft)
in, lbm, lbf, oF, s, V, A Ohm * Cir-mils/inch [Ohm * Cir-mil/in]

(Bin)

Table 24: Energy

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Joules [J]

(mks)
cm, g, dyne, oC, s, V, A ergs [erg]

(cgs)
mm, kg, N, oC, s, mV, mA milliJoules [mJ]

(nmm)
μm, kg, μN, oC, s, V, mA picoJoules [pJ]

(μmks)
ft, lbm, lbf, oF, s, V, A slug * feet2/second2 [(lbm/32.2)ft2/s2]

Release 2020 R1 - © ANSYS, Inc.


1429
Understanding Solving

Unit System Measured in . . .


(Bft)
in, lbm, lbf, oF, s, V, A slinch * inches2/second2 [(lbm/386.4)in2/s2]

(Bin)
mm, mg, ms microJoules [μJ]

[Explicit Dynamics solvers]


m, kg, s Joules [J]

[ LS-DYNA solver]
mm, t, s milliJoules [mJ]

[ LS-DYNA solver]
in,lbf, s slinch * inches2/second2 [(lbm/386.4)in2/s2]

[ LS-DYNA solver]

Table 25: Energy Density by Mass

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Joules/kilograms [J/kg]

(mks)
cm, g, dyne, oC, s, V, A dynes * centimeters/grams [dyne * cm /g]

(cgs)
mm, kg, N, oC, s, mV, mA milliJoules/tons [mJ/t]

(nmm)
μm, kg, μN, oC, s, V, mA picoJoules/kilograms [pJ/kg]

(μmks)
ft, lbm, lbf, oF, s, V, A feet2 /seconds2 [ft2/s2]

(Bft)
in, lbm, lbf, oF, s, V, A inches2/seconds2 [in2/sec 2]

(Bin)
mm, mg, ms Joules/kilograms [J/kg]

[Explicit Dynamics solvers]


m, kg, s Joules/kilograms [J/kg]

[ LS-DYNA solver]
mm, t, s milliJoules/tons [mJ/t]

[ LS-DYNA solver]

Release 2020 R1 - © ANSYS, Inc.


1430
Solving Units

Unit System Measured in . . .


in,lbf, s inches2/seconds2 [in2/sec 2]

[ LS-DYNA solver]

Table 26: Energy Per Volume

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Joules/meter3 [J/m3]

(mks)
cm, g, dyne, oC, s, V, A ergs/centimeter3 [erg/cm3]

(cgs)
mm, kg, N, oC, s, mV, mA milliJoules/millimeter3 [mJ/mm3]

(nmm)
μm, kg, μN, oC, s, V, mA picoJoules/micrometer3 [pJ * um3]

(μmks)
ft, lbm, lbf, oF, s, V, A slug * foot2/second2 * feet3[(lbm/32.2) *
ft2/s2 * ft3]
(Bft)
in, lbm, lbf, oF, s, V, A slinch * inch2/second2 * inch3 [(lbm/386.4)
* in2/s2 * in3)]
(Bin)

Table 27: Film Coefficient

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Watts/meter2 * degree Celsius [W/m2 * °C]

(mks)
cm, g, dyne, oC, s, V, A dyne/second * centimeter * degree Celsius
[dyne/s * cm * °C]
(cgs)
mm, kg, N, oC, s, mV, mA tons/second3 * degree Celsius [t/s3 * °C]

(nmm)
μm, kg, μN, oC, s, V, mA picoWatts/micrometer2 * degree Celsius
[pW/μm2 * °C]
(μmks)
ft, lbm, lbf, oF, s, V, A (slug/1)/second3 * degree Fahrenheit
[(lbm/32.2)1/s3 * °F]
(Bft)

Release 2020 R1 - © ANSYS, Inc.


1431
Understanding Solving

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A (slinch/1)/second3 * degree Fahrenheit
[(lbm/386.4)1/s3 * °F]
(Bin)

Table 28: Force

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newtons [N]

(mks)
cm, g, dyne, oC, s, V, A dynes [dyne]

(cgs)
mm, kg, N, oC, s, mV, mA ton * millimeters/second2 [t * mm/s2]

(nmm)
μm, kg, μN, oC, s, V, mA microNewtons [μN]

(μmks)
ft, lbm, lbf, oF, s, V, A slug * feet/second2 [(lbm/32.2)ft/s2]

(Bft)
in, lbm, lbf, oF, s, V, A slinch * inches/second2 [(lbm/386.4)in/s2]

(Bin)
mm, mg, ms milliNewtons [mN]

[Explicit Dynamics solvers]


m, kg, s Newtons [N]

[ LS-DYNA solver]
mm, t, s Newtons [N]

[ LS-DYNA solver]
in,lbf, s pound force (lbf )

[ LS-DYNA solver]

Table 29: Force Intensity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newtons/meter [N/m]

(mks)
cm, g, dyne, oC, s, V, A dynes/centimeter [dyne/cm]

(cgs)
mm, kg, N, oC, s, mV, mA tons/second2 [t/s2]

Release 2020 R1 - © ANSYS, Inc.


1432
Solving Units

Unit System Measured in . . .


(nmm)
μm, kg, μN, oC, s, V, mA microNewtons/micrometer [μN/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A (slug/1)/second2 [(lbm/32.2)1/s2]

(Bft)
in, lbm, lbf, oF, s, V, A (slinch/1)/second2 [(lbm/386.4)1/s2]

(Bin)
mm, mg, ms Newtons/meter [N/m] or
milliNewtons/millimeter [mN/mm]
[Explicit Dynamics solvers]
m, kg, s Newtons/meter [N/m]

[ LS-DYNA solver]
mm, t, s Newtons/millimeter [N/mm]

[ LS-DYNA solver]
in,lbf, s pound force/inch [lbf/in]

[ LS-DYNA solver]

Table 30: Force Per Angular Unit

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newtons/radian [N/rad]

(mks)
cm, g, dyne, oC, s, V, A dynes/radian [dyne/rad]

(cgs)
mm, kg, N, oC, s, mV, mA Newtons/radian [N/rad]

(nmm)
μm, kg, μN, oC, s, V, mA microNewtons/radian [μN/rad]

(μmks)
ft, lbm, lbf, oF, s, V, A pounds mass/radian [lbf/rad]

(Bft)
in, lbm, lbf, oF, s, V, A pounds mass/radian [lbf/rad]

(Bin)

Table 31: Fracture Energy (Energy Release Rate)

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Joules/meter2 [J/m2]

Release 2020 R1 - © ANSYS, Inc.


1433
Understanding Solving

Unit System Measured in . . .


(mks)
cm, g, dyne, oC, s, V, A erg/centimeter2 [erg/cm2]

(cgs)
mm, kg, N, oC, s, mV, mA milliJoules/millimeter2 [mJ/mm2]

(nmm)
μm, kg, μN, oC, s, V, mA picoJoules/micrometer2 [pJ/μm2]

(μmks)
ft, lbm, lbf, oF, s, V, A slug * feet2/seconds2 * feet2 [(lbm-ft2)/(s2)
* ft2
(Bft)
in, lbm, lbf, oF, s, V, A slinch * inch2/seconds2 * inch2 [(lbm-in2)/(s2)
* in2
(Bin)

Table 32: Frequency

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Hertz[Hz]

(mks)
cm, g, dyne, oC, s, V, A Hertz[Hz]

(cgs)
mm, kg, N, oC, s, mV, mA Hertz[Hz]

(nmm)
μm, kg, μN, oC, s, V, mA Hertz[Hz]

(μmks)
ft, lbm, lbf, oF, s, V, A Hertz[Hz]

(Bft)
in, lbm, lbf, oF, s, V, A Hertz[Hz]

(Bin)

Table 33: Gasket Stiffness

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Pascals/meter [Pa/m]

(mks)
cm, g, dyne, oC, s, V, A dynes/centimeter3 [dyne/cm3]

(cgs)
mm, kg, N, oC, s, mV, mA tons/second2 * millimeter2 [t/s2 * mm2]

Release 2020 R1 - © ANSYS, Inc.


1434
Solving Units

Unit System Measured in . . .


(nmm)
μm, kg, μN, oC, s, V, mA megaPascals/micrometer [MPa/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A slug/second2 * foot2 [(lbm/32.2)/s2 * ft2]

(Bft)
in, lbm, lbf, oF, s, V, A slinch/second2 * inch2 [(lbm/386.4)/s2 * in2]

(Bin)

Table 34: Heat Flux

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Watts/meter2 [W/m2]

(mks)
cm, g, dyne, oC, s, V, A dynes/second * centimeter [dyne/s * cm]

(cgs)
mm, kg, N, oC, s, mV, mA tons/second3 [t/s3]

(nmm)
μm, kg, μN, oC, s, V, mA picoWatts/micrometer2 [pW/μm2]

(μmks)
ft, lbm, lbf, oF, s, V, A (slug/1)/second3 [(lbm/32.2)1/s3]

(Bft)
in, lbm, lbf, oF, s, V, A (slinch/1)/second3 [(lbm/386.4)1/s3]

(Bin)

Table 35: Heat Generation

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Watts/meter3 [W/m3]

(mks)
cm, g, dyne, oC, s, V, A dynes/second * centimeter2 [dyne/s * cm2]

(cgs)
mm, kg, N, oC, s, mV, mA tons/second3 * millimeter [t/s3 * mm]

(nmm)
μm, kg, μN, oC, s, V, mA picoWatts/micrometer3 [pW/μm3]

(μmks)
ft, lbm, lbf, oF, s, V, A (slug/1)/second3 * foot [(lbm/32.2)1/s3 * ft]

Release 2020 R1 - © ANSYS, Inc.


1435
Understanding Solving

Unit System Measured in . . .


(Bft)
in, lbm, lbf, oF, s, V, A (slinch/1)/second3 * inch [(lbm/386.4)1/s3 *
in]
(Bin)

Table 36: Heat Rate

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Watts [W]

(mks)
cm, g, dyne, oC, s, V, A dyne * centimeters/second [dyne * cm/s]

(cgs)
mm, kg, N, oC, s, mV, mA ton * millimeters2/second3 [t * mm2/s3]

(nmm)
μm, kg, μN, oC, s, V, mA picoWatts [pW]

(μmks)
ft, lbm, lbf, oF, s, V, A slug * feet2/second3 [(lbm/32.2) * ft2/s3]

(Bft)
in, lbm, lbf, oF, s, V, A slinch * inches2/second3 [(lbm/386.4) *
in2/s3]
(Bin)

Table 37: Impulse

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newton * second [N * s]

(mks)
cm, g, dyne, oC, s, V, A dyne * second [dyne * s]

(cgs)
mm, kg, N, oC, s, mV, mA Newton * second [N * s]

(nmm)
μm, kg, μN, oC, s, V, mA microNewton * second [μN * s]

(μmks)
ft, lbm, lbf, oF, s, V, A pounds mass * second [lbf * s]

(Bft)
in, lbm, lbf, oF, s, V, A pounds mass * second [lbf * s]

(Bin)
mm, mg, ms microNewton * second [μN * s]

Release 2020 R1 - © ANSYS, Inc.


1436
Solving Units

Unit System Measured in . . .


[Explicit Dynamics solvers]
m, kg, s Newton * second [N * s]

[ LS-DYNA solver]
mm, t, s Newton * second [N * s]

[ LS-DYNA solver]
in,lbf, s pound force * second (lbf * second)

[ LS-DYNA solver]

Table 38: Impulse Per Angular Unit

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newton * second/rad [N * s/rad]

(mks)
cm, g, dyne, oC, s, V, A dyne * second/radian [dyne * s/rad]

(cgs)
mm, kg, N, oC, s, mV, mA Newton * second/rad [N * s/rad]

(nmm)
μm, kg, μN, oC, s, V, mA microNewton * second/radian [μN * s/rad]

(μmks)
ft, lbm, lbf, oF, s, V, A pounds mass * second/radian [lbf * s/rad]

(Bft)
in, lbm, lbf, oF, s, V, A pounds mass * second/radian [lbf * s/rad]

(Bin)

Table 39: Inductance

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Henries [H]

(mks)
cm, g, dyne, oC, s, V, A Henries [H]

(cgs)
mm, kg, N, oC, s, mV, mA milliHenries [mH]

(nmm)
μm, kg, μN, oC, s, V, mA teraHenries [TH]

(μmks)
ft, lbm, lbf, oF, s, V, A Henries [H]

Release 2020 R1 - © ANSYS, Inc.


1437
Understanding Solving

Unit System Measured in . . .


(Bft)
in, lbm, lbf, oF, s, V, A Henries [H]

(Bin)

Table 40: Inverse Angle

Unit System Measured in . . .


o
m, kg, N, C, s, V, A 1/radians [1/rad]

(mks)
cm, g, dyne, oC, s, V, A 1/radians [1/rad]

(cgs)
mm, kg, N, oC, s, mV, mA 1/radians [1/rad]

(nmm)
μm, kg, μN, oC, s, V, mA 1/radians [1/rad]

(μmks)
ft, lbm, lbf, oF, s, V, A 1/radians [1/rad]

(Bft)
in, lbm, lbf, oF, s, V, A 1/radians [1/rad]

(Bin)

Note

The units presented above are applicable when the Units menu is set to Radians. The ap-
plicable units are 1/degree [1/o] when the Units menu is set to Degrees.

Table 41: Inverse Length

Unit System Measured in . . .


o
m, kg, N, C, s, V, A 1/meter [1/m]

(mks)
cm, g, dyne, oC, s, V, A 1/centimeter [1/cm]

(cgs)
mm, kg, N, oC, s, mV, mA 1/millimeter [1/mm]

(nmm)
μm, kg, μN, oC, s, V, mA 1/micrometer [1/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A 1/foot [1/ft]

Release 2020 R1 - © ANSYS, Inc.


1438
Solving Units

Unit System Measured in . . .


(Bft)
in, lbm, lbf, oF, s, V, A 1/inch [1/in]

(Bin)

Table 42: Inverse Stress

Unit System Measured in . . .


o
m, kg, N, C, s, V, A 1/Pascal [1/Pa]

(mks)
cm, g, dyne, oC, s, V, A centimeters2/dyne [cm2/dyne]

(cgs)
mm, kg, N, oC, s, mV, mA second2 * millimeters/ton [s2 * mm/t]

(nmm)
μm, kg, μN, oC, s, V, mA 1/megaPascal [1/MPa]

(μmks)
ft, lbm, lbf, oF, s, V, A second2 * feet/slug [s2 * ft/(lbm/32.2)]

(Bft)
in, lbm, lbf, oF, s, V, A second2 * inch/slinch [s2 * in/(lbm/386.4)]

(Bin)

Table 43: Length

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meters [m]

(mks)
cm, g, dyne, oC, s, V, A centimeters [cm]

(cgs)
mm, kg, N, oC, s, mV, mA millimeters [mm]

(nmm)
μm, kg, μN, oC, s, V, mA micrometers [μm]

(μmks)
ft, lbm, lbf, oF, s, V, A feet [ft]

(Bft)
in, lbm, lbf, oF, s, V, A inches [in]

(Bin)
mm, mg, ms millimeters [mm]

Release 2020 R1 - © ANSYS, Inc.


1439
Understanding Solving

Unit System Measured in . . .


[Explicit Dynamics solvers]
m, kg, s meters [m]

[ LS-DYNA solver]
mm, t, s millimeters [mm]

[ LS-DYNA solver]
in,lbf, s inches [in]

[ LS-DYNA solver]

Table 44: Magnetic Field Intensity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Amperes/meter [A/m]

(mks)
cm, g, dyne, oC, s, V, A Oersteds [Oe]

(cgs)
mm, kg, N, oC, s, mV, mA milliAmperes/millimeter [mA/mm]

(nmm)
μm, kg, μN, oC, s, V, mA picoAmperes/micrometer [pA/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A Amperes/foot [A/ft]

(Bft)
in, lbm, lbf, oF, s, V, A Amperes/inch [A/in]

(Bin)

Table 45: Magnetic Flux

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Webers [Wb]

(mks)
cm, g, dyne, oC, s, V, A Maxwells [Mx]

(cgs)
mm, kg, N, oC, s, mV, mA milliWebers [mWb]

(nmm)
μm, kg, μN, oC, s, V, mA Webers [Wb]

(μmks)
ft, lbm, lbf, oF, s, V, A Lines

Release 2020 R1 - © ANSYS, Inc.


1440
Solving Units

Unit System Measured in . . .


(Bft)
in, lbm, lbf, oF, s, V, A Lines

(Bin)

Table 46: Magnetic Flux Density

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Teslas [T]

(mks)
cm, g, dyne, oC, s, V, A Gauss [G]

(cgs)
mm, kg, N, oC, s, mV, mA milliTeslas [mT]

(nmm)
μm, kg, μN, oC, s, V, mA teraTeslas [TT]

(μmks)
ft, lbm, lbf, oF, s, V, A Lines/foot2 [lines/ft2]

(Bft)
in, lbm, lbf, oF, s, V, A Lines/inch2 [lines/in2]

(Bin)

Table 47: Mass

Unit System Measured in . . .


o
m, kg, N, C, s, V, A kilograms [kg]

(mks)
cm, g, dyne, oC, s, V, A grams [g]

(cgs)
mm, kg, N, oC, s, mV, mA tons [t]

(nmm)
μm, kg, μN, oC, s, V, mA kilograms [kg]

(μmks)
ft, lbm, lbf, oF, s, V, A slug [lbm/32.2]

(Bft)
in, lbm, lbf, oF, s, V, A slinch [lbm/386.4]

(Bin)
mm, mg, ms milligrams [mg]

Release 2020 R1 - © ANSYS, Inc.


1441
Understanding Solving

Unit System Measured in . . .


[Explicit Dynamics solvers]
m, kg, s kilograms [kg]

[ LS-DYNA solver]
mm, t, s tons [t]

[ LS-DYNA solver]
in,lbf, s slinch [lbm/386.4]

[ LS-DYNA solver]

Table 48: Material Impedance

Unit System Measured in . . .


mm, mg, ms milligrams/millimeter2/second [mg/mm2/s]

[Explicit Dynamics solvers]


m, kg, s kilograms/meter2/second [kg/m2/s]

[ LS-DYNA solver]
mm, t, s tons/millimeter2/second [t/mm2/s]

[ LS-DYNA solver]
in,lbf, s slinch/inch2/second [slinch/in2/s]

[ LS-DYNA solver]

Table 49: Moment

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newton * meters [N * m]

(mks)
cm, g, dyne, oC, s, V, A dyne * centimeters [dyne * cm]

(cgs)
mm, kg, N, oC, s, mV, mA ton * millimeters2/second2 [t * mm2/s2]

(nmm)
μm, kg, μN, oC, s, V, mA microNewton * micrometers [μN * μm]

(μmks)
ft, lbm, lbf, oF, s, V, A slug * feet2/second2 [(lbm/32.2) * ft2/s2]

(Bft)
in, lbm, lbf, oF, s, V, A slinch * inches2/second2 [(lbm/386.4) *
in2/s2]
(Bin)
mm, mg, ms microNewton * meters [μN * m]

Release 2020 R1 - © ANSYS, Inc.


1442
Solving Units

Unit System Measured in . . .


[Explicit Dynamics solvers]
m, kg, s Newton * meters [N * m]

[ LS-DYNA solver]
mm, t, s Newton * millimeters [N * mm]

[ LS-DYNA solver]
in,lbf, s pound force * inch [lbf * in]

[ LS-DYNA solver]

Table 50: Moment of Inertia of Area

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meters4 [m4]

(mks)
cm, g, dyne, oC, s, V, A centimeters4 [cm4]

(cgs)
mm, kg, N, oC, s, mV, mA millimeters4 [mm4]

(nmm)
μm, kg, μN, oC, s, V, mA micrometers4 [μm4]

(μmks)
ft, lbm, lbf, oF, s, V, A feet4 [ft4]

(Bft)
in, lbm, lbf, oF, s, V, A inches4 [in4]

(Bin)
mm, mg, ms millimeters4 [mm4]

[Explicit Dynamics solvers]


m, kg, s meters4 [m4]

[ LS-DYNA solver]
mm, t, s millimeters4 [mm4]

[ LS-DYNA solver]
in,lbf, s inches4 [in4]

[ LS-DYNA solver]

Table 51: Moment of Inertia of Mass

Unit System Measured in . . .


o
m, kg, N, C, s, V, A kilogram * meter2 [kg * m2]

Release 2020 R1 - © ANSYS, Inc.


1443
Understanding Solving

Unit System Measured in . . .


(mks)
cm, g, dyne, oC, s, V, A gram * centimeter2 [g * cm2]

(cgs)
mm, kg, N, oC, s, mV, mA kilogram * millimeter2 [kg * mm2]

(nmm)
μm, kg, μN, oC, s, V, mA kilogram * micrometer2 [kg * μm2]

(μmks)
ft, lbm, lbf, oF, s, V, A slug * feet2 [(lbm/32.2) * ft2]

(Bft)
in, lbm, lbf, oF, s, V, A slinch * inch2 [(lbm/386.4) * in2]

(Bin)
mm, mg, ms milligram * millimeter2 [mg * mm2]

[Explicit Dynamics solvers]


m, kg, s kilogram * meter2 [kg * m2]

[ LS-DYNA solver]
mm, t, s ton * millimeter2 [t * mm2]

[ LS-DYNA solver]
in,lbf, s slinch * inch2 [slinch * in2]

[ LS-DYNA solver]

Table 52: Normalized Value

Unit System Measured in . . .


o
m, kg, N, C, s, V, A unitless

(mks)
cm, g, dyne, oC, s, V, A unitless

(cgs)
mm, kg, N, oC, s, mV, mA unitless

(nmm)
μm, kg, μN, oC, s, V, mA unitless

(μmks)
ft, lbm, lbf, oF, s, V, A unitless

(Bft)

Release 2020 R1 - © ANSYS, Inc.


1444
Solving Units

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A unitless

(Bin)

Table 53: Permeability

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Henries/meter [H/m]

(mks)
cm, g, dyne, oC, s, V, A Henries/centimeter [H/cm]

(cgs)
mm, kg, N, oC, s, mV, mA milliHenries/millimeter [mH/mm]

(nmm)
μm, kg, μN, oC, s, V, mA teraHenries/micrometer [TH/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A Henries/foot [H/ft]

(Bft)
in, lbm, lbf, oF, s, V, A Henries/inch [H/in]

(Bin)

Table 54: Permittivity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Farads/meter [F/m]

(mks)
cm, g, dyne, oC, s, V, A Farads/centimeter [F/cm]

(cgs)
mm, kg, N, oC, s, mV, mA microFarads/millimeter [μF/mm]

(nmm)
μm, kg, μN, oC, s, V, mA picoFarads/micrometer [pF/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A Farads/foot [F/ft]

(Bft)

Release 2020 R1 - © ANSYS, Inc.


1445
Understanding Solving

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A Farads/inch [F/in]

(Bin)

Table 55: Poisson's Ratio

Unit System Measured in . . .


o
m, kg, N, C, s, V, A unitless

(mks)
cm, g, dyne, oC, s, V, A unitless

(cgs)
mm, kg, N, oC, s, mV, mA unitless

(nmm)
μm, kg, μN, oC, s, V, mA unitless

(μmks)
ft, lbm, lbf, oF, s, V, A unitless

(Bft)
in, lbm, lbf, oF, s, V, A unitless

(Bin)
mm, mg, ms unitless

[Explicit Dynamics solvers]


m, kg, s unitless

[ LS-DYNA solver]
mm, t, s unitless

[ LS-DYNA solver]
in,lbf, s unitless

[ LS-DYNA solver]

Table 56: Power

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Watts [W]

(mks)
cm, g, dyne, oC, s, V, A dyne * centimeters/second [dyne * c/s]

(cgs)
mm, kg, N, oC, s, mV, mA ton * millimeters2/second3 [t * mm2/s3]

Release 2020 R1 - © ANSYS, Inc.


1446
Solving Units

Unit System Measured in . . .


(nmm)
μm, kg, μN, oC, s, V, mA picoWatts [pW]

(μmks)
ft, lbm, lbf, oF, s, V, A slug * feet2/second3 [(lbm/32.2) * ft2/s3]

(Bft)
in, lbm, lbf, oF, s, V, A slinch * inches2/second3 [(lbm/386.4) *
in2/s3]
(Bin)
mm, mg, ms milliWatts [mW]

[Explicit Dynamics solvers]


m, kg, s Watts [W]

[ LS-DYNA solver]
mm, t, s Newton * millimeters/second [N * mm/s]

[ LS-DYNA solver]
in,lbf, s pound force * inch/second [lbf * in/s]

[ LS-DYNA solver]

Table 57: Pressure

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Pascals [Pa]

(mks)
cm, g, dyne, oC, s, V, A dynes/centimeter2 [dyne/cm2]

(cgs)
mm, kg, N, oC, s, mV, mA ton/second2 * millimeters [t/s2 * mm]

(nmm)
μm, kg, μN, oC, s, V, mA megaPascals [MPa]

(μmks)
ft, lbm, lbf, oF, s, V, A (slug/1)/second2 * foot [(lbm/32.2)1/s2 * ft]

(Bft)
in, lbm, lbf, oF, s, V, A (slinch/1)/second2 * inch [(lbm/386.4)1/s2 *
in]
(Bin)
mm, mg, ms kiloPascals [kPa]

[Explicit Dynamics solvers]


m, kg, s Pascals [Pa]

Release 2020 R1 - © ANSYS, Inc.


1447
Understanding Solving

Unit System Measured in . . .


[ LS-DYNA solver]
mm, t, s megaPascals [MPa]

[ LS-DYNA solver]
in,lbf, s pounds/inch2 [lb/in2]

[ LS-DYNA solver]

Table 58: PSD Acceleration

Unit System Measured in . . .


o
m, kg, N, C, s, V, A (meters/second2)2/Hertz [(m/s2)2/Hz]

(mks)
cm, g, dyne, oC, s, V, A (centimeters/second2)2/Hertz [(cm/s2)2/Hz]

(cgs)
mm, kg, N, oC, s, mV, mA (millimeters/second2)2/Hertz [(mm/s2)2/Hz]

(nmm)
μm, kg, μN, oC, s, V, mA (micrometers/second2)2/megahertz
[(μm/s2)2/MHz]
(μmks)
ft, lbm, lbf, oF, s, V, A (feet/second2)2/Hertz [(ft/s2)2/Hz]

(Bft)
in, lbm, lbf, oF, s, V, A (inch/second2)2/Hertz [(in/s2)2/Hz]

(Bin)

Table 59: PSD Acceleration (G)

Unit System Measured in . . .


o
m, kg, N, C, s, V, A G2/Hertz [G2/Hz]

(mks)
cm, g, dyne, oC, s, V, A G2/Hertz [G2/Hz]

(cgs)
mm, kg, N, oC, s, mV, mA G2/Hertz [G2/Hz]

(nmm)
μm, kg, μN, oC, s, V, mA G2/Hertz [G2/Hz]

(μmks)
ft, lbm, lbf, oF, s, V, A G2/Hertz [G2/Hz]

(Bft)

Release 2020 R1 - © ANSYS, Inc.


1448
Solving Units

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A G2/Hertz [G2/Hz]

(Bin)

Table 60: PSD Displacement

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meters2/Hertz [m2/Hz]

(mks)
cm, g, dyne, oC, s, V, A centimeters2/Hertz [cm2/Hz]

(cgs)
mm, kg, N, oC, s, mV, mA millimeters2/Hertz [mm2/Hz]

(nmm)
μm, kg, μN, oC, s, V, mA micrometers2/megaHertz [μm2/MHz]

(μmks)
ft, lbm, lbf, oF, s, V, A feet2/Hertz [ft2/Hz]

(Bft)
in, lbm, lbf, oF, s, V, A inches2/Hertz [in2/Hz]

(Bin)

Table 61: PSD Force

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newtons2/Hertz [N2/Hz]

(mks)
cm, g, dyne, oC, s, V, A dynes2/Hertz [dyne2/Hz]

(cgs)
mm, kg, N, oC, s, mV, mA ((kilograms.millimeters)/second2)2/Hertz [((kg
* mm)/s2)2/Hz]
(nmm)
μm, kg, μN, oC, s, V, mA microNewtons2/Hertz [μN2/Hz]

(μmks)
ft, lbm, lbf, oF, s, V, A ((pounds * mass/32.2) *
feet)/second2))2/Hertz [((lb * m/32.2) *
(Bft) ft/s2))2/Hz]

Release 2020 R1 - © ANSYS, Inc.


1449
Understanding Solving

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A ((pounds * mass/32.2) *
inches)/second2))2/Hertz [((lb * m/32.2) *
(Bin) in/s2))2/Hz]

Table 62: PSD Moment

Unit System Measured in . . .


o
m, kg, N, C, s, V, A (Newtons * meters)2/Hertz [(N * m)2/Hz]

(mks)
cm, g, dyne, oC, s, V, A (dynes * centimeters)2/Hertz [(dyne *
cm)2/Hz]
(cgs)
mm, kg, N, oC, s, mV, mA ((kilograms * millimeters2)/Second2)2/Hertz
[((kg * mm2)/s2)2/Hz]
(nmm)
μm, kg, μN, oC, s, V, mA (microNewtons * micrometers)2/Hertz [(μN
* μm)2/Hz]
(μmks)
ft, lbm, lbf, oF, s, V, A ((pounds * mass/32.2) * feet2)/second2)
2
/Hertz [((lb * m/32.2) * ft2)/s2)2/Hz]
(Bft)
in, lbm, lbf, oF, s, V, A ((pounds * mass/386.4) *
inches2)/second2)2/Hertz [((lb * m/386.4) *
(Bin) in2)/s2)2/Hz]

Table 63: PSD Pressure

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Pascals2/Hertz [Pa2/Hz]

(mks)
cm, g, dyne, oC, s, V, A (dynes/centimeter2)2/Hertz [(dyne/cm2)2/Hz]

(cgs)
mm, kg, N, oC, s, mV, mA (kilograms/(millimeter * second2))2/Hertz
[(kg/(mm * s2))2/Hz]
(nmm)
μm, kg, μN, oC, s, V, mA megaNewtons2/Hertz [MPa2/Hz]

(μmks)
ft, lbm, lbf, oF, s, V, A (slug/(foot * second2))2/Hertz [((lbm/32.2)/(ft
* s2))2/Hz]
(Bft)

Release 2020 R1 - © ANSYS, Inc.


1450
Solving Units

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A (slinch/(inch * second2))2/Hertz
[((lbm/386.4)/(in * s2))2/Hz]
(Bin)

Table 64: PSD Strain

Unit System Measured in . . .


o
m, kg, N, C, s, V, A (meters/meter)2/Hertz [(m/m)2/Hz]

(mks)
cm, g, dyne, oC, s, V, A (centimeters/centimeter)2/Hertz
[(cm/cm)2/Hz]
(cgs)
mm, kg, N, oC, s, mV, mA (millimeters/millimeter)2/Hertz
[(mm/mm)2/Hz]
(nmm)
μm, kg, μN, oC, s, V, mA (micrometers/micrometer)2/Hertz
[(μm/μm)2/Hz]
(μmks)
ft, lbm, lbf, oF, s, V, A (feet/foot)2/Hertz [(ft/ft)2/Hz]

(Bft)
in, lbm, lbf, oF, s, V, A (inches/inch)2/Hertz [(in/in)2/Hz]

(Bin)

Table 65: PSD Stress

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Pascals2/Hertz [Pa2/Hz]

(mks)
cm, g, dyne, oC, s, V, A (dynes/centimeter2)2/Hertz [(dyne/cm2)2/Hz]

(cgs)
mm, kg, N, oC, s, mV, mA (kilograms/(millimeter * second2))2/Hertz
[(kg/(mm * s2))2/Hz]
(nmm)
μm, kg, μN, oC, s, V, mA megaNewtons2/Hertz [MPa2/Hz]

(μmks)
ft, lbm, lbf, oF, s, V, A (slug/(foot * second2))2/Hertz [((lbm/32.2)/(ft
* s2))2/Hz]
(Bft)

Release 2020 R1 - © ANSYS, Inc.


1451
Understanding Solving

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A (slinch/(inch * second2))2/Hertz
[((lbm/386.4)/(in * s2))2/Hz]
(Bin)

Table 66: PSD Velocity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A (meters/second)2/Hertz [(m/s)2/Hz]

(mks)
cm, g, dyne, oC, s, V, A (centimeters/second)2/Hertz [(cm/s)2/Hz]

(cgs)
mm, kg, N, oC, s, mV, mA (millimeters/second)2/Hertz [(mm/s)2/Hz]

(nmm)
μm, kg, μN, oC, s, V, mA (micrometers/second)2/megahertz
[(μm/s)2/MHz]
(μmks)
ft, lbm, lbf, oF, s, V, A (feet/second)2/Hertz [(ft/s)2/Hz]

(Bft)
in, lbm, lbf, oF, s, V, A (inches/second)2/Hertz [(in/s)2/Hz]

(Bin)

Table 67: Relative Permeability

Unit System Measured in . . .


o
m, kg, N, C, s, V, A unitless

(mks)
cm, g, dyne, oC, s, V, A unitless

(cgs)
mm, kg, N, oC, s, mV, mA unitless

(nmm)
μm, kg, μN, oC, s, V, mA unitless

(μmks)
ft, lbm, lbf, oF, s, V, A unitless

(Bft)

Release 2020 R1 - © ANSYS, Inc.


1452
Solving Units

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A unitless

(Bin)

Table 68: Relative Permittivity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A unitless

(mks)
cm, g, dyne, oC, s, V, A unitless

(cgs)
mm, kg, N, oC, s, mV, mA unitless

(nmm)
μm, kg, μN, oC, s, V, mA unitless

(μmks)
ft, lbm, lbf, oF, s, V, A unitless

(Bft)
in, lbm, lbf, oF, s, V, A unitless

(Bin)

Table 69: Rotational Damping

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newton * meter * seconds/radian [N * m *
s/rad]
(mks)
cm, g, dyne, oC, s, V, A dyne * centimeter * seconds/radian [dyne
* cm * s/rad]
(cgs)
mm, kg, N, oC, s, mV, mA ton * millimeter2 * seconds/second2 * radian
[t * mm2 * s/s2 * rad]
(nmm)
μm, kg, μN, oC, s, V, mA microNewton * micrometer * seconds/radian
[μN * μm * s/rad]
(μmks)
ft, lbm, lbf, oF, s, V, A slug * foot2 * seconds/second2 * radian
[(lbm/32.2) * ft2 * s/s2 * rad]
(Bft)

Release 2020 R1 - © ANSYS, Inc.


1453
Understanding Solving

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A slinch * inch2 * seconds/second2 * radian
[(lbm/386.4) * in2 * s/s2 * rad]
(Bin)

Table 70: Rotational Stiffness

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newton * meters/radian [N * m/rad]

(mks)
cm, g, dyne, oC, s, V, A dynes * centimeters/radian [dyne * cm/rad]

(cgs)
mm, kg, N, oC, s, mV, mA ton * millimeters2/second2 * radian [t *
mm2/s2 * rad]
(nmm)
μm, kg, μN, oC, s, V, mA microNewton * micrometers/radian
[μN*μm/rad]
(μmks)
ft, lbm, lbf, oF, s, V, A slug * feet2/second2 * radian [(lbm/32.2) *
ft2/s2 * rad]
(Bft)
in, lbm, lbf, oF, s, V, A slinch * inches2/second2 * radian
[(lbm/386.4) * in2/s2 * rad]
(Bin)

Table 71: Seebeck Coefficient

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Volts/degree Celsius [V/°C]

(mks)
cm, g, dyne, oC, s, V, A Volts/degree Celsius [V/°C]

(cgs)
mm, kg, N, oC, s, mV, mA milliVolts/degree Celsius [mV/°C]

(nmm)
μm, kg, μN, oC, s, V, mA Volts/degree Celsius [V/°C]

(μmks)
ft, lbm, lbf, oF, s, V, A Volts/degree Fahrenheit [V/°F]

(Bft)

Release 2020 R1 - © ANSYS, Inc.


1454
Solving Units

Unit System Measured in . . .


o
in, lbm, lbf, F, s, V, A Volts/degree Fahrenheit [V/°F]

(Bin)

Table 72: Section Modulus

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meters3 [m3]

(mks)
cm, g, dyne, oC, s, V, A centimeters3 [cm3]

(cgs)
mm, kg, N, oC, s, mV, mA millimeters3 [mm3]

(nmm)
μm, kg, μN, oC, s, V, mA micrometers3 [μm3]

(μmks)
ft, lbm, lbf, oF, s, V, A feet3 [ft3]

(Bft)
in, lbm, lbf, oF, s, V, A inches3 [in3]

(Bin)
mm, mg, ms millimeters3 [mm3]

[Explicit Dynamics solvers]


m, kg, s meters3 [m3]

[ LS-DYNA solver]
mm, t, s millimeters3 [mm3]

[ LS-DYNA solver]
in,lbf, s inch3 [in3]

[ LS-DYNA solver]

Table 73: Shear Elastic Strain

Unit System Measured in . . .


o
m, kg, N, C, s, V, A radians [rad]

(mks)
cm, g, dyne, oC, s, V, A radians [rad]

(cgs)
mm, kg, N, oC, s, mV, mA radians [rad]

Release 2020 R1 - © ANSYS, Inc.


1455
Understanding Solving

Unit System Measured in . . .


(nmm)
μm, kg, μN, oC, s, V, mA radians [rad]

(μmks)
ft, lbm, lbf, oF, s, V, A radians [rad]

(Bft)
in, lbm, lbf, oF, s, V, A radians [rad]

(Bin)

Table 74: Shock Velocity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A seconds/meters [s/m]

(mks)
cm, g, dyne, oC, s, V, A seconds/centimeters [s/cm]

(cgs)
mm, kg, N, oC, s, mV, mA seconds/millimeters [s/mm]

(nmm)
μm, kg, μN, oC, s, V, mA seconds/micrometers [s/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A seconds/feet [s/ft]

(Bft)
in, lbm, lbf, oF, s, V, A seconds/inches [s/in]

(Bin)

Table 75: Specific Heat

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Joules/kilogram * degree Celsius [J/kg * °C]

(mks)
cm, g, dyne, oC, s, V, A dyne * centimeters/gram * degree Celsius
[dyne*cm/g * °C]
(cgs)
mm, kg, N, oC, s, mV, mA millimeters2/second2 * degree Celsius
[mm2/s2 * °C]
(nmm)
μm, kg, μN, oC, s, V, mA picoJoules/kilogram * degree Celsius [pJ/kg
* °C]
(μmks)

Release 2020 R1 - © ANSYS, Inc.


1456
Solving Units

Unit System Measured in . . .


o
ft, lbm, lbf, F, s, V, A feet2/second2 * degree Fahrenheit [ft2/s2 *
°F]
(Bft)
in, lbm, lbf, oF, s, V, A inches2/second2 * degree Fahrenheit [in2/s2
* °F]
(Bin)
mm, mg, ms Joules/kilogram * degree Kelvin [J/kg * °K]

[Explicit Dynamics solvers]


m, kg, s Joules/kilogram/degree Kelvin [J/kg/°K]

[ LS-DYNA solver]
mm, t, s milliJoules/ton/degree Kelvin [mJ/t/oK]

[ LS-DYNA solver]
in,lbf, s inch2/second2/°F [in2/s2/°F]

[ LS-DYNA solver]

Table 76: Specific Weight

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newtons/meter3 [N/m3]

(mks)
cm, g, dyne, oC, s, V, A dynes/centimeter3 [dyne/cm3]

(cgs)
mm, kg, N, oC, s, mV, mA tons/second2 * millimeters2 [t/s2 * mm2]

(nmm)
μm, kg, μN, oC, s, V, mA microNewtons/micrometer3 [μN/μm3]

(μmks)
ft, lbm, lbf, oF, s, V, A (slug/1)/second2 * feet2 [(lbm/32.2)1/s2 * ft2]

(Bft)
in, lbm, lbf, oF, s, V, A (slinch/1)/second2 * inch2 [(lbm/386.4)1/s2
* in2]
(Bin)
mm, mg, ms megaNewtons/meter3 [MN/m3]

[Explicit Dynamics solvers]


m, kg, s Newtons/meter3 [N/m3]

[ LS-DYNA solver]
mm, t, s Newtons/millimeter3 [N/mm3]

[ LS-DYNA solver]

Release 2020 R1 - © ANSYS, Inc.


1457
Understanding Solving

Unit System Measured in . . .


in,lbf, s pound force/inch3 [lbf/in3]

[ LS-DYNA solver]

Table 77: Square Root of Length

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meter0.5 [m0.5]

(mks)
cm, g, dyne, oC, s, V, A centimeter0.5 [cm0.5]

(cgs)
mm, kg, N, oC, s, mV, mA millimeter0.5 [mm0.5]

(nmm)
μm, kg, μN, oC, s, V, mA micrometer0.5 [μm0.5]

(μmks)
ft, lbm, lbf, oF, s, V, A feet0.5 [ft0.5]

(Bft)
in, lbm, lbf, oF, s, V, A inch0.5 [in0.5]

(Bin)

Table 78: Stiffness

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newtons/meter [N/m]

(mks)
cm, g, dyne, oC, s, V, A dynes/centimeter [dyne/cm]

(cgs)
mm, kg, N, oC, s, mV, mA Newtons/millimeter [N/mm]

(nmm)
μm, kg, μN, oC, s, V, mA microNewtons/micrometer [μN/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A pound force/foot [lbf/ft]

(Bft)
in, lbm, lbf, oF, s, V, A pound force/inch [lbf/in]

(Bin)
mm, mg, ms Newtons/meter [N/m] or
milliNewtons/millimeter [mN/mm]

Release 2020 R1 - © ANSYS, Inc.


1458
Solving Units

Unit System Measured in . . .


[Explicit Dynamics solvers]
m, kg, s Newtons/meter [N/m]

[ LS-DYNA solver]
mm, t, s Newtons/millimeter [N/m]

[ LS-DYNA solver]
in,lbf, s pound force/inch [lbf/in]

[ LS-DYNA solver]

Table 79: Strain and RS Strain

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meter/meter [m/m]

(mks)
cm, g, dyne, oC, s, V, A centimeter/centimeter [cm/cm]

(cgs)
mm, kg, N, oC, s, mV, mA millimeter/millimeter [mm/mm]

(nmm)
μm, kg, μN, oC, s, V, mA micrometer/micrometer [μm/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A feet/foot [ft/ft]

(Bft)
in, lbm, lbf, oF, s, V, A inch/inch [in/in]

(Bin)
mm, mg, ms millimeter/millimeter [mm/mm]

[Explicit Dynamics solvers]


m, kg, s meter/meter [m/m]

[ LS-DYNA solver]
mm, t, s millimeter/millimeter [mm/mm]

[ LS-DYNA solver]
in,lbf, s inch/inch [in/in]

[ LS-DYNA solver]

Table 80: Strength

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Pascals [Pa]

Release 2020 R1 - © ANSYS, Inc.


1459
Understanding Solving

Unit System Measured in . . .


(mks)
cm, g, dyne, oC, s, V, A dynes/centimeter2 [dyne/cm2]

(cgs)
mm, kg, N, oC, s, mV, mA ton/second2 * millimeters [t/s2 * mm]

(nmm)
μm, kg, μN, oC, s, V, mA megaPascals [MPa]

(μmks)
ft, lbm, lbf, oF, s, V, A (slug/1)/second2 * foot [(lbm/32.2)1/s2 * ft]

(Bft)
in, lbm, lbf, oF, s, V, A (slinch/1)/second2 * inch [(lbm/386.4)1/s2 *
in]
(Bin)
mm, mg, ms kiloPascals [kPa]

[Explicit Dynamics solvers]


m, kg, s Pascals [Pa]

[ LS-DYNA solver]
mm, t, s megaPascals [MPa]

[ LS-DYNA solver]
in,lbf, s pounds/inch2 [lb/in2]

[ LS-DYNA solver]

Table 81: Stress and RS Stress

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Pascals [Pa]

(mks)
cm, g, dyne, oC, s, V, A dynes/centimeter2 [dyne/cm2]

(cgs)
mm, kg, N, oC, s, mV, mA ton/second2 * millimeters [t/s2 * mm]

(nmm)
μm, kg, μN, oC, s, V, mA megaPascals [MPa]

(μmks)
ft, lbm, lbf, oF, s, V, A slug/second2 * foot [(lbm/32.2)/s2 * ft]

(Bft)
in, lbm, lbf, oF, s, V, A slinch/second2 * inch [(lbm/386.4)/s2 * in]

Release 2020 R1 - © ANSYS, Inc.


1460
Solving Units

Unit System Measured in . . .


(Bin)
mm, mg, ms kiloPascals [kPa]

[Explicit Dynamics solvers]


m, kg, s Pascals [Pa]

[ LS-DYNA solver]
mm, t, s megaPascals [MPa]

[ LS-DYNA solver]
in,lbf, s pounds/inch2 [lb/in2]

[ LS-DYNA solver]

Table 82: Stress Intensity Factor

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Pascal * meter0.5 [Pa * m0.5]

(mks)
cm, g, dyne, oC, s, V, A dyne * centimeter–2 * centimeter0.5 [dyne *
cm–2* cm0.5]
(cgs)
mm, kg, N, oC, s, mV, mA ton * millimeter–1 * second–2 * millimeter0.5
[ton * mm–1 * s–2 * mm0.5]
(nmm)
μm, kg, μN, oC, s, V, mA megaPascal * micrometer0.5 [MPa * μm0.5]

(μmks)
ft, lbm, lbf, oF, s, V, A lbm_ft * feet–1 * second–2 * feet0.5 [lbm_ft
* ft–1 * s–2 * ft0.5]
(Bft)
in, lbm, lbf, oF, s, V, A lbm_inch * inch–1 * second–2 * inch0.5
[lbm_in * in–1 * s–2 * in0.5]
(Bin)

Table 83: Thermal Capacitance

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Joules/degree Celsius [J/°C]

(mks)
cm, g, dyne, oC, s, V, A ergs/degree Celsius [erg/°C]

(cgs)
mm, kg, N, oC, s, mV, mA milliJoules/degree Celsius [mJ/°C]

(nmm)
μm, kg, μN, oC, s, V, mA picoJoules/degree Celsius [pJ/°C]

Release 2020 R1 - © ANSYS, Inc.


1461
Understanding Solving

Unit System Measured in . . .


(μmks)
ft, lbm, lbf, oF, s, V, A BTU/degree Fahrenheit [BTU/°F]

(Bft)
in, lbm, lbf, oF, s, V, A BTU/degree Fahrenheit [BTU/°F]

(Bin)

Table 84: Thermal Conductance - 3D Face and 2D Edge


For Thermal Conductance on 3D Faces and 2D Edges, the units are the same as those for Film
Coefficient (p. 1431).

Table 85: Thermal Conductance - 3D Edges and Vertices

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Watts/degree Celsius [W/°C]

(mks)
cm, g, dyne, oC, s, V, A dyne * centimeter/second * degree Celsius
[dyne * cm/s * °C]
(cgs)
mm, kg, N, oC, s, mV, mA ton * millimeter2/second3 * degree Celsius
[t * mm2/s3 * °C]
(nmm)
μm, kg, μN, oC, s, V, mA picoWatts/degree Celsius [pW/°C]

(μmks)
ft, lbm, lbf, oF, s, V, A slug * feet2/second3 * degree Fahrenheit
[slug * ft2/s3 * °F]
(Bft)
in, lbm, lbf, oF, s, V, A slinch * inch2/second3 * degree Fahrenheit
[slinch * in2/s3 * °F]
(Bin)

Table 86: Thermal Expansion

Unit System Measured in . . .


o
m, kg, N, C, s, V, A 1/degree Celsius [1/°C]

(mks)
cm, g, dyne, oC, s, V, A 1/degree Celsius [1/°C]

(cgs)
mm, kg, N, oC, s, mV, mA 1/degree Celsius [1/°C]

(nmm)
μm, kg, μN, oC, s, V, mA 1/degree Celsius [1/°C]

(μmks)

Release 2020 R1 - © ANSYS, Inc.


1462
Solving Units

Unit System Measured in . . .


o
ft, lbm, lbf, F, s, V, A 1/degree Fahrenheit [1/°F]

(Bft)
in, lbm, lbf, oF, s, V, A 1/degree Fahrenheit [1/°F]

(Bin)
mm, mg, ms microJoules/degree Kelvin [μJ/°K]

[Explicit Dynamics solvers]


m, kg, s 1/degree Kelvin [1/°K]

[ LS-DYNA solver]
mm, t, s 1/degree Kelvin [1/°K]

[ LS-DYNA solver]
in,lbf, s 1/degree Fahrenheit [1/°F]

[ LS-DYNA solver]

Table 87: Temperature

Unit System Measured in . . .


o
m, kg, N, C, s, V, A degrees Celsius [°C]

(mks)
cm, g, dyne, oC, s, V, A degrees Celsius [°C]

(cgs)
mm, kg, N, oC, s, mV, mA degrees Celsius [°C]

(nmm)
μm, kg, μN, oC, s, V, mA degrees Celsius [°C]

(μmks)
ft, lbm, lbf, oF, s, V, A degrees Fahrenheit [°F]

(Bft)
in, lbm, lbf, oF, s, V, A degrees Fahrenheit [°F]

(Bin)
mm, mg, ms degrees Kelvin [°K]

[Explicit Dynamics solvers]


m, kg, s degrees Kelvin [°K]

[ LS-DYNA solver]
mm, t, s degrees Kelvin [°K]

[ LS-DYNA solver]

Release 2020 R1 - © ANSYS, Inc.


1463
Understanding Solving

Unit System Measured in . . .


in,lbf, s degrees Fahrenheit [°F]

[ LS-DYNA solver]

Table 88: Temperature Difference

Unit System Measured in . . .


o
m, kg, N, C, s, V, A degrees Celsius [°C]

(mks)
cm, g, dyne, oC, s, V, A degrees Celsius [°C]

(cgs)
mm, kg, N, oC, s, mV, mA degrees Celsius [°C]

(nmm)
μm, kg, μN, oC, s, V, mA degrees Celsius [°C]

(μmks)
ft, lbm, lbf, oF, s, V, A degrees Fahrenheit [oF]

(Bft)
in, lbm, lbf, oF, s, V, A degrees Fahrenheit [°F]

(Bin)
mm, mg, ms degrees Kelvin [°K]

[Explicit Dynamics solvers]

Table 89: Temperature Gradient

Unit System Measured in . . .


o
m, kg, N, C, s, V, A degrees Celsius/meter [°C/m]

(mks)
cm, g, dyne, oC, s, V, A degrees Celsius/centimeter [°C/cm]

(cgs)
mm, kg, N, oC, s, mV, mA degrees Celsius/millimeter [°C/mm]

(nmm)
μm, kg, μN, oC, s, V, mA degrees Celsius/micrometer [°C/μm]

(μmks)
ft, lbm, lbf, oF, s, V, A degrees Fahrenheit/foot [°F/ft]

(Bft)
in, lbm, lbf, oF, s, V, A degrees Fahrenheit/inch [°F/in]

Release 2020 R1 - © ANSYS, Inc.


1464
Solving Units

Unit System Measured in . . .


(Bin)
mm, mg, ms degrees Kelvin/millimeter [°K/mm]

[Explicit Dynamics solvers]

Table 90: Time

Unit System Measured in . . .


o
m, kg, N, C, s, V, A seconds [s]

(mks)
cm, g, dyne, oC, s, V, A seconds [s]

(cgs)
mm, kg, N, oC, s, mV, mA seconds [s]

(nmm)
μm, kg, μN, oC, s, V, mA seconds [s]

(μmks)
ft, lbm, lbf, oF, s, V, A seconds [s]

(Bft)
in, lbm, lbf, oF, s, V, A seconds [s]

(Bin)
mm, mg, ms milliseconds [ms]

[Explicit Dynamics solvers]


m, kg, s seconds [s]

[ LS-DYNA solver]
mm, t, s seconds [s]

[ LS-DYNA solver]
in,lbf, s seconds [s]

[ LS-DYNA solver]

Table 91: Translational Damping

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Newton * seconds/meter [N * s/m]

(mks)
cm, g, dyne, oC, s, V, A dyne * seconds/centimeter [dyne * s/cm]

(cgs)

Release 2020 R1 - © ANSYS, Inc.


1465
Understanding Solving

Unit System Measured in . . .


o
mm, kg, N, C, s, mV, mA ton * millimeter * seconds/second2 *
millimeter [t * mm * s/s2 * mm]
(nmm)
μm, kg, μN, oC, s, V, mA microNewton * seconds/micrometer [μN *
s/μm]
(μmks)
ft, lbm, lbf, oF, s, V, A slugfoot * seconds/second2 * foot
[(lbm/32.2)ft * s/s2 * ft]
(Bft)
in, lbm, lbf, oF, s, V, A slinchinch * seconds/second2 * inch
[(lbm/386.4)in * s/s2 * in]
(Bin)

Table 92: Velocity and RS Velocity

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meters/second [m/s]

(mks)
cm, g, dyne, oC, s, V, A centimeters/second [cm/s]

(cgs)
mm, kg, N, oC, s, mV, mA millimeters/second [mm/s]

(nmm)
μm, kg, μN, oC, s, V, mA micrometers/second [μm/s]

(μmks)
ft, lbm, lbf, oF, s, V, A feet/second [ft/s]

(Bft)
in, lbm, lbf, oF, s, V, A inches/second [in/s]

(Bin)
mm, mg, ms meters/second [m/s] or
millimeters/millisecond [mm/ms]
[Explicit Dynamics solvers]
m, kg, s meters/second [m/s]

[ LS-DYNA solver]
mm, t, s millimeters/second [mm/s]

[ LS-DYNA solver]

Release 2020 R1 - © ANSYS, Inc.


1466
Solving Units

Unit System Measured in . . .


in,lbf, s inches/second [in/s]

[ LS-DYNA solver]

Table 93: Voltage

Unit System Measured in . . .


o
m, kg, N, C, s, V, A Volts [V]

(mks)
cm, g, dyne, oC, s, V, A Volts [V]

(cgs)
mm, kg, N, oC, s, mV, mA milliVolts [mV]

(nmm)
μm, kg, μN, oC, s, V, mA Volts [V]

(μmks)
ft, lbm, lbf, oF, s, V, A Volts [V]

(Bft)
in, lbm, lbf, oF, s, V, A Volts [V]

(Bin)

Table 94: Volume

Unit System Measured in . . .


o
m, kg, N, C, s, V, A meters3 [m3]

(mks)
cm, g, dyne, oC, s, V, A centimeters3 [cm3]

(cgs)
mm, kg, N, oC, s, mV, mA millimeters3 [mm3]

(nmm)
μm, kg, μN, oC, s, V, mA micrometers3 [μm3]

(μmks)
ft, lbm, lbf, oF, s, V, A feet3 [ft3]

(Bft)
in, lbm, lbf, oF, s, V, A inches3 [in3]

(Bin)
mm, mg, ms millimeters3 [mm3]

Release 2020 R1 - © ANSYS, Inc.


1467
Understanding Solving

Unit System Measured in . . .


[Explicit Dynamics solvers]
m, kg, s meters3 [m3]

[ LS-DYNA solver]
mm, t, s millimeters3 [mm3]

[ LS-DYNA solver]
in,lbf, s inches3 [in3]

[ LS-DYNA solver]

Saving your Results in the Mechanical Application


There are three ways to save your results in the Mechanical application:

• As a Mechanical APDL application database file.

To save the Mechanical application results in a Mechanical APDL application database file, click
Analysis Settings on the Tree Outline (p. 7) and in its Details, click Yes next to Save ANSYS db
under Analysis Data Management (p. 910).

• As an input file for the Mechanical APDL application. See Writing and Reading the Mechanical APDL Applic-
ation Files (p. 1468).

• As a Mechanical application database file.

To save your solution as a Mechanical application database file, select File> Export. Select File> Save
As in the Project Schematic to save the project. The Save As dialog box appears, allowing you to
type the name of the file and specify its location.

Note

The application creates reference files that contain analysis information that is read back into
the application during solution processing. Certain textual characters can create issues during
this reading process. Avoid the use of the following characters in your file naming conventions:

• Quote character (“)

• Ampersand (&)

• Apostrophe (‘)

• Greater than and less than characters (< >)

• Japanese script

Writing and Reading the Mechanical APDL Application Files


The Tools menu includes options for writing the Mechanical APDL application input files and for reading
the Mechanical APDL application results files.

Release 2020 R1 - © ANSYS, Inc.


1468
Writing and Reading the Mechanical APDL Application Files

To write the Mechanical APDL application input file:

1. Highlight the Solution object folder in the tree.

2. From the Main Menus (p. 63), choose Tools> Write Input File.

3. In the Save As dialog box, specify a location and name for the input file.

To read the Mechanical APDL application result files:

1. Highlight the Solution object folder in the tree.

2. From the Main Menus (p. 63), choose Tools> Read Result Files.

3. Browse to the folder that contains the Mechanical APDL application result files and click Open.

4. In the dialog box that follows, select the unit system, then click OK.

The Unit System used during the solution is stored in the results file (/UNITS command). The Select
Results in Unit System dialog box displays to have you verify the system. Selecting a unit system
that differs from the specified result file unit system causes a warning message to display.

If the application does not have a specified unit system (/UNITS,0), then the application warns you
that you have updated the system based on your choice in the Select Results in Unit System dialog
box.

Important

The application does not overwrite any existing result files that are in the Solver Files Dir-
ectory.

Caution

• Errors will occur if the Mechanical APDL application result files are from a version of the Mechan-
ical application that is older than the version currently running.

• The procedure above instructs you to browse to the folder that contains the Mechanical APDL
application result files. This folder should only contain files pertinent to that solution because
Mechanical copies all the files contained in this folder to the Solver Files Directory. In addition,

Release 2020 R1 - © ANSYS, Inc.


1469
Understanding Solving

for the file names that match the jobname you select in the file browse window the application
renames them to the “file” jobname during the copy.

Mechanical APDL Application Analysis from a Mechanical Application Mesh


The option for writing the Mechanical APDL application file can be used to perform analyses in the
Mechanical APDL application while taking advantage of the meshing capabilities within the Mechanical
application. The procedure is as follows:

1. Attach the model into the Mechanical application (p. 174).

2. Mesh the model.

3. Select the Solution folder in the tree.

4. Tools> Write Input File... and specify a location and name for the input file.

5. Use this input file to complete your analysis in the Mechanical APDL application. The meshed model
will contain generic elements encoding only shape and connectivity information. Such elements can
then be replaced by others that are appropriate to your desired analysis.

Note

Any named selection group from the Mechanical application is transferred to the Mechanical
APDL application as a component according to specific naming rules and conventions (p. 607).

Using Writing and Reading Files Together


The writing and reading options are useful when used together. You can use the write option, then
solve at your leisure on the machine of your choice. When the solution is done, you can use the read
option to browse to the directory that contains the Mechanical APDL application output files (for example,
result file, file.err, solve.out, file.gst, file.nlh). Workbench will then copy all files into your solution directory
and proceed to use those files for postprocessing.

The reading option minimally requires that the target directory include the Result (.rst) and the Error
(.err) files. The application cannot read the .rst file without an accompanying .err file, even if the
.err is an empty file.

Note

You must ensure that the mesh in the result file matches the mesh in Workbench. This includes
the Workbench generated mesh from the geometry as well as any nodes or elements defined
in the input file (such as for contact or remote boundary conditions). Failure to do so could
result in incorrect results and unexpected behavior.

The reading Mechanical APDL application file option is available for all analysis types except rigid dy-
namic analyses and shape analyses.

The writing Mechanical APDL application file option is available for all analysis types except rigid dynamic
analyses.

Release 2020 R1 - © ANSYS, Inc.


1470
Converting Boundary Conditions to Nodal DOF Constraints (Mechanical APDL Solver)

System units must be specified in the Mechanical APDL application result files being read for Result
Tracker graphs to display properly. Result Tracker graphs will display in the Mechanical APDL application
result file units if the units specified when reading the files are inconsistent with those in the files.

Converting Boundary Conditions to Nodal DOF Constraints (Mechanical


APDL Solver)
This section discusses converting structural boundary conditions on the geometry to constraints on the
mesh for analyses targeting the ANSYS solver.

In the Mechanical APDL application, structural degree-of-freedom constraints can be defined at individual
nodes. Specifically, you can choose to constrain each node along any of the three axis directions (x, y,
z) of its local coordinate system to simulate the kinds of supports your model requires. In the Mechan-
ical application, however, you specify boundary conditions on the geometry, so the program must
automatically convert them into nodal constraints prior to solution. Ordinarily, this process is straight-
forward and the boundary conditions can be transcribed directly onto the nodes. In certain cases,
however, the Mechanical application may be confronted with combinations of boundary conditions
that require negotiation to produce an equivalent rendition of the effective constraints acting on the
nodes. A common case occurs in structural analyses where two or more boundary conditions are applied
to neighboring topologies, for example, Frictionless Supports applied to neighboring faces that meet
at an angle: the nodes on the edge are subject to two separate combinations of DOF constraints, one
from each Frictionless Support. The Mechanical application attempts to identify a suitable orientation
to the nodal coordinate system that accommodates both frictionless supports and, if successful, constrain
its axes accordingly. Should this attempt ever fail, the solution will be prevented and an error will be
issued to the Message Window (See The Solver Has Found Conflicting DOF Constraints (p. 1870) in the
Troubleshooting section.)

Among the boundary conditions that participate in this conversion, there are:

Fixed Supports (p. 1078) (Fixed Face, Fixed Edge, Fixed Vertex)
Simply Supported (p. 1099) (Edge or Vertex)
Fixed Rotation (p. 1101)
Displacements (Displacements for Faces (p. 1080), Displacement for Edges (p. 1080), Displacements For
Vertices (p. 1080))
Frictionless Support (p. 1093)
Cylindrical Support (p. 1098)
Symmetry Regions

The calculations that convert the boundary conditions into nodal constraints involve:

• the identification of the linear span contributed by each of the boundary conditions

• the combination of the individual spans into a final nodal constraint choice.

Angular tolerances are involved in distinguishing and combining the spans; a program controlled toler-
ance of 0.01 degrees will be used.

Note

The calculations have a built in preference for producing nodal coordinate systems that are
closest in orientation to the global coordinate system.

Release 2020 R1 - © ANSYS, Inc.


1471
Understanding Solving

Resolving Thermal Boundary Condition Conflicts


Conflicts between boundary conditions scoped to parts and individual faces
Boundary conditions applied to individual geometry faces always override those that are scoped to a
part(s). For conflicts associated with various boundary conditions, the order of precedence is as follows:

1. Applied temperatures (Highest).

2. Convection, heat fluxes, and flows (Cumulative, but overridden by applied temperatures).

3. Insulated (Lowest. Overridden by all of the above).

Solving a Fracture Analysis


Once the crack mesh is generated, you can apply loads and constraints, then solve the analysis. Then,
once the solution is done, you can analyze the stress and deformation pattern around the crack. For
meshes defined by the Semi-Elliptical Crack object or the Arbitrary Crack object, you can apply the
loads on the crack face top and bottom discontinuity plane using nodal named selections.

Note

The application does not create a contact pair for Arbitrary crack meshing.

For the Semi-Elliptical Crack object, the application defines the internally generated crack mesh after
the initial base mesh. The base mesh generation is based on a different set of requirements and con-
straints than the crack mesh. As a result, the crack mesh, generated using the Hex dominant mesh
method, may not perfectly match the boundaries of the fracture affected zone. Because they may not
match perfectly, kinematic constraints are required to establish a connection between base mesh and
crack mesh in the boundaries of the fracture affected zone, which is accomplished using the multi-point
constraint (MPC) contact (p. 871). A contact pair is created at the interface of the crack and base meshes,
with contact surface created at the interface on the buffer zone side of the base mesh and target surface
created at the interface on the fracture affected zone side of the hex dominant mesh. When the solution
is performed using internally-generated crack meshes, the MPC contact region is automatically created
and sent to the solver.

Note

When meshing a Semi-Elliptical Crack, the application does not create a contact pair when
the Mesh Method property is set to Tetrahedrons.

Note

Static Structural and Transient Structural analyses are the only analyses supported for fracture
mechanics calculations. However, the mesh with cracks is also supported with a static struc-
tural analysis linked to an upstream steady state thermal or transient thermal analysis.

Also, all loads and boundary conditions applicable to the static structural analysis are applic-
able with the existence of crack in the solution.

Release 2020 R1 - © ANSYS, Inc.


1472
Solving a Fracture Analysis

Although you can add Fracture and crack objects of any definition to a Modal analysis or a
Mode Superposition (MSUP) Transient analysis, the application does not compute fracture
parameters during the solution.

Computation of Fracture Parameters


The stress and deformation pattern around the crack is not sufficient to evaluate the catastrophic failure
of the structure. The computation of fracture parameters and its comparison against fracture toughness
is necessary for designing safe structures.

To compute fracture parameters for all cracks defined under the Fracture folder, the Fracture property
in the Fracture Controls (p. 889) of the Analysis Settings must be set to On. This entry is visible only if
the Fracture folder exists in the model. By default, the application does not compute fracture parameters
for Material Force and T-Stress. You need to set their properties under the Fracture Controls of the
Analysis Settings to Yes.

The computations used for fracture analysis include Stress Intensity Factors (SIFS), J-Integral (JINT), Energy
Release Rates, Material Force, T-Stress and C*-Integral. The Mode 1 Stress Intensity Factor (K1), Mode 2
Stress Intensity Factor (K2), Mode3 Stress Intensity Factor (K3), and T-Stress are computed along the
crack front using the interaction integral method. The Mode 1 Energy Release Rate (G1) and Mode 2
Energy Release Rate (G2), Mode 3 Energy Release Rate (G3) and Total Energy Release Rate (GT) are
computed using the Virtual Crack Closure Technique (VCCT) along the crack front.

Note

The Energy Release Rate parameters, which are specific to the Pre-Meshed Crack object, are
computed using the Virtual Crack Closure Technique (VCCT). When the VCCT technique is
used, a specific mesh pattern composed of hexahedral shapes along the crack front is recom-
mended for better accuracy. For more information, see Introduction to Fracture in the
Mechanical APDL Fracture Analysis Guide.

The JINT result is a mixed mode result and is also computed along the crack front using the domain
integral method. The fracture parameters, for all cracks defined under the fracture folder, are automat-
ically computed and stored in the results file when the Fracture property in the Fracture Controls (p. 889)
category of Analysis Settings is set to On. The SIFS and JINT results are calculated for all cracks defined
under the Fracture folder. The VCCT results are calculated only if the crack mesh generated is of lower
order (dropped midside nodes). Material Force and T-Stress results are calculated only when their re-
spective control is set to Yes in the Fracture Controls (p. 889) category of Analysis Settings. You can
direct the fracture parameter computation for all cracks to use symmetry by setting the all cracks
symmetric variable to active with a value of 1 in the Variable Manager. For more information, see
Setting Variables (p. 122). Fracture parameter calculation based on SIFS supports linear isotropic elastic
material behavior. VCCT based fracture parameter calculation supports linear isotropic elastic, anisotropic
elastic and orthotropic elastic material behavior. J-Integral based and T-stress based fracture parameter
calculation supports isotropic elastic and isotropic plastic material behaviors. Material force based fracture
parameter calculation supports linear isotropic elastic, isotropic hardening plasticity, kinematic
hardening plasticity and isotropic hyperelastic material behaviors. C*-Integral based fracture parameter
calculation supports secondary (steady-state) creep material behavior and it is computed along the
crack front using the domain integral method. You can exclude computation of any fracture parameter

Release 2020 R1 - © ANSYS, Inc.


1473
Understanding Solving

(except VCCT) by setting its respective control in the Fracture Controls (p. 889) category of Analysis
Settings to No.

Note

If you get the following message:

The fracture parameters computed during solution may be incorrect. Check the Solver Output
on the Solution Information object (p. 1395) for possible causes.

Check for the following:

• A contact might have been created in the region of the crack contours.

• A load might have been applied in the region of the crack contours that is not supported
in the fracture parameter computation. Try replacing it with a Direct FE (p. 1120) load. You
can also replace the normal Pressure loads using the Applied By property option, Direct.

Release 2020 R1 - © ANSYS, Inc.


1474
Commands Objects
The Commands object (p. 1652) enables you to execute Mechanical APDL commands in the Mechanical
application.

Once inserted into the Tree outline, the Worksheet automatically displays. This is where you enter your
Mechanical APDL Commands. The Worksheet contains default instruction information. The default in-
formation displayed changes depending upon the parent object. For example, the following information
appears if you insert a Commands object under a Contact Region object:
! Commands inserted into this file will be executed just after the contact region definition.
! The type number for the contact type is equal to the parameter "cid".
! The type number for the target type is equal to the parameter "tid".
! The real and mat number for the asymmetric contact pair is equal to the parameter "cid".
! The real and mat number for the symmetric contact pair(if it exists) is equal to the parameter "tid".

! Active UNIT system in Workbench when this object was created: Metric (m, kg, N, s, V, A)
! NOTE: Any data that requires units (such as mass) is assumed to be in the consistent solver unit system.
! See Solving Units in the help system for more information.

Refer to the object reference page for the Commands object (p. 1652) for information about the valid
objects under which you can insert single or multiple Commands objects.

Note

Note the following:

• For the Transient Structural (Rigid Dynamics) systems, commands are expressed in Python.

• Preprocessing Commands objects or Postprocessing Commands objects, available in


past releases are no longer supported. If you open a database that includes these objects,
the objects are automatically converted to Commands objects.

The following additional topics are covered in this section:


Commands Object Properties
Commands Object Post Processing Specifications
Commands Objects and the Mechanical APDL Solver
Commands Objects and the Rigid Dynamics Solver

Commands Object Properties


The main properties of the command feature, regardless of the selected solver include:

• Solver Target (p. 1476)

• Input Arguments (p. 1476)

Release 2020 R1 - © ANSYS, Inc.


1475
Commands Objects

Solver Target
The Target property in the Details view of a Commands object provides a drop-down list of solver se-
lections (Mechanical APDL, Samcef, ABAQUS, etc.). The text displayed in the Worksheet for the selected
solver varies. If you change the solver selection, the application prompts you that a Target property
change replaces the Worksheet text and gives you the option to replace or not to replace the text.

When displayed, the Target property is set according to the following situations:

• If all the environments in the tree have the same solver target then the Commands object is tied to that
solver target.

• If there is a mix of solver targets in the tree, the Target property is left empty and you must assign a solver
target.

Important

In order to send command entries to the solver, the solver specified for the environment
being must match the solver specified in the Commands object.

Input Arguments
(Not applicable to the LS-DYNA solver)

Input arguments are available on all Commands objects. There are nine arguments that you can pass
to the Mechanical APDL application macros. Numerical values only are supported. Input Arguments are
editable on the Details view of a Commands object under Input Arguments and listed as ARG1 through
ARG9. If you enter a numerical value, including zero, for an argument, that value is passed along to the
Mechanical APDL application. If you leave the argument value field empty, no argument value is passed
for that specific argument.

Note

If you are calling a user defined macro from within a Commands object, be aware of the
macro's location on the disk to make sure the macro is able to be located during the solution.
Refer to the /PSEARCH command description located in the Mechanical APDL application
Command Reference within the Mechanical APDL Help for more information.

Commands Object Post Processing Specifications


The Commands (p. 1652) object can perform post processing actions when inserted under the Solu-
tion (p. 1817) object.

For solved analyses, you can specify a command and choose whether the Mechanical APDL Solver
processes the specified commands only or whether the solver processes the entire solution (including
the new command) all over again using the Invalidate Solution control. This control is, by default, set
to No - does not invalidate the results. If the solver is not specified as Mechanical APDL, then the Inval-
idate Solution control defaults to Yes and is read-only.

An example of the Commands object and its Details is illustrated below.

Release 2020 R1 - © ANSYS, Inc.


1476
Commands Object Post Processing Specifications

As shown on the status/progress dialog box, the Solver processes only the newly specified commands.

Post Output File

The post command entries generate a new and independent solution output file, post.dat. The
post.dat file contains only the content of unsuppressed command objects. The output file can be viewed
in the Worksheet for the Solution Information object by setting the Solution Output control to Post
Output, as shown below.

Release 2020 R1 - © ANSYS, Inc.


1477
Commands Objects

Note

• This post processing solution only happens if changes or additions are made to the Commands
of a Solution object for an otherwise solved environment. If the solution is unsolved or obsolete
for some other reason, then the commands are executed as part of the normal solving process.

• Existing and post processed results are available for use with any subsequent linked analyses.

• When using this mode, Mechanical APDL runs all commands including the ones that may have
existed as a part of the regular solve. Some commands may require certain variables or parameters
to be active for execution or to produce correct results. As a result, it may be necessary to resume
the Mechanical APDL db file by making sure that the Analysis Settings>Analysis Data Manage-
ment> (p. 910)Save MAPDL db option is set to Yes prior to restarting the entire solution.

• The solve mode is always In Process (p. 1376).

• If the command snippet is inserted or edited with the Invalidate Solution setting set to Yes,
then you can issue post-processing commands using the last restart point of a completed solution.
The solution executes without incurring the cost of a full solve, as it sends only the post commands
and will generate solve.out as a solution output file.

• If you are using the Mechanical APDL post processing command, SET, and you are not executing
a complete re-solve of the solution or if you do not resume a database file (file.db) first, the
default result file name is file.rst. Therefore, if your result file name is not file.rst, you
need to implement the FILE command before any SET commands in order to open the proper
file. An example is a thermal analysis that uses the file name file.rth. In this case, either a

Release 2020 R1 - © ANSYS, Inc.


1478
Commands Objects and the Mechanical APDL Solver

FILE,file,rth command or a RESUME command (if the file.db was saved during the full solution)
is needed.

Note that the generated Output files are written to the Solver Files Directory and are named accordingly.
An example of the directory is shown below.

Commands Objects and the Mechanical APDL Solver


The commands issued by the Commands objects affect the solution, however; they do not alter settings
within Mechanical. This section describes how the following characteristics and requirements apply to
Commands object when used with the Mechanical APDL solver.

• Text and Units (p. 1479)

• Step Selection Mode (p. 1480)

• Point Selection Mode (p. 1480)

• User Convenience Parameters (p. 1480)

• Mechanical APDL Application Plots in Workbench (p. 1481)

• Commands Objects and Materials (p. 1483)

• Mechanical and Mechanical APDL Applications Conflicts (p. 1483)

Text and Units


Command text cannot contain characters outside of the standard US ASCII character set due to the fact
that this text will propagate into the Mechanical APDL application input files and must follow the rules
set aside for the Mechanical APDL application commands and input files. Use of languages other than
English for the command text may cause erratic behavior. The Mechanical APDL application commands
should not be translated.

Make sure that you use consistent units of measure throughout your simulation. The application does
not convert units of measure in the Commands objects. Unit-dependent entries do not get converted
if you make unit system changes in the analysis. Changes of this nature can lead to inaccurate results.

Release 2020 R1 - © ANSYS, Inc.


1479
Commands Objects

Commands object input for magnetostatic analyses must be in MKS units (m, Kg, N, V, A).

Step Selection Mode


The Step Selection Mode property displays when you:

• Have a Commands object inserted under the environment and have Steps Controls (p. 873) defined.

or...

• Are performing an MSUP Harmonic Response analysis (standalone or linked).

For stepped analyses, this property enables you to specify which sequence steps are to process the
Commands object. The choices are: First, Last, All, and By Number. If you select the By Number option,
the property Step Number displays. You use this property to specify the step during which your com-
mand(s) will execute.

For a Harmonic Response analysis, you can specify the solution phase (All, Modal Solution, Harmonic
Solution, or Harmonic Expansion) during which the command snippet will execute.

Point Selection Mode


The Point Selection Mode property displays in the Details view of a Commands object that is inserted
under a Modal environment when the Campbell Diagram property is set to On (Analysis Settings>Ro-
tordynamics Controls (p. 913)). This property enables you to specify which Modal Points, as they corres-
pond to the Campbell Diagram, are to process the Commands object. Options include:

• First

• Last

• All (default)

• By Number

The By Number property enables you to choose specific Campbell Diagram solve points. When
you select By Number, the Point Number also displays. Using this additional property, you
specify individual and/or intermediate Campbell Diagram solve points to execute command(s).

The additional property Point Number displays when you select the option By Number. You
use this additional property to specify the Campbell Diagram solve point your command(s) will
execute.

The Point Number value cannot exceed the Number of Points value specified in the Rotordy-
namics Controls (p. 913). If you specify a Point Number that exceeds the Number of Points
value, the application defaults to the highest solve point available.

User Convenience Parameters


When a project is saved in workbench, the application’s project file management (p. 1417) creates a dir-
ectory/folder structure. The generated folders house a variety of files, such as input or result files. As a
part of this structure, there is a folder created that is named user_files.

The Mechanical APDL solver input file, ds.dat, includes the following parameter (variable):

Release 2020 R1 - © ANSYS, Inc.


1480
Commands Objects and the Mechanical APDL Solver

_wb_userfiles_dir(1)

The value of this parameter equals the path to the user_files directory.

You can use this parameter with the Commands Object (p. 1652) and perform file operations in the
Mechanical APDL language. For example, by specifying this parameter, you can copy result files to the
user_files directory.

For a more specific example, accessing external user macros located in this directory might be done
using the following Mechanical APDL command:
/INPUT, '%_wb_userfiles_dir(1)%file_aqld1001.dat'

For additional information on the Mechanical APDL Command language, see the Mechanical APDL
Command Reference.

Output Parameters: Using Parameters Defined in Solution Command Objects


For Commands objects at the Solution level, an output search prefix can be used to scan the text from
a resulting solution run. After you choose Search Parameters, values for the Mechanical APDL application
parameter assignments are returned that match the output search prefix. The default output search
prefix is my_. Changing the prefix at any time causes a rescan of the text for a matching list. After a
SOLVE, the Mechanical APDL application parameters that are found to match the prefix are listed in the
Details view for the Commands object with their values. This procedure is illustrated in the demonstration
below. Parameters created using Commands objects can be used in Design Exploration.

Note

If you have parameterized an output parameter in the Commands object, you cannot edit
the command text. You need to remove the parameters to edit the text

The following demo is presented as an animated GIF. View online if you are reading the PDF version of the
help. Interface names and other components shown in the demo may differ from those in the released
product.

Mechanical APDL Application Plots in Mechanical


You can view Mechanical APDL application plots in Mechanical that result from using Commands objects.
The Mechanical APDL application plots are returned from Mechanical APDL to display in the Worksheet.
This feature is useful if you want to review result plots that are available in the Mechanical APDL applic-

Release 2020 R1 - © ANSYS, Inc.


1481
Commands Objects

ation but not in Workbench, such as unaveraged stress results or contact results only on a particular
region.

To View the Mechanical APDL Application Plots in Mechanical:

1. Create one or more Commands objects.

2. Direct plot(s) to PNG format.

3. Request plots in the Commands objects.

4. Make sure that there is at least one Commands object under Solution in the tree.

5. Solve. Requested plots for all Commands objects are displayed as objects under the first unsuppressed
Commands object that appears below Solution.

Note

The Mechanical APDL application PowerGraphics mode for displaying results is not compatible
with Commands objects. No results will be produced in this mode. If your command list in-
cludes the PowerGraphics mode (/GRAPH,POWER), you must switch to the Full mode by in-
cluding /GRAPH,FULL at the end of the list.

Presented below is an example of a Commands object used to create two plots, one for unaveraged
stress, and one for element error.
! Commands inserted into this file will be executed immediately after the ANSYS /POST1 command.
! If a SET command is issued, results from that load step will be used as the basis of all
! result objects appearing in the Solution folder.

set,last ! read the last data set


/show,png ! output to png format

/gfile,650 ! adjust size of file

/edge,1,1 ! turn on element outlines


/view,,1,1,1 ! adjust view angle

ples,s,eqv ! plot unaverage seqv


ples,serr ! plot element error

The Mechanical APDL application plots are shown below.

Unaveraged Stress Result:

Element Error Result:

Release 2020 R1 - © ANSYS, Inc.


1482
Commands Objects and the Mechanical APDL Solver

Commands Objects and Materials


1. When using Commands objects, do not change the material IDs for elements. This will cause the results
retrieval form the Mechanical APDL application to Workbench to malfunction.

2. Instead of adding one large Commands object to change all of the materials, add individual Commands
objects under each part. That way you will be able to reference the “matid” in the Commands object for
the material ID of the elements that make up the part. You will also only need to enter the adjusted coeffi-
cient of thermal expansion and not the other materials.

3. Use the Worksheet (p. 48) view of the Geometry object to determine which materials are assigned to
specific parts.

4. Click the right mouse button on a selected item in the Worksheet view, then choose Go To Selected Items
in Tree (p. 48) to add Commands objects.

5. Copy and paste Commands objects from one part to another that have the same material assignment.

Mechanical and Mechanical APDL Applications Conflicts


In order to utilize the Command object feature and execute Mechanical APDL application commands
in Mechanical, you must have a thorough understanding the use of Mechanical APDL Commands.
Moreover, you need to understand that there are times when Mechanical APDL commands may conflict
with the internal settings in Mechanical and as a result adversely affect your solution values.

The following are some common conflicts that could arise:

• If you define only linear elastic properties in Engineering Data, it is possible to use the Mechanical APDL
application commands in a Commands object to override the material properties defined in Engineering
Data or even change the linear elastic material model to a nonlinear material model, such as adding a bilinear
kinematic hardening (BKIN) model. In this case, the solution uses the BKIN model defined in the Commands
object. However, since the Mechanical application is unaware of the nonlinear material specified by the
Commands object, nonlinear solution quantities such as plastic strain will not be available for postprocessing.

• The Mechanical APDL application applies nodal boundary conditions in the nodal coordinate system. For
consistency, Mechanical must sometimes internally rotate nodes. As a result, any node-based boundary
conditions defined in a Commands object will be applied in the rotated nodal coordinate system.

• Commands support the definition of Mechanical APDL arguments via the settings of the properties ARG1
through ARG9. Once a value for one of these arguments is set, it will be retained for the remainder of the
Mechanical APDL solve run unless explicitly set to zero in the Commands text.

Release 2020 R1 - © ANSYS, Inc.


1483
Commands Objects

• Mechanical assumes certain behaviors with respect to Mechanical APDL solution file names and locations.
Therefore, unexpected behavior could occur if Mechanical APDL commands such as /RENAME, /FILNAME,
and /ASSIGN are used in a Commands object which alters the solution files.

Using Mechanical APDL Commands in the Mechanical application requires a working knowledge and
experience with Mechanical APDL Commands and therefore, it is your responsibility to make sure that
any command that you are issuing does not conflict with any existing Mechanical application requirement.

Commands Objects and the Rigid Dynamics Solver


The following information applies to Commands objects used with the Rigid Dynamics solver. Their
use is very similar to Commands objects used in the Mechanical APDL solver, but their behavior may
differ. This section highlights these differences.

The Rigid Dynamics solver commands are based on Python and follow the Python syntax. See Command
Reference for Rigid Dynamics Systems (p. 273) for a complete list and descriptions of commands available
with the Rigid Dynamics solver.

Input Arguments:
As with the Mechanical APDL solver, the Rigid Dynamics solver handles up to nine input arguments
(see Commands Object Properties (p. 1475)). The are available in the Rigid Dynamics commands using
variables _arg1 to _arg9.

Output Parameters: Using Parameters Defined in Solution Command Objects


As with the Mechanical APDL solver, Commands Objects at the solution level can be used to retrieve
values such as output parameters. Their use is similar to Mechanical APDL (see Commands Objects and
the Mechanical APDL Solver (p. 1479)) except for the following differences:

• The Rigid Dynamics solver is case sensitive.

• Unlike Mechanical APDL, it is not possible to perform post-only solve. Modifications to Commands Objects
at the Solution level require a full solve.

Release 2020 R1 - © ANSYS, Inc.


1484
Setting Parameters
The term Parameters in the Mechanical application includes CAD parameters and engineering parameters
(pressure magnitude, maximum stress, fatigue life, dimension of a part, material property type, Young's
modulus, and others).

While engineering parameters are indicated simply by clicking the parameter box (p. 25) in the Details
View (p. 17), CAD Parameters (p. 1488) must be given some extra attention, both in the CAD package
and in the Mechanical application.

The Parameter tab collects all specified parameters and lists them in the Parameter tab grids for later
use and/or modification.

Also see the Specifying Parameters (p. 1485) section for additional information.

Specifying Parameters
The Details View (p. 17) in the application window provides check boxes for items that may be para-
meterized.

The following Details View images illustrate parameter definition for typical objects in the Mechanical
application:

Part Object (p. 1485)


Force Object (p. 1486)
Stress Object (p. 1486)

Part Object
The details of a part object:

Release 2020 R1 - © ANSYS, Inc.


1485
Setting Parameters

A P defines the Volume as parameterized.

Force Object
The details for a Force object:

The Magnitude of the force is parameterized.

Other details, such as the Geometry, Define By and Direction cannot be parameterized.

Stress Object
The details for a Stress object.

Release 2020 R1 - © ANSYS, Inc.


1486
Specifying Parameters

A P appears next to the selected output parameters.

The Minimum is selected as an output parameter.

The Maximum is not selected as an output parameter.

Parameter Restrictions
If an object has a parameterized field, and that object definition is changed in a way that makes that
parameterization non-meaningful, the parameterization will be removed by the program. Some examples
include:

• A material in Engineering Data has a parameterized density, and then the user suppresses the material.

• A result in the Mechanical application is scoped to a face and has a parameterized maximum value, and
then the user re-scopes the result to a different topology.

Note

If you suppress an object, no parameter boxes will be shown for any property on that object.
If you parameterize the Suppressed property on an object, no parameter boxes will be
shown for any other property on that object, regardless of whether or not the object is
suppressed.

Release 2020 R1 - © ANSYS, Inc.


1487
Setting Parameters

CAD Parameters
CAD parameters are a subset of the application parameters. As the name implies, CAD parameters come
from a CAD system and are used to define the geometry in the CAD system. Although each CAD system
assigns its parameters differently, the Mechanical application identifies them via a key (ans; ds or ANS:
DS). This identifier can appear either at the beginning or the end of the parameter name and does not
need to be separated from the name with an underscore or any other character. By identifying the
parameters of interest you can effectively filter CAD parameter exposure. Any of the following examples
are valid CAD parameter names using ANS; DS or ans: ds as the key:

• DSlength

• widthds

• dsradius

ANS; DS is the default key for importing CAD parameters into the application. You can change this
default via the Personal Parameter Key option on the Geometry Preferences.

Note

If you change the key phrase to nothing all parameters are exposed.

CAD parameters must be assigned correctly in the CAD system in order to be imported. Refer to your
CAD system instructions for detailed information on assigning these parameters. Some system specific
notes are included here for your convenience. Remember that these are all actions that must be per-
formed in the CAD system before importing the model.

CAD systems:

• Autodesk Inventor (p. 1488)

• CATIA V5 (p. 1489)

• Creo Parametric (formerly Pro/ENGINEER) (p. 1489)

• NX (p. 1489)

• Solid Edge (p. 1489)

• SolidWorks (p. 1489)

Autodesk Inventor
After a part is open in Inventor, click Tools> Parameters. In the Parameters dialog box, click a para-
meter name under the Parameter Name column, modify the parameter name to include ans; ds at
either the beginning or end of the name and click Enter. Click Done to close the Parameters dialog
box.

For detailed information, see CAD Integration.

Release 2020 R1 - © ANSYS, Inc.


1488
CAD Parameters

CATIA V5
After a part is open in CATIA V5, click Tools> Formula. In the Formulas dialog box, select the desired
parameter in the scrolling list. In the "Edit name or value of the current parameter" field, modify the
parameter name to include ans; ds at either the beginning or end of the name, then click OK or Apply.

For detailed information, see CATIA V5 Associative Geometry Interface (*.CATPart, *.CATProduct) in the
CAD Integration section of the product help.

Creo Parametric (formerly Pro/ENGINEER)


In Creo Parametric, modify the parameter name by selecting the feature it belongs to, right-click Edit.
Creo Parametric will then display all dimensions (parameters) for the selected feature. If the model
shows numeric values, then select Info> SwitchDims so that the names are text based instead of nu-
meric. Next, select the dimension/parameter you wish to rename, it will turn red when selected. Then
hold down right-click until a menu appears and there select Properties. The Dimension Properties
dialog box will appear, select the Dimension Text tab. Here you can give the dimension a new name,
also be sure to change the @D to @S (case sensitive) before completing the modification by clicking
OK.

For detailed information, see Creo Parametric Associative Geometry Interface (*.prt, *.asm) in the CAD
Integration section of the product help.

NX
After a model is opened in NX, click Application > Modeling and Tools > Expression. In the Edit Ex-
pressions dialog box, select the expression with the variable name that you want to rename and click
Rename. Change the expression name in the Rename Variable dialog box to include ans; ds (or
whatever matches your parameter key preference) at either the beginning or end of the name and click
OK. Click OK/Apply to close the Edit Expressions dialog box.

For detailed information, see NX in the CAD Integration section of the product help.

Solid Edge
After a model is opened in Solid Edge, click Tools> Variables... If the dimensions (type Dim) are not
shown in the Variable Table dialog box, click the Filter button for the Filter dialog box. Highlight both
Dimensions and User Variables under the Type column; select Both under the Named By
column and select File under the Graphics in column. Then click OK. Click the name of a dimension
(under the Name column), modify the dimension name to include ans; ds at either the beginning or
end of the name and click Enter. Close the Variable Table dialog box.

For detailed information, see Solid Edge in the CAD Integration section of the product help.

SolidWorks
In SolidWorks, open the part and then click the part or on the feature in the tree. Then right-click the
dimension on the model, open the Properties dialog box, and edit the name of the dimension.

For detailed information, see SolidWorks in the CAD Integration section of the product help.

Release 2020 R1 - © ANSYS, Inc.


1489
Release 2020 R1 - © ANSYS, Inc.
1490
Using Design Assessment
Note

Advisory for Users or Prospective Users of Design Assessment. If you are considering
creating your own post-processing customization, we recommend that you develop it using
the ANSYS Customization Suite. The ANSYS Customization Suite is our customization platform
going forward, and offers more powerful post-processing along with pre-processing capab-
ilities. For more information about the capabilities available in the ANSYS Customization
Suite, see:

• ANSYS ACT Developer's Guide

• ANSYS AIM and Workbench Scripting Guide

• Workbench External Connection Add-In

For those Design Assessment users working with ANSYS Beamcheck and/or ANSYS Fatjack,
you should continue to use Design Assessment and/or run them stand-alone.

The Design Assessment system provides further options to quantitatively examine the results from
other Mechanical application systems by supporting built-in operations, as well as facilities to perform
custom computations on the data. For example, a Design Assessment system could be used to obtain
solution combinations, to verify a design in relation to a particular standard (e.g. for BEAMCHECK (p. 1497)
and FATJACK (p. 1529)), or to perform custom calculation processes (for example, fragmentation analyses,
calling a third-party program to process results data, or running a Mechanical APDL post processing
session).

User Workflow
It is useful to understand the user workflow in a Design Assessment system in order to customize its
calculation process. A key step in the workflow is to select the upstream system whose results will be
examined. This is accomplished using the Solution Selection (p. 1541) object. Once specified, there are
three considerations that affect the outcome of the calculation process (and can thus be customized):

• what inputs are required

• what scripts should run

• how results should be displayed

The user feeds inputs into the Design Assessment system via one or more Attribute Group (p. 1545) objects.

The scripts are the workhorse for computation. They are programmed in the Python scripting language
and have access, at runtime, to all relevant data in the model, including any inputs collected from the
user, along with the mesh and upstream results, through an Application Programmable Interface (API).

Release 2020 R1 - © ANSYS, Inc.


1491
Using Design Assessment

The user defines result requests using the DA Result (p. 1547) object to prescribe what quantities to plot
and where on the model.

Customization
With the exception of Solution Combinations, predefined assessment types such as FATJACK (p. 1536)
and BEAMST (p. 1505) feature Attribute Groups, Scripts, and Result Objects, and can be used as the basis
for customization. These three components of the calculation process must be described in the XML
definition file before they can be featured in a Design Assessment system.

Collectively, the inputs for the process are described in the AttributeGroups section of the Definition
File. Each input is controlled by an individual Attribute indicating the type of data to gather from the
user, its scope of application on the model, and its validation, among other details.

The scripts are prescribed in the DAScripts section of the XML definition file and are the workhorse for
computation. Distinct scripts for "Solve" and for "Evaluating Results" are possible to respond to the re-
spective user operations in the Mechanical application editor. Example snippets are provided for each
class in the scripting API, along with full worked examples (p. 1593) in this documentation. There is a
section on Developing and Debugging Scripts (p. 1546) for more operation details.

The display of results is configured in the Results section of the XML definition file. Individual Attributes
are also used here to collect inputs from the user that can be accessed in the script to control what is
to be plotted.

Once configured, the XML definition file is imported into Design Assessment as a User Defined type,
distinct from all the predefined ones mentioned, and is ready to be used as a custom calculation process.
For details, see the section below on configuring the assessment type.

Design Assessment Types


Design Assessment systems offer three predefined types and a user define type (for customization).
The predefined types are:

• Solution Combination Only

• BEAMCHECK

• FATJACK

To configure a particular Design Assessment system, you may:

• Setup cell Right Mouse Button Menu

Right-click the Setup cell for the system in the Project Schematic and select Assessment Type. Here
you can select one of the pre-defined types, or a user defined type. For user defined types, you could
provide the XML definition file from an Open File dialog or a listing of recent files (if available).

To identify the selected assessment type, look for a checkmark next to the pre-defined type on the
menu. Absence of a checkmark means a user defined type is in effect.

or

• Setup Cell Properties Panel

Release 2020 R1 - © ANSYS, Inc.


1492
Predefined Assessment Types

Select View > Properties from the Main Menu in the Project Schematic. This will display the Properties
Panel in the workspace.

Now click the Setup cell of the Design Assessment system and the Properties Panel will be updated
to show the available options for the cell.

From here you can change the Assessment Type using the drop-down list in the Design Assessment
Settings section. You can choose between the predefined types or select User Defined. For user
defined types, you can provide the XML definition file from an Open File dialog or a listing of recent
files (if available). The name of this file will then be displayed in the properties panel.

For User Defined assessment types, the XML definition file will automatically be copied to your project
folder upon selection, to keep as a reference. If you subsequently edit your XML definition file and want
the changes to be used in a project, it will need to be re-selected. At this stage the differences between
the original and the revised XML definition file will be detected and any defined objects will be updated
as detailed in Changing the Assessment Type or XML Definition File Contents (p. 1540)

Note

If you Import a Mechanical database (e.g., a .mechdat file) containing a Design Assessment
system you must reselect the Assessment Type (and associated XML definition file for the
User Defined type) before opening the project in the Mechanical application. Otherwise, your
assessment type will revert to Solution Combination Only and any Design Assessment objects
will be lost.

The following sections describe the use of the Design Assessment system.
Predefined Assessment Types
Changing the Assessment Type or XML Definition File Contents
Solution Selection
Using the Attribute Group Object
Developing and Debugging Design Assessment Scripts
Using the DA Result Object
The Design Assessment XML Definition File
Design Assessment API Reference
Examples of Design Assessment Usage

Predefined Assessment Types


The following predefined Assessment Types can be selected as described previously (p. 1491) after you
add a Design Assessment system to the Project Schematic.

Solution Combination Only


Enables solution combinations of upstream results using the Solution Selection (p. 1541) object. Mechanical
results can be added to the system. DA result objects can be added for more advanced combination re-
quirements, such as establishing an SRSS combination, or reviewing a combination for maximum values.

BEAMCHECK (Beam and Joint Strength)


Enables solution combinations of upstream results and post processing with BEAMST. BEAMST performs
various regulatory authority based code of practice checks for the ultimate limit state assessment of Beam
or Tubular elements. Mechanical results and DA Results objects are available.

Release 2020 R1 - © ANSYS, Inc.


1493
Using Design Assessment

FATJACK (Beam Joint Fatigue)


Enables solution selection of upstream results and post processing with FATJACK. FATJACK (FATigue cal-
culations for offshore JACKets) performs fatigue analysis at the joints of Beam / Tubular based elements
for fatigue/service limit state assessment. No Mechanical results are available but DA Results objects can
be added to the system.

The following sections describe the use of the predefined Assessment Types in the Design Assessment
system.
Modifying the Predefined Assessment Types Menu
Using Advanced Combination Options with Design Assessment
Using BEAMST and FATJACK with Design Assessment
Using BEAMST with the Design Assessment System
Using FATJACK with the Design Assessment System

Modifying the Predefined Assessment Types Menu


The menu of predefined assessment types can be controlled by editing the AttributeTemplate.xml
file in the {ANSYS Installation}\v182\Addins\Simulation folder. This file defines what
entries appear in the menu when it is selected, along with the order of the entries and the default entry.
The User Defined entry is always shown on the Assessment Type menu in addition to the predefined
assessment types.

An Example Menu Definition File


The following example defines the standard entries on the Assessment Type menu:
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<AttributeTemplates>
<AttributeList>
<Attribute>
<Name>FATJACK (Beam Joint Fatigue)</Name>
<File>DA_FATJACK.xml</File>
<Priority>1.1</Priority>
<ValidOn>Windows</ValidOn>
</Attribute>
<Attribute>
<Name>BEAMCHECK (Beam and Joint Strength)</Name>
<File>DA_BEAMST.xml</File>
<Priority>1.2</Priority>
<ValidOn>Windows</ValidOn>
</Attribute>
<Attribute>
<Default>true</Default>
<Name>Solution Combination Only</Name>
<File>DA_SolutionCombinations.xml</File>
<Priority>1.5</Priority>
<ValidOn>Windows,Linux</ValidOn>
</Attribute>
</AttributeList>
</AttributeTemplates>

Defining the Menu Entries


Each menu entry is defined using an Attribute XML block. The following tags can be defined in the
<Attribute></Attribute> block.

Name: The name that the user will see in the menu.

Release 2020 R1 - © ANSYS, Inc.


1494
Predefined Assessment Types

File: The XML definition file (p. 1548) that is passed to Mechanical. If the full path to the file is omitted,
the location is assumed to be in the {ANSYS Installa-
tion}\v182\aisol\DesignSpace\DSPages\xml folder.

Priority: The position in the menu, entered as 1.1 - 1.xxx.

Default: Specifies which entry is the default. Include this tag with a value of true for the entry that is
to be the default option (omit it for other entries).

ValidOn: Specifies which platforms are supported for the entry. Available options are Windows and
Linux. To specify both platforms, separate entries with a comma (Windows,Linux).

Using Advanced Combination Options with Design Assessment


Advanced combination options are available through the addition of DA Result objects when the As-
sessment Type is Solution Combination Only. They are not available by default with custom XML
definition files, even when CombResults =1. These DA Result objects offer similar capability to that
offered by the LCOPER command for Mechanical APDL.

Introduction
DA Result objects can be added to the Design Assessment system for combining the upstream solution
results that have been specified in the Solution Selection (p. 1541) table. Different combinations or com-
parisons can be applied to the selected solutions.

Any number of DA Results can be added to combine or compare as many solutions as needed. It is also
possible to compare results from the same solution but over different time steps. This is done by selecting
the same environment in multiple entries in the Solution Selection table and specifying the desired
time steps for those entries.

Defining Results
These DA Result (p. 1547) objects are similar to those available for the BEAMCHECK and FATJACK assessment
types, but have predefined fields that allow you to define the solution combination/comparison method
that you want to use. A number of different Result Type and Result Subtype values can be selected
to define the combination method.

Important

For Shells, the DA Result types only produce results for the top surface of the Shell.

Result Type
Choose the Result Type that you want to combine/compare in this DA Result. You can choose one of the
following from the drop-down list.

• Stress

• Strain

• Displacement

• Expression-Based

Release 2020 R1 - © ANSYS, Inc.


1495
Using Design Assessment

If you choose Stress, Strain, or Displacement as the Result Type, the Entry Value of Attribute 1 will
allow you to choose from a drop-down list of selected results. The result units are automatically
chosen.

If a Stress, Strain or Displacement result type is selected, together with a resultant expression (for
example, S1 or USUM), the combination/comparison will be performed on the components, and
the resultant value recalculated afterwards. This is the same method used by the Mechanical APDL
LCOPER command. However in some cases, such as finding the maximum values over a number
of time points, this behavior is not desired and the combination/comparison is required to be per-
formed on the resultant of the expression itself. In these cases, select Expression-Based as the result
type and enter the expression name in the relevant Attribute box.

If Expression-Based is selected, any user defined result can be entered in an expression string (p. 1345)
in the Entry Value field of Attribute 1. The result unit type must be selected from the drop-down
list in the Entry Value field of Attribute 2. Any combination/comparison is performed directly on
the expression and does not take into account component values.

Caution

This method may produce undesired or nonphysical results. For example, combining
USUM vector results would normally be performed on a component basis, and the direct
combination of values would most likely cause an undesired result.

Result Subtype
The Result Subtype field allows you to select the type of combination/comparison operation that you
want to perform in this DA Result object. The following operations are available regardless of the Result
Type:

• Sum results

This operation adds the specified results from the selected solutions.

• Subtract Results

This operation subtracts the specified results from the selected solutions.

The lowest solution row number available acts as the minuend and all subsequent solutions act
as subtrahends. This can be manipulated using negative coefficients.

• Mean Result

Sums all selected solution results and divides the total by the number of solutions selected.

• SRSS Result

Computes the square root of the sum of squares for all selected solution results.

• Absolute Maximum

Computes the absolute maximum of the selected solution results and sets the DA result to this
value with the relevant sign; in other words, the value furthest from zero. For example, if two
results with the values 9 and -10 are compared, the DA Result would be set to -10.

• Absolute Minimum

Release 2020 R1 - © ANSYS, Inc.


1496
Predefined Assessment Types

Similar to Absolute Maximum, but returns the minimum value; in other words, the value closest
to zero.

• Maximum

Finds the maximum result from the selected solution results and sets the DA Result to this value.
For example, if two results with the values 9 and -10 are compared, the DA Result would be set
to 9.

• Minimum

Similar to Maximum, but returns the minimum value.

Other Attributes

• Solutions (By Row Number)

This attribute allows the user to compare different solutions within one Design Assessment system.
First specify all of the required solutions in the Solution Selection table. Then, using commas and
hyphens, you can enter specific solution rows to consider for the current DA Result in this attribute.
For example, if solutions 1,2,3,4,7,8,9,10 were required for one combination and 5,6 were required
for the other, then you could enter 1-4,7-10 for the first DA Result and 5,6 for the second
DA Result. Solution Row numbers are 1 based.

Using BEAMST and FATJACK with Design Assessment


The Design Assessment system provides for the selection of Attribute Group objects to define the input
data to FATJACK (p. 1529) and BEAMST (p. 1497). In addition, DA Result objects can be added to the Solution
to define which results to obtain and display. Workbench and Design Assessment are geometry based,
which means that areas of the geometry are selected rather than individual elements. With the Mech-
anical solver, a member ought to be meshed and formed of a number of elements.

Results can be added to the Solution in the Design Assessment system and displayed in Workbench;
these will contour the maximum value that occurs for each element. Results can be added either before
or after the analysis. If additional results are added after the analysis has been performed, then evaluating
the results will obtain the values from the existing database, if the result type exists. Elements that do
not have results will be shown as semi-transparent.

Two functions have been added to allow access to the database produced when running BEAMST or
FATJACK, The function pyGetElementResultFlt can be used to get an individual specific result, and
pyGetElementResultArray can be used to get a number of results for a given range of loads and elements.

Note

BEAMST and FATJACK only support Kilogram (Kg) and Pound (Lbm) mass units, and do not
support micrometers (μm). The solution should be obtained (including upstream systems)
using appropriate units systems, otherwise incorrect results may be obtained when performing
the assessment.

Using BEAMST with the Design Assessment System


The ability to perform code checking has been incorporated into Workbench using the Design Assessment
System. This system can be connected to both Static Structural and Transient Structural systems. The

Release 2020 R1 - © ANSYS, Inc.


1497
Using Design Assessment

structural analysis needs to be performed using the Mechanical solver. The following sections describe
how to setup a BEAMST analysis in the Design Assessment system.
Introduction
Information for Existing ASAS Users
Attribute Group Types
Available Results

Introduction
The Design Assessment system enables the input of Attribute Group (p. 1545) objects to define the input
data to BEAMST and DA Result (p. 1547) objects to define which results to obtain and present. Workbench
and Design Assessment are geometry based, which means that areas of the geometry are selected
rather than individual elements. With the Mechanical solver, a member ought to be meshed and formed
of a number of elements, the Design Assessment, BEAMST implementation automatically sets the un-
braced lengths as the distance between the end vertices of the member to account for this.

Use the Solution Selection (p. 1541) object to identify the results used to produce the combinations for
BEAMST. A combination can be formed of a number of Static and Transient Analyses; however, you can
only have one analysis with multiple substep results enabled. The results will be associated with the
times of the results in the substeps.

When using the Design Assessment interface, BEAMST is limited to processing 5000 result time points
or loadcases in a single analysis. The number of upstream results is limited to 4999. The limit includes
all of the time points from a result, even if BEAMST is only examining a subset of them, and if two
separate results are examined from the same upstream system, the total number of results from that
system are applied twice to the limit.

So, for example, for a typical offshore code check for a transient wave with a combination of transient
wave case + three static cases you may have the following entries in the Solution Selection table:

Row 1 – Single step from Static Analysis A containing 10 steps (e.g. dead load case A)

Row 2 – 1000 substeps from Transient Analysis B containing 4500 substeps in multiple steps (e.g.
Transient wave case)

Row 3 – Single step from Static Analysis C containing 5 steps (e.g. live load case).

Row 4 – Single step from Static Analysis A containing 10 steps (e.g. dead load case B)

This would consume 4525 (10 + 4500 + 5 + 10) upstream results and would produce 1000 result time
points (each being a combination of the wave + dead A + dead B + live).

Results can be added to the Solution in the Design Assessment system and displayed in Workbench;
these will contour the maximum value that occurs for each element. Results can be added either before
or after the analysis, if further results are added after the analysis has been performed then evaluating
the results will obtain the values from the existing database, if the result type exists. Elements that do
not have results will be semi-transparent.

Reports can be produced of the input data and the results can be parameterized and exposed for use
with other systems.

Release 2020 R1 - © ANSYS, Inc.


1498
Predefined Assessment Types

Information for Existing ASAS Users


BEAMST Attribute Group Type Attribute Group Subtype Requirement
Command
ABNO Load Dependant Factors Load Classification API LRFD Only
AISC Code of Practise Selection AISC WSD Checks *

AISC LRFD Checks


API Code of Practise Selection API WSD Checks *

API LRFD Checks


BRIG Ocean Environment Buoyancy Calculation Method
BS59 Code of Practise Selection BS5950 Checks *
CASE Not supported, Load case selection is via the Solution Selection Object
CB Load Dependant Factors Bending Coefficient
CHOR Geometry Definition Manually Define Chords

Define Chord Thickening at


Joint

Automatic Joint Identification


CMBV Not Supported, only linear static combinations are permitted.
CMY Load Dependant Factors Amplification Reduction Factor CMY
CMZ Load Dependant Factors Amplification Reduction Factor
CMZ
COMB Automatically determined from the Solution Selection Object
DESI Automatically determined from the geometry.
DENT Geometry Definition Dented Member Profile ISO Only
DS44 Code of Practise Selection DS449 / DS412 Checks *
EFFE Geometry Definition Effective Lengths
ELEM Code of Practise Selection As selected for the appropriate
code of practice
ELEV Ocean Environment Water Details
EXTR Load Dependant Factors Safety Factor Definition
GAPD Geometry Definition Default Gap/Eccentricity
GRAV Automatic from units, assumed water surface is in global XY plane.
GROU Not Supported
HYDR Load Dependant Factors Safety Factor Definition
ISO Code of Practise Selection ISO Checks
JOIN Code of Practise Selection As selected for the appropriate
code of practice
LIMI Not Supported
MCOF Material Definition Partial Material Coefficient (NPD,
NORSOK, DS449 only)

Release 2020 R1 - © ANSYS, Inc.


1499
Using Design Assessment

BEAMST Attribute Group Type Attribute Group Subtype Requirement


Command
MFAC Load Dependant Factors Moment Reduction Factors
MLTF Load Dependant Factors LTB Moment Reduction Factor
MOVE Not Supported
NORS Code of Practise Selection NORSOK Checks *
NPD Code of Practise Selection NPD Checks *
PHI Load Dependant Factors PHI Coefficient
POST Not Supported
PRIN Not Supported
PROF Not Supported
QuAK Load Dependant Factors Safety Factor Definition
RENU Not Supported
SAFE Load Dependant Factors Safety Factor Definition
SEAR Not Supported
SECO Code of Practise Selection As selected for the appropriate
code of practice
SECT Not Supported
SELE Not Supported
SIMP Code of Practise Selection BS5950 Checks
SPEC Not Supported
STUB Not Supported
TITL Not Supported
TYPE Geometry Definition Joint Types

Default Joint Types


ULCF Geometry Definition Unbraced Compression Flange
Length

Unbraced Compression Flange


Length (Factor)
UNBR Geometry Definition Unbraced Length

Unbraced Length (Factor)


UNIT Automatically determined from analysis, selections for N mm, pdl ft, pdl in and N m
are supported.
WAVE Ocean Environment Wave Definition
YIEL YIEL Material Definition Yield Definition Compulsory

* At least one of these entries is required.

Release 2020 R1 - © ANSYS, Inc.


1500
Predefined Assessment Types

Attribute Group Types


Attribute Groups enable the entry of the data that is associated with the BEAMST analysis. The following
sections describe the available Attribute Group Types and their subtypes.
Code of Practise Selection
General Text
Geometry Definition
Load Dependant Factors
Material Definition
Ocean Environment

Note

If units are changed when defining data for Attributes, then the resulting data sent to the
processing script may be incorrect. It is recommended that units are not modified from those
used in creating the geometry.

Code of Practise Selection


All groups that have this type enable the selection of a particular code of practice.

Note

If a specific code check version is set to Not Checked for a given code of practice, it is still
necessary to make a geometry selection for that Attribute.

• API WSD Checks

Enables the selection of the API WSD code of practice and the appropriate edition. Use this to select
the joints and members to be included in the check. Any members that are not selected will be ex-
cluded from the checks.

Allowable Stress, Hydrostatic Checks and Joint check clauses will be included as appropriate for the
edition chosen.

• API LRFD Checks

Enables the selection of the API LRFD code of practice and the appropriate edition. Use this to select
the joints and members to be included in the check. Any members that are not selected will be ex-
cluded from the checks.

Allowable Stress Checks, Hydrostatic Checks and Joint check clauses will be included as appropriate
for the edition chosen.

• AISC WSD Checks

Enables the selection of the AISC WSD code of practice and the appropriate edition. Use this to select
the members to be included in the check. Any members that are not selected will be excluded from
the checks.

Allowable Stress Checks clauses will be included as appropriate for the edition chosen.

• AISC LRFD Checks

Release 2020 R1 - © ANSYS, Inc.


1501
Using Design Assessment

Enables the selection of the AISC LRFD code of practice and the appropriate edition. Use this to select
the members to be included in the check. Any members that are not selected will be excluded from
the checks.

Member Checks clauses will be included as appropriate for the edition chosen.

• BS5950 Checks

Enables the selection of the BS5950 code of practice and the appropriate edition. Use this to select
the members to be included in the check. Any members that are not selected will be excluded from
the checks.

Member Checks clauses will be included as appropriate for the edition chosen. Members that only
need the simplified checks can also be selected

• DS449 / DS412 Checks

Enables the selection of the DS code of practice and the appropriate edition. Use this to select the
joints and members to be included in the check. Any members that are not selected will be excluded
from the checks.

Allowable Stress and Joint check clauses will be included as appropriate for the edition chosen.

• ISO Checks

Enables the selection of the ISO code of practice and the appropriate edition. Use this to select the
joints and members to be included in the check. Any members that are not selected will be excluded
from the checks.

Member, Hydrostatic Checks and Joint check clauses will be included as appropriate for the edition
chosen.

• NORSOK Checks

Enables the selection of the NORSOK code of practice and the appropriate edition. Use this to select
the joints and members to be included in the check. Any members that are not selected will be ex-
cluded from the checks.

Member, Hydrostatic Checks and Joint check clauses will be included as appropriate for the edition
chosen.

• NPD Checks

Enables the selection of the NPD code of practice and the appropriate edition. Use this to select the
joints and members to be included in the check. Any members that are not selected will be excluded
from the checks.

Member and Joint check clauses will be included as appropriate for the edition chosen.

General Text
This can be used to supply additional and non-supported commands. This will always override data set
by other tree objects.

• Geometry Independent

Release 2020 R1 - © ANSYS, Inc.


1502
Predefined Assessment Types

Enables additional commands to be entered, these will be appended to the end of all code checks.

Geometry Definition
All groups that have this type enable the selection of a particular code of practice.

• Manually Define Chords

The chord member(s) and the central vertex can be chosen to define which members at a joint form
the chords. Without this definition, chords are automatically determined. Chords for each Joint needs
to be defined separately. Only applicable to joint checks.

• Automatic Joint Identification

Enables the identification of joints formed of more than one node by the ratio of the distance between
nodes to the diameter of the member. All joints can be selected at once. Only applicable to joint
checks.

• Define Chord Thickening at Joint

Enables the entry of chord thickening at the selected joints. Only applicable to joint checks.

• Effective Lengths

Enables the definition of effective length factor k for the selected members to be entered for both
the local y and z directions. Applicable for member strength based checks only.

• Unbraced Compression Flange Length

Enables the definition of the unbraced compression flange length. If this and the factor version are
omitted then the direct distance between vertices which do not have 2 lines joining is taken.

• Unbraced Length

Enables the definition of the unbraced length. If this and the factor version are omitted then the
direct distance between vertices which do not have 2 lines joining is taken.

• Joint Types

Enables default joint type to be over-ridden.

• Default Gap/Eccentricity

Enables default gap or eccentricity to be overridden.

• Dented Member Profile

Enables the definition of dents and imperfections in the straightness of the member to be defined
for the ISO code of practice

• Unbraced Compression Flange Length (Factor)

Enables the definition of the compression flange length. The factor is applied to the distance between
vertices which do not have 2 lines joining is taken and is converted to a length. If undefined (and
not over-ridden by the direct entry), a factor of 1 is applied to all elements forming the line

Release 2020 R1 - © ANSYS, Inc.


1503
Using Design Assessment

• Unbraced Length (Factor)

Enables the definition of the unbraced length. The factor is applied to the distance between vertices
which do not have 2 lines joining is taken and is converted to a length. If undefined (and not over-
ridden by the direct entry), a factor of 1 is applied to all elements forming the line

Load Dependant Factors


All groups that have this type enable the entry of values that are dependent on.

• Safety Factor Definition

Use this to define if the loading scenario is considered to be an earthQuake/seismic or extreme load,
for which the safety factors can be reduced, alternatively, custom values can be added. Additionally
the Hydrostatic pressure load factor can be defined for hydrostatic checks.

• Load Classification

Enables the identification of abnormal load scenarios. Only applies to the API LRFD code of practice.

• Bending Coefficient

Enables the definition of the pure coefficient of bending, Cb and selection of the members to which
it applies. In absence of application of a user value it is calculated automatically. Only applies to the
AISC and API allowable stress checks.

• PHI Coefficient

Enables the specification of the parameter Φ, used in the determination of the lateral buckling strength
of beams for NS3472E, this value can either be automatically determined or manually over-ridden.
Only applied to the NPD checks.

• LTB Moment Reduction Factor

Enables the definition and application of MLTB , the moment reduction factor for lateral torsional
buckling. Only applicable to BS5950

• Amplification Reduction Factor CMY

Enables the definition and application of the factor Cmy , the amplification reduction factor. Only
applies to AISC & API Allowable stress checks.

• Amplification Reduction Factor CMZ

Enables the definition and application of the factor Cmz , the amplification reduction factor. Only
applies to AISC & API Allowable stress checks

• Moment Reduction Factors

Enables the definition and application of the My and Mz factors, the moment reduction factors. Only
applies to BS5950 checks.

Material Definition
All groups that have this type enable the selection of a particular code of practice.

Release 2020 R1 - © ANSYS, Inc.


1504
Predefined Assessment Types

• Partial Material Coefficients

Enables the definition of the partial material coefficients utilised in the NPD, NORSOK and DS449
codes

• Yield Definition

Definition of the yield stress, must have a value applied for each member in the analysis. Required
for all code checks

Ocean Environment
All groups that have this type enable the selection of a particular code of practice.

• Water Details

Enables the elevation of the mean water level, sea bed to be defined in global Z. Water density and
tide/surge heights can also be entered. Required for all code checks involving hydrostatic analysis.

Note

The global X/Y plane is coincident with the horizontal mean sea level, with global Z vertically
upwards (away from the mudline).

• Buoyancy Calculation Method

By default rigorous buoyancy is enabled for compatibility with the Mechanical analysis methods. If
necessary, this methodology can be disabled for the code check.

• Wave Definition

Used to specify the wave height and period for the calculation for wave induced hydrostatic pressure
head calculations.

Available Results
The following results are available for the Code of Practice types as indicated below. Results are added
using the DA Results tree object.
AISC LRFD Results
AISC WSD Results
API LRFD Results
API WSD Results
BS5950 Results
DS449 High Results
DS449 Normal Results
ISO Results
NORSOK Results
NPD Results

As each result object presents a number of types of results, units are not employed in the output. Hence
all values will be reported in the solver units used for the BEAMST analysis.

Release 2020 R1 - © ANSYS, Inc.


1505
Using Design Assessment

AISC LRFD Results


Two Results subtypes are available for this code of practice. The results available for those subtypes are
shown below.

Member Unity Checks

• Axial

• Y Shear

• Z Shear

• Y Bending

• Z Bending

• Buckling CSR

• Yield

Member General Results

• Y Amplification Reduction Factor

• Z Amplification Reduction Factor

• Allowable Axial Stress

• Critical Stress

• Allowable Y Euler Buckling Stress

• Allowable Z Euler Buckling Stress

• Allowable Y Shear Stress

• Allowable Z Shear Stress

• Allowable Y Bending Stress

• Allowable Z Bending Stress

AISC WSD Results


Two Results subtypes are available for this code of practice. The results available for those subtypes are
shown below.

Member Unity Check

• Axial

• Y Shear

• Z Shear

• Y Bending

Release 2020 R1 - © ANSYS, Inc.


1506
Predefined Assessment Types

• Z Bending

• Maximum Shear

• Buckling

• Buckling CSR

• Yield

Member General Results

• Y Amplification Reduction Factor

• Z Amplification Reduction Factor

• Allowable Axial Stress

• Allowable Shear Stress

• Allowable Y Bending Stress

• Allowable Z Bending Stress

API LRFD Results


Six Results subtypes are available for this code of practice. The results available for those subtypes are
shown below.

Member Unity Checks

• Axial

• Shear

• Torsion

• Y Bending

• Z Bending

• Resultant Bending

• Buckling

• Buckling CSR

• Yield 1

• Yield 2

Hydrostatic Unity Checks

• Axial

• Hoop

Release 2020 R1 - © ANSYS, Inc.


1507
Using Design Assessment

• Yield

• Buckling

• Combined

Joint Unity Check

• Axial

• In-Plane Bending

• Out-of-Plane Bending

• Bending

• Combined Axial + Bending

• Joint Strength

Hydrostatic General Results

• Hydrostatic Depth

• Hydrostatic Pressure Load Factor

• Geometry Parameter

• Hoop Buckling Coefficient

• Hoop Stress

• Allowable Axial Stress

• Allowable Bending Stress

• Allowable Elastic Axial Stress

• Allowable Elastic Hoop Stress

• Allowable Inelastic Axial Stress

• Allowable Inelastic Hoop Stress

Joint General Results

• Proportion of Joint 1

• Proportion of Joint 2

• Gap

• Beta Ratio

• Tau Ratio

• Theta Angle

Release 2020 R1 - © ANSYS, Inc.


1508
Predefined Assessment Types

• Chord Stress

• Chord Yield Stress

• Brace Yield Stress

• Brace Axial Stress

• In-Plane Brace Bending Stress

• Out-of-Plane Brace Bending Stress

• Axial Qf Factor

• In-Plane Qf Factor

• Out-of-Plane Qf Factor

• Axial Qu Factor Brace 1

• In-Plane Bending Qu Factor Brace 1

• Out-of-Plane Bending Qu Factor Brace 1

• Axial Qu Factor Brace 2

• In-Plane Bending Qu Factor Brace 2

• Out-of-Plane Bending Qu Factor Brace 2

• Axial Force

• In-Plane Bending Force

• Out-of-Plane Bending Force

• Allowable Axial Force Brace 1

• Allowable In-Plane Bending Force Brace 1

• Allowable Out-of-Plane Bending Force Brace 1

• Allowable Axial Force Brace 2

• Allowable In-Plane Bending Force Brace 2

• Allowable Out-of-Plane Bending Force Brace 2

• Allowable Cross Chord Force

Member General Results

• Y Amplification Reduction Factor

• Z Amplification Reduction Factor

• Column Slenderness Parameter

Release 2020 R1 - © ANSYS, Inc.


1509
Using Design Assessment

• Allowable Axial Stress

• Allowable Shear Stress

• Allowable Torsion Stress

• Allowable Bending Stress

• Allowable Y Euler Buckling Stress

• Allowable Z Euler Buckling Stress

• Yield Stress

• Buckling Stress

API WSD Results


Eleven Results subtypes are available for this code of practice. The results available for those subtypes
are shown below.

Member Unity Checks

• Axial

• Y Shear (not TUBE - Ed17+)

• Z Shear (not TUBE - Ed17+)

• Y Bending

• Z Bending

• Buckling

• Buckling CSR

• Yield

• Maximum Shear (TUBE - Ed13 Only)

• Flexural Shear (TUBE - Ed17+)

• Torsional Shear (TUBE - Ed17+)

• Resultant Bending (TUBE - Ed17+)

Hydrostatic Unity Checks

• Axial Tension

• Hoop

• Combined 1

• Combined 2

Release 2020 R1 - © ANSYS, Inc.


1510
Predefined Assessment Types

• Combined T

Joint (Punching) Unity Checks

• Axial

• In-Plane Bending

• Out-of-Plane Bending

• Bending

• Combined Axial + Bending

• Joint Strength

Joint (Nominal) Unity Checks

• Axial

• In-Plane Bending

• Out-of-Plane Bending

• Bending

• Combined Axial + Bending

• Joint Strength

Joint Unity Checks

• Axial

• In-Plane Bending

• Out-of-Plane Bending

• Combined Axial + Bending

Hydrostatic General Results

• Hydrostatic Depth

• Hoop Stress

• Allowable Axial Tension Stress

• Allowable Elastic Axial Stress

• Allowable Elastic Hoop Stress

• Allowable Inelastic Axial Stress

• Allowable Inelastic Hoop Stress

Release 2020 R1 - © ANSYS, Inc.


1511
Using Design Assessment

Joint (Nominal) General Results

• Gap

• Beta Ratio

• Tau Ratio

• Theta Angle

• Chord Stress

• Chord Yield

• AISC Allowable Punching Shear Stress

• Brace Axial Stress

• In-Plane Brace Bending Stress

• Out-of-Plane Brace Bending Stress

• Axial Qf Factor

• In-Plane Qf Factor

• Out-of-Plane Qf Factor

• Axial Qu Factor Brace 1

• In-Plane Bending Qu Factor Brace 1

• Out-of-Plane Bending Qu Factor Brace 1

• Axial Qu Factor Brace 2

• In-Plane Bending Qu Factor Brace 2

• Out-of-Plane Bending Qu Factor Brace 2

• Axial Force

• In-Plane Bending Force

• Out-of-Plane Bending Force

• Allowable Axial Force Brace 1

• Allowable In-Plane Bending Force Brace 1

• Allowable Out-of-Plane Bending Force Brace 1

• Allowable Axial Force Brace 2

• Allowable In-Plane Bending Force Brace 2

• Allowable Out-of-Plane Bending Force Brace 2

Release 2020 R1 - © ANSYS, Inc.


1512
Predefined Assessment Types

Joint General Results

• Allowable Pa

• Allowable Ma In-Plane

• Allowable Ma Out-of-Plane

• Beta Ratio

• Gamma Ratio

• Tau Ratio

• Theta Angle

• 1st Chord Member

• Chord Axial Force

• Chord Moment In-Plane

• Chord Moment Out-of-Plane

• Chord Capacity

• Chord Strength

• Brace Axial Force

• Brace Moment In-Plane

• Brace Moment Out-of-Plane

• Joint Proportion (%) 1

• Joint Proportion (%) 2

• Joint Proportion (%) 3

• Joint Proportion (%) 4

• Joint Proportion (%) 5

• Axial Qu Factor 1

• Axial Qu Factor 2

• Axial Qu Factor 3

• Axial Qu Factor 4

• Axial Qu Factor 5

• Axial Qf Factor 1

• Axial Qf Factor 2

Release 2020 R1 - © ANSYS, Inc.


1513
Using Design Assessment

• Axial Qf Factor 3

• Axial Qf Factor 4

• Axial Qf Factor 5

• Gap Factor 1

• Gap Factor 2

• Gap Factor 3

• Gap Factor 4

• Gap Factor 5

• Qu Factor - In-Plane

• Qu Factor - Out-of-Plane

• Qf Factor

Joint (Punching) Results

• Proportion of Joint 1

• Proportion of Joint 2

• Gap

• Beta Ratio

• Tau Ratio

• Theta Angle

• Chord Stress

• Chord Yield

• AISC Allowable Punching Shear Stress

• Brace Axial Stress

• In-Plane Brace Bending Stress

• Out-of-Plane Brace Bending Stress

• Axial Qf Factor

• In-Plane Qf Factor

• Out-of-Plane Qf Factor

• Axial Qq Factor Brace 1

• In-Plane Bending Qq Factor Brace 1

Release 2020 R1 - © ANSYS, Inc.


1514
Predefined Assessment Types

• Out-of-Plane Bending Qq Factor Brace 1

• Axial Qq Factor Brace 2

• In-Plane Bending Qq Factor Brace 2

• Out-of-Plane Bending Qq Factor Brace 2

• Axial Stress

• In-Plane Bending Stress

• Out-of-Plane Bending Stress

• Allowable Axial Stress Brace 1

• Allowable In-Plane Bending Stress Brace 1

• Allowable Out-of-Plane Bending Stress Brace 1

• Allowable Axial Stress Brace 2

• Allowable In-Plane Bending Stress Brace 2

• Allowable Out-of-Plane Bending Stress Brace 2

Member General Results

• Y Amplification Reduction Factor

• Z Amplification Reduction Factor

• Critical Buckling (Bending)

• Allowable Axial Stress

• Allowable Shear Stress

• Allowable Y Bending Stress (Not TUBE Ed17 On)

• Allowable Z Bending Stress (Not TUBE Ed17 On)

• Allowable Torsion Stress (TUBE Ed17 On)

• Allowable Bending Stress (TUBE Ed17 On)

Spectral Results

• Y Amplification Reduction Factor

• Z Amplification Reduction Factor

• Allowable Axial Stress

• Allowable Y Bending Stress (Not TUBE Ed16 On)

• Allowable Z Bending Stress (Not TUBE Ed16 On)

Release 2020 R1 - © ANSYS, Inc.


1515
Using Design Assessment

• Allowable Euler Buckling Stress Y

• Allowable Euler Buckling Stress Z

• Maximum Axial Stress

• Maximum Y Bending Stress

• Maximum Z Bending Stress

BS5950 Results
Two Results subtypes are available for this code of practice. The results available for those subtypes are
shown below.

Member Unity Checks

• Major Axis Bending

• Minor Axis Bending

• Major Axis Shear

• Minor Axis Shear

• Axial Tension

• Combined Axial + Moment

• Minor Axis Buckling

• Major Axis Buckling

• Lateral Torsional Buckling

• Overall Buckling

Member General Results

• Axial Force Capacity

• Major Axis Shear Force Capacity

• Minor Axis Shear Force Capacity

• Major Axis Bending Moment Capacity

• Minor Axis Bending Moment Capacity

• Reduced Moment Capacity - Major Axis

• Reduced Moment Capacity - Minor Axis

• Member Compressive Capacity - Minor Axis Buckling

• Member Compressive Capacity - Major Axis Buckling

Release 2020 R1 - © ANSYS, Inc.


1516
Predefined Assessment Types

• Member Moment Capacity - Lateral Torsional Buckling

DS449 High Results


Four Results subtypes are available for this code of practice. The results available for those subtypes
are shown below.

Member Unity Checks

• Von Mises

• Shear

• Local Buckling

• Y Total Buckling

• Z Total Buckling

• Hydrostatic Overpressure

• Combined Local + Hydrostatic

Joint (Nominal) Unity Check

• Axial

• In-Plane Bending

• Out-of-Plane Bending

• Bending

• Combined Axial + Bending

Member General Results

• Von Mises Stress

• Hoop Stress (H)

• Hydrostatic Pressure (H)

• Relative Slenderness Ratio For Local Buckling

• Critical Stress For Local Buckling

• Critical Stress For Hydrostatic Overpressure (H)

• Critical Stress For Combined Case (H)

• Critical Pressure (H)

• Maximum Axial Force

• Y Equivalent Design Moment

Release 2020 R1 - © ANSYS, Inc.


1517
Using Design Assessment

• Z Equivalent Design Moment

• Y Euler Buckling Force

• Z Euler Buckling Force

• Y Relative Slenderness Ratio

• Z Relative Slenderness Ratio

• Y Equivalent Geometric/Material Imperfections

• Z Equivalent Geometric/Material Imperfections

• Critical Stress

Joint General Results

• Proportion of Joint 1

• Proportion of Joint 2

• Gap

• Beta Ratio

• Tau Ratio

• Theta Angle

• Gamma Ratio

• Chord Stress

• Chord Yield Stress

• Chord Wall Shear Limit

• Brace Axial Stress

• Brace In-Plane Bending Stress

• Brace Out-of-Plane Bending Stress

• Axial UU Factor

• In-Plane UU Factor

• Out-of-Plane UU Factor

• Axial Ten/Comp CC Factor For Brace 1

• In-Plane Bending CC Factor For Brace 1

• Out-of-Plane Bending CC Factor For Brace 1

• Axial Ten/Comp CC Factor For Brace 2

Release 2020 R1 - © ANSYS, Inc.


1518
Predefined Assessment Types

• In-Plane Bending CC Factor For Brace 2

• Out-of-Plane CC Factor For Bending Brace 2

• Axial Nominal Load

• In-Plane Bending Moment

• Out-of-Plane Bending Moment

• Axial Capacity Brace 1

• In-Plane Bending Capacity Brace 1

• Out-of-Plane Bending Capacity Brace 1

• Axial Capacity Brace 2

• In-Plane Bending Capacity Brace 2

• Out-of-Plane Bending Capacity Brace 2

DS449 Normal Results


Two Results subtypes are available for this code of practice. The results available for those subtypes are
shown below.

Member Unity Checks

• Von Mises

• Shear

• Local Buckling

• Y Total Buckling

• Z Total Buckling

• Hydrostatic Overpressure

• Combined Local + Hydrostatic

Member General Results

• Von Mises Stress

• Hoop Stress (H)

• Hydrostatic Pressure (H)

• Relative Slenderness Ratio For Local Buckling

• Critical Stress For Local Buckling

• Critical Stress For Hydrostatic Overpressure (H)

Release 2020 R1 - © ANSYS, Inc.


1519
Using Design Assessment

• Critical Stress For Combined Case (H)

• Critical Pressure (H)

• Maximum Axial Force

• Y Equivalent Design Moment

• Z Equivalent Design Moment

• Y Euler Buckling Force

• Z Euler Buckling Force

• Y Relative Slenderness Ratio

• Z Relative Slenderness Ratio

• Y Equivalent Geometric/Material Imperfections

• Z Equivalent Geometric/Material Imperfections

• Critical Stress

ISO Results
Six Results subtypes are available for this code of practice. The results available for those subtypes are
shown below.

Member Unity Checks

• Axial

• Shear

• Torsion

• Y Bending

• Z Bending

• Resultant Bending

• Yield 1

• Yield 2

Hydrostatic Unity Checks

• Hoop Compressive

• Combined Hoop + Axial

• Combined Hoop Bending + Axial 1

• Combined Hoop Bending + Axial 2

Release 2020 R1 - © ANSYS, Inc.


1520
Predefined Assessment Types

• Combined

Joint Unity Check

• Axial

• In-Plane Bending

• Out-of-Plane Bending

• Combined Axial + Bending

Member General Results

• Y Moment Amplification Reduction Factor

• Z Moment Amplification Reduction Factor

• Column Slenderness Parameter

• Allowable Axial Stress

• Allowable Shear Stress

• Allowable Torsion Stress

• Allowable Y Bending Stress

• Allowable Z Bending Stress

• Allowable Y Euler Buckling Stress

• Allowable Z Euler Buckling Stress

• Allowable Local Buckling Stress

Hydrostatic General Results

• Section Position

• Hydrostatic Depth

• Hydrostatic Load Factor

• Geometry Parameter

• Hoop Buckling Coefficient

• Hoop Stress

• Allowable Axial Stress

• Allowable Bending Stress

• Allowable Elastic Axial Stress

• Allowable Inelastic Axial Stress

Release 2020 R1 - © ANSYS, Inc.


1521
Using Design Assessment

• Allowable Elastic Hoop Stress

• Allowable Inelastic Hoop Stress

Joint General Results

• Allowable Pa

• Allowable Ma In-Plane

• Allowable Ma Out-of-Plane

• Beta Ratio

• Gamma Ratio

• Tau Ratio

• Theta Angle

• Chord Axial Force

• Chord Moment In-Plane

• Chord Moment Out-of-Plane

• Chord Capacity

• Chord Strength

• Brace Axial Force

• Brace Moment In-Plane

• Brace Moment Out-of-Plane

• Joint Proportion (%) 1

• Joint Proportion (%) 2

• Joint Proportion (%) 3

• Joint Proportion (%) 4

• Joint Proportion (%) 5

• Axial Qu Factor 1

• Axial Qu Factor 2

• Axial Qu Factor 3

• Axial Qu Factor 4

• Axial Qu Factor 5

• Axial Qf Factor 1

Release 2020 R1 - © ANSYS, Inc.


1522
Predefined Assessment Types

• Axial Qf Factor 2

• Axial Qf Factor 3

• Axial Qf Factor 4

• Axial Qf Factor 5

• Gap Factor 1

• Gap Factor 2

• Gap Factor 3

• Gap Factor 4

• Gap Factor 5

• Qu Factor - In Plane

• Qu Factor - Out Of Plane

• Qf Factor - In Plane

• Qf Factor - Out Of Plane

NORSOK Results
Six Results subtypes are available for this code of practice. The results available for those subtypes are
shown below.

Member Unity Checks

• Axial

• Shear

• Torsion

• Y Bending

• Z Bending

• Resultant Bending

• Bending + Shear

• Shear + Bending + Torsion

• Yield 1

• Yield 2

Hydrostatic Unity Checks

• Hoop Compressive

Release 2020 R1 - © ANSYS, Inc.


1523
Using Design Assessment

• Combined Hoop + Axial

• Combined Hoop Bending + Axial 1

• Combined Hoop Bending + Axial 2

• Combined

Joint Unity Check

• Axial

• In-Plane Bending

• Out-of-Plane Bending

• Combined Axial + Bending

Member General Results

• Y Moment Amplification Reduction Factor

• Z Moment Amplification Reduction Factor

• Chord Diameter

• Chord Thickness

• Column Slenderness Parameter

• Allowable Axial Stress

• Allowable Shear Stress

• Allowable Torsion Stress

• Allowable Bending Stress

• Allowable Y Euler Buckling Stress

• Allowable Z Euler Buckling Stress

• Allowable Yield

Hydrostatic General Results

• Hydrostatic Depth

• Geometry Parameter

• Hoop Buckling Coefficient

• Hoop Stress

• Allowable Axial Stress

• Allowable Bending Stress

Release 2020 R1 - © ANSYS, Inc.


1524
Predefined Assessment Types

• Allowable Elastic Axial Stress

• Allowable Inelastic Axial Stress

• Allowable Elastic Hoop Stress

• Allowable Inelastic Hoop Stress

Joint (Nominal) General Results

• Gap

• Beta Ratio

• Tau Ratio

• Theta Angle

• Chord Stress

• Chord Yield Stress

• Brace Yield Stress

• Brace Axial Stress

• In-Plane Brace Bending Stress

• Out-of-Plane Brace Bending Stress

• Axial Qf Factor

• In-Plane Bending Qf Factor

• Out-of-Plane Bending Qf Factor

• Axial Qu Factor Brace 1

• In-Plane Bending Qu Factor Brace 1

• Out-of-Plane Bending Qu Factor Brace 1

• Axial Qu Factor Brace 2

• In-Plane Bending Qu Factor Brace 2

• Out-of-Plane Bending Qu Factor Brace 2

• Axial Force

• In-Plane Bending Force

• Out-of-Plane Bending Force

• Allowable Axial Force Brace 1

• Allowable In-Plane Bending Moment Brace 1

Release 2020 R1 - © ANSYS, Inc.


1525
Using Design Assessment

• Allowable Out-of-Plane Bending Moment Brace 1

• Allowable Axial Force Brace 2

• Allowable In-Plane Bending Moment Brace 2

• Allowable Out-of-Plane Bending Moment Brace 2

• Chord Effective Length

NPD Results
Nine Results subtypes are available for this code of practice. The results available for those subtypes
are shown below.

Member Unity Checks (1984)

• Axial

• Bending (TUBE)

• Lateral Pressure (TUBE)

• Torsional Shear (TUBE)

• Bending Shear (TUBE)

• Von Mises

• Axial + Bending Combined (TUBE)

• Axial + Lateral Pressure (TUBE)

• Axial + Torsion (TUBE)

• Axial + Bending Shear (TUBE)

• Y Shear (BEAM)

• Z Shear (BEAM)

• Y Total (Overall)

• Z Total (Overall)

Joint (Punching) Unity Checks (1984)

• Punching

• Yield

Member Unity Checks (1992)

• Von Mises (Yield)

• Y Total (Overall)

Release 2020 R1 - © ANSYS, Inc.


1526
Predefined Assessment Types

• Z Total (Overall)

Joint Unity Checks (1992)

• Axial

• In-Plane Bending

• Out-of-Plane Bending

• Combined Axial + Bending

Member Local General Results (1984)

• Section Position

• Axial Stress

• Bending Stress (TUBE)

• Hoop Stress (TUBE)

• Von Mises Stress

• Shear Stress Due To Torsion (TUBE)

• Shear Stress Due To Bending (TUBE)

• Relative Slenderness Ratio (Axial) (TUBE)

• Relative Slenderness Ratio (Bending) (TUBE)

• Relative Slenderness Ratio (Lateral Pressure) (TUBE)

• Relative Slenderness Ratio (Shear) (TUBE)

• Critical Buckling Stress (Axial) (TUBE)

• Critical Buckling Stress (Bending) (TUBE)

• Critical Buckling Stress (Lateral Pressure) (TUBE)

• Critical Buckling Stress (Shear) (TUBE)

• Maximum Y Shear Stress (BEAM)

• Maximum Z Shear Stress (BEAM)

Member Overall General Results (1984)

• Y Equivalent Moment

• Z Equivalent Moment

• Y Relative Slenderness Ratio

• Z Relative Slenderness Ratio

Release 2020 R1 - © ANSYS, Inc.


1527
Using Design Assessment

• FKY To Yield Stress Ratio

• FKZ To Yield Stress Ratio

• Y Theoretical Buckling Load

• Z Theoretical Buckling Load

• Y Euler Buckling Load

• Z Euler Buckling Load

• Y Ultimate Bending Capacity

• Z Ultimate Bending Capacity

• Critical Torsional Axial Stress

• Revised Buckling Strength

Member General Results (1992)

• Axial Stress

• Bending Stress

• Hoop Stress

• Von Mises Stress

• Torsional Stress

• Maximum Bending Shear Stress

• Y Equivalent Moment

• Z Equivalent Moment

Joint General Results (1984)

• Theta Angle

• Beta Ratio

• Tau Ratio

• Gamma Ratio

• Joint Geometry Factor

• Chord Stress Factor

• Brace Axial Stress

• In-Plane Brace Bending Stress

• Out-of-Plane Brace Bending Stress

Release 2020 R1 - © ANSYS, Inc.


1528
Predefined Assessment Types

• Chord Axial Stress

• Chord Bending Stress

• Chord Shear Yield Stress

• Acting Punching Shear

• Critical Joint Punching Shear Stress

Joint General Results (1992)

• Theta Angle

• Beta Ratio

• Gamma Ratio

• Brace Axial Stress

• Brace In-Plane Stress

• Brace Out-of-Plane Stress

• Chord Axial Stress

• Chord Y Bending Stress

• Chord Z Bending Stress

Using FATJACK with the Design Assessment System


The ability to perform joint fatigue assessment has been incorporated into Workbench using the Design
Assessment System. This system can be connected to Static Structural, Transient Structural, and Harmonic
Response systems as required. See Analysis Type Selection (p. 1532) for more details of the appropriate
upstream systems. The structural analysis needs to be performed using the Mechanical solver. The fol-
lowing sections describe how to setup a FATJACK analysis in the Design Assessment system.
Introduction
Information for Existing ASAS Users
Solution Selection Customization
Attribute Group Types
Available Results

Introduction
Attribute Group (p. 1545) objects are added to the Design Assessment system to define the input data
to FATJACK. DA Result (p. 1547) objects are added to the Design Assessment system to define which
results to obtain and display. Workbench and Design Assessment are geometry based, which means
that areas of the geometry are selected rather than individual elements. With the Mechanical solver, a
member ought to be meshed and formed of a number of elements. Some data associated to the upstream
solutions is entered in the solution selection table.

Results can be added to the Solution in the Design Assessment system and displayed in Workbench;
these will contour the maximum value that occurs for each element. Results can be added either before
or after the analysis. If additional results are added after the analysis has been performed, then evaluating

Release 2020 R1 - © ANSYS, Inc.


1529
Using Design Assessment

the results will obtain the values from the existing database, if the result type exists. Elements that do
not have results will be semi-transparent. Results are for the end of the brace and are shown on the
brace element.

Reports can be produced of the input data and the results can be parameterized and exposed for use
with other systems.

Information for Existing ASAS Users


FATJACK Attribute Group Type Attribute Group Subtype Requirement
Command
ANALYSIS Analysis Type Selection Time History (p. 1533), Spectral (p. 1533),
Compulsory
Stress History (p. 1533), and
Deterministic (p. 1533)
ACCE Automatically defined based on units, Analysis type Spectral only.
ALLO Analysis Type Selection Stress History (p. 1533)
CHOR Geometry Definition Chord Definition (p. 1534)
CURV Material Definitions S-N Curve Definition (p. 1536) Compulsory
CYCL Analysis Type Selection Time History (p. 1533) Compulsory for Time
History analysis
types
DESI Automatically determined from the geometry
DETE Data is entered via Structure Selection table for analysis type Time Compulsory for
History (p. 1533). For Deterministic (p. 1533) and Stress History (p. 1533)
Deterministic and
analysis types, the information should be provided in a separate Stress History
file. Analysis Types
FREQ Supply in a separate file with SPEC and TRAN data, referenced in Compulsory for
Analysis Type for Spectral (p. 1533) analyses. Spectral analysis
types
GAP Geometry Definition Gap Definition (p. 1534)
GAPD Geometry Definition Default Gap (p. 1534)
HIST Data is entered via Structure Selection table Compulsory for Time
History analyses
INSE Geometry Definition Inset (p. 1534)
INSP Joint Inspection Points Tubular Members, By
Number (p. 1534)

Tubular Members, By List of


Angles (p. 1534)

Non-Tubular Members, By
Symmetric Positions (p. 1535)

Non-Tubular Members, By
Individual Positions (p. 1535)
JOIN Analysis Type Selection Time History (p. 1533), Spectral (p. 1533),
Compulsory
Stress History (p. 1533), and
Deterministic (p. 1533)

Release 2020 R1 - © ANSYS, Inc.


1530
Predefined Assessment Types

FATJACK Attribute Group Type Attribute Group Subtype Requirement


Command
LIMI Not Supported, can be added using General Text (p. 1534) input
PARA Not Supported, can be added using General Text (p. 1534) input
PRIN Automatically defined as PRIN FULL DETA USAG XCHE SCFE SCFP DAMW, plus OCUR,
OCRW or OCRT for Spectral Analyses or plus RNGE or PEAK for Stress History Analyses,
both depending upon the option entered in the Analysis definition. If different text output
is required, then it can be added using General Text (p. 1534) input.
REDU SCF Definitions Marshall Reduction (p. 1535)
SCF SCF Definitions Default Values (p. 1535) Compulsory
SCF ANGLE SCF Definitions Joint Values, Tubular (Inspection
Point by Angle) (p. 1535)
SCF AUTO SCF Definitions Default Empirical Formulation by
DEFAULT Joint Type (p. 1535)
SCF AUTO SCF Definitions Empirical Formulation by
JOINT Joint (p. 1535)
SCFBRACE SCF Definitions Joint Values, Non-Tubular (All
Inspection Points) (p. 1535)
SCFJOINT SCF Definitions Brace Side Joint Values, Tubular
(Crown + Saddle) (p. 1535)

Chord Side Joint Values, Tubular


(Crown + Saddle) (p. 1535)
SCFMINIMUM SCF Definitions Minimum Value (p. 1536)
SCFPOINT SCF Definitions Joint Values, Non-Tubular (Inspection
Point by Position) (p. 1535)
SECO Geometry Definition Excluded Members (p. 1534)
SIGM Not Supported Analysis Type for Spectral (p. 1533) Compulsory for
analyses Spectral analysis
S-N Material Definitions S-N Curve Application (p. 1536) Compulsory
SPEC Supply in a separate file Analysis Type for Spectral (p. 1533) Compulsory for
with FREQ and TRAN data analyses Spectral analysis
SPRE Not Supported Analysis Type for Spectral (p. 1533) Compulsory for
analyses Spectral analysis
THIC Material Definitions S-N Thickness Modification (p. 1536)
TRAN Supply in a separate file Analysis Type for Spectral (p. 1533) Compulsory for
with FREQ and SPEC data analyses Spectral analysis
TYPE Geometry Definition Joint Type (Single Brace) (p. 1534)

Joint Type (Multiple


Braces) (p. 1534)
UNIT Automatically determined from analysis, selections for N mm, pdl ft, pdl in and N m are
supported.
WAVE WAVE AUTO Automatically included for Spectral, Deterministic and Stress History
analysis types, use General Text (p. 1534) entry to override if specific control is required.

Release 2020 R1 - © ANSYS, Inc.


1531
Using Design Assessment

FATJACK Attribute Group Type Attribute Group Subtype Requirement


Command
YEAR Analysis Type Selection Time History (p. 1533), Spectral (p. 1533),
Compulsory
Stress History (p. 1533), and
Deterministic (p. 1533)

Solution Selection Customization


The Solution Selection object for FATJACK has additional columns for the entry of the range of steps
to use for rainflow counting (start step, end step, and interval between steps). Also, the occurrence data
for each environment can be defined either by number of cycles per year and an amplification factor,
or by probability. If a probability is entered this will be used instead of cycles per year. A consistent
method needs to be used throughout all solution environments. This data is only applicable for Time
History (p. 1533) based analyses. For Stress History (p. 1533) and Deterministic (p. 1533) methods the occurrence
data is defined externally, referenced in the analysis type.

Attribute Group Types


Attribute Groups enable the entry of the data that is associated with the FATJACK analysis. The following
sections describe the available Attribute Group Types and their subtypes.
Analysis Type Selection
General Text
Geometry Definition
Joint Inspection Points
SCF Definitions
Material Definition
Ocean Environment

Some attribute groups are compulsory, indicated by superscript letters as follows:

TH – compulsory for Time History based analyses

SH – compulsory for Stress History based analyses

SP – compulsory for Spectral based analyses

DT – compulsory for Deterministic based analyses

C – compulsory for all analyses

Note

If units are changed when defining data for Attributes, then the resulting data sent to the
processing script may be incorrect. It is recommended that units are not modified from those
used in creating the geometry.

Analysis Type Selection


All types of fatigue analysis supported with this interface. Add an Attribute Group under the Design
Assessment object in the tree, and set the Attribute Group Type to Analysis Type Selection. The At-
tribute Group Subtype can be set to one of the following values, and the associated attributes for
that subtype can be set:

Release 2020 R1 - © ANSYS, Inc.


1532
Predefined Assessment Types

• Time History TH

Enables the selection of which joints are to be included, along with definition of the rainflow counting
information (Number of Intervals, Peak Stress Range Required, and Stress Range Limit (1st Interval)
attributes) and Target Year Life of the analysis. Upstream systems should be Structural Transient,
normally each including randomized ocean loading with different wave directions.

• Stress History SH

Enables the selection of which joints are to be included, along with definition of the Target Year Life
of the analysis. Wave occurrence data should be provided in a text file containing the FATJACK
commands. Select this file using the browse button for the Deterministic Data attribute. Wave con-
ditions (heights, periods, directions) are automatically determined from the ocean loading provided
in upstream system(s) in the order that they are defined. Upstream systems can be either static
structural or transient structural. If loading is not applied using the ocean loading, then an additional
attribute group of the type General Text (p. 1534) can be used to define the WAVE commands. If the
value for the Allowable Stress attribute is set to zero, then actual stresses will be output; if a value
is entered, then utilization factors will be output. These values will either be the Peak or Full Range
values as specified in the Stress Range Output attribute.

• Spectral SP

Enables the selection of which joints are to be included, along with definition of the Wave Spreading
and Target Year Life of the analysis. Wave transfer function, spectrum, and additional frequency
data should be provided in a text file containing the FATJACK commands. Select this file using the
browse button for the Spectrum Data attribute. Wave load cases are automatically determined using
the harmonic ocean wave procedure provided in upstream system(s) in the order that they are defined.
Upstream systems should be of the Harmonic Response type; both the Static and Harmonic options
of the HROCEAN command can be used when performing Spectral analysis. The Stress Histogram
Results Output (tables of number of cycles against stress range) attribute may be Enabled and op-
tionally set to output results By Transfer Function or By Spectrum. Unless Stress Histogram Results
Output is Disabled, a valid Peak Stress Range Required attribute must be defined, together with
the number of reporting intervals (Number of Intervals attribute). If Stress Histogram Results
Output is Disabled, values must be entered for Peak Stress Range Required and Number of Intervals,
but they are not used.

• Deterministic DT

Enables the selection of which joints are to be included, along with definition of the Target Year Life
of the analysis. Wave occurrence data should be provided in a text file containing the FATJACK
commands. Select this file using the browse button for the Deterministic Data attribute. Wave load
cases are automatically determined using the harmonic ocean wave procedure provided in upstream
system(s) in the order that they are defined. Upstream systems should be of harmonic response type;
only the Static option of the HROCEAN command is appropriate for Deterministic analysis.

Note

References to ocean loading assume the input of Mechanical APDL commands using Com-
mands (p. 1475) objects in upstream Mechanical systems.

Release 2020 R1 - © ANSYS, Inc.


1533
Using Design Assessment

General Text
This can be used to supply additional and non-supported commands. This will always override data set
by other tree objects.

• Geometry Independent

Enables additional commands to be entered that will be appended to the end of all code checks.

Geometry Definition
All groups that have this type enable the selection of a particular code of practice.

• Chord Definition

The chord member(s) and the central vertex can be chosen along with the length of the chord and
fixity parameters to define which members at a joint form the chords. Without this definition, chords
are automatically determined. Chords for each Joint need to be defined separately. Only applicable
to joint checks.

• Gap Definition

Enables specific gap information to be defined between the pairs of braces forming KT or K joints,
and to determine which member is the through member.

• Default Gap

Enables the entry of the default gap size to use for the given equations.

• Inset

Enables a distance to be entered to allow for moment backoff.

• Joint Type (Single Brace)

Enables the manual definition of joint type when only a single brace is connected.

• Joint Type (Multiple Braces)

Enables the manual definition of joint type when more than one brace is connected.

• Excluded Members

Enables members that are to be excluded from the joint checks to be selected.

Joint Inspection Points


Inspection points are the positions to check for fatigue around the brace where it connects to the chord.

• Tubular Members, By Number

Use this to define the number of inspection points equally spaced around tubular members.

• Tubular Members, By List of Angle

Release 2020 R1 - © ANSYS, Inc.


1534
Predefined Assessment Types

Use this to define a list of space separated angles that define the inspection points spaced around
tubular members at an individual joint.

• Non-Tubular Members, By Symmetric Positions

Use this to define inspection points for selected non-tubular members by defining Z and Y offset
distances from the centre of the member to generate 4 points for the positive and negative combin-
ations.

• Non-Tubular Members, By Individual Positions

Use this to define specific inspection points on an individual joint, by a list of y z pairs, space separated.

SCF Definitions
All groups that have this type enable the entry of values that define the stress concentration factors.

• Marshall Reduction

Use this to define the Marshall Reduction factor for the brace side SCF values when using the Kuang
equations.

• Default Values C

Use this to specify the default SCF values for a given section type.

• Chord Side Joint Values, Tubular (Crown + Saddle)

Use this to specify user defined crown and saddle SCF values for the chord side of tubular braces at
specific joints.

• Brace Side Joint Values, Tubular (Crown + Saddle)

Use this to specify user defined crown and saddle SCF values for the brace side of tubular braces at
specific joints.

• Joint Values, Non-Tubular (All Inspection Points)

Use this to specify the SCF values at all inspection points on non-tubular braces.

• Joint Values, Tubular (Inspection Point by Angle)

Use this to specify the SCF values at specific inspection points on tubular braces.

• Joint Values, Non-Tubular (Inspection Point by Position)

Use this to specify the SCF values at specific inspection points on non-tubular braces.

• Empirical Formulation by Joint

Use this to specify that the empirical equations to be utilized for the SCF generation for the given
joint selection.

• Default Empirical Formulation by Joint Type

Release 2020 R1 - © ANSYS, Inc.


1535
Using Design Assessment

Use this to specify the default empirical equations to be utilized for the SCF generation for the given
joint type.

• Minimum Value

Use this to set the minimum SCF value in the analysis.

Material Definition
All groups that have this type enable the selection of a particular code of practice.

• S-N Curve Application C

Use this to define which S-N Curve applies to selected area of the model. Enter the same name as
used in the S-N Curve Definition.

• S-N Thickness Modification

Use this to request the modification of the S-N curves to account for varying plate thickness.

• S-N Curve Definition C

Use this to define an S-N curve for use in the analysis; the name is limited to 4 characters in length.

Ocean Environment
All groups that have this type define wave occurrence data in the ocean environment, if a large number
of occurrence data needs to be entered, then general entry can be used to reference an external file
containing the data.

• Additional Wave Occurrence Data

Use this to define a single line of additional wave occurrence data; i.e., additional wave height, direc-
tion, and number of cycle definitions. Only applicable to Deterministic and Stress History analysis
types.

Available Results
The following results are available as indicated below. Results are added using the DA Results tree object.

• Damage Values (p. 1537) *

• Fatigue Assessment (p. 1538) *#

• SCF Values (p. 1538) #

• Stress Histogram Results (p. 1538)

• Stress Range Results (p. 1539)

* To obtain these results for Spectral Analyses, Stress Histogram Results Output needs to be set to
Disabled.

# To obtain these results for Stress History Analyses, Stress Range Output needs to be set to Disabled.

Release 2020 R1 - © ANSYS, Inc.


1536
Predefined Assessment Types

When retrieving results from a FATJACK analysis, you have the option of specifying how the value of
the result is determined among all of the inspection points, using the Result Value Option and Specified
Inspection Point attributes.

Result Value Option


This attribute and the Specified Inspection Point (if needed) allow you to specify how the results are re-
trieved.

• Maximum – Retrieves the maximum value across the inspection points (default)

• Minimum – Retrieves the minimum value across the inspection points

• Absolute Maximum – Retrieves the absolute maximum value across the inspection points

• Absolute Minimum – Retrieves the absolute minimum value across the inspection points

• Inspection Point – Retrieves the value for the point defined by the Specified Inspection Point

Specified Inspection Point


This attribute is exposed if Inspection Point is selected for the Result Value Option (otherwise this attribute
is unused and should be zero). Enter a number between 1 and the maximum number of inspection points.

Damage Values
• Per Wave (Solution)

• All Wave Cases (Solutions)

Release 2020 R1 - © ANSYS, Inc.


1537
Using Design Assessment

The damage per wave for each joint (worst case for each inspection point, shown on the brace and
chord elements) can be displayed. For the Per Wave (Solution) result, the Spectrum or Wave Case
number needs to be entered as additional input. For All Wave Cases (Solutions), results will be obtained
and displayed for all, with minimum and maximum values shown.

Fatigue Assessment
• Usage Factor

• Life

The Usage Factor or Life for each joint (worst case for each inspection point, shown on the brace and
chord elements) can be displayed.

SCF Values
• Brace Side

• Chord Side

The SCF factors for each joint for the chord and brace sides (worst case for each inspection point, shown
on the brace and chord elements) can be displayed for the required component (Axial, In-Plane Bending,
Out-of-Plane Bending).

Stress Histogram Results


These results are only applicable to Time History (p. 1533) analysis results.

• Stress Range by Wave and Interval

• Stress Range by Wave - All Intervals

• Stress Range by Interval - All Waves

• Occurrence by Wave and Interval

• Occurrence by Wave - All Intervals

• Occurrence by Interval - All Waves

The stress range and occurrence of stress range data for each joint (worst case for each inspection point,
shown on the brace and chord elements) can be displayed. In the cases where the result is for an indi-
vidual wave (i.e. Transient analysis), the Wave Case number needs to be entered. This is equivalent to
the row of the upstream solution in the Solution Selection (p. 1541) table. In the cases where the result
is for an individual interval, the Interval value needs to be entered.

These results are only applicable to Spectral (p. 1533) analysis results, when Stress Histogram Results
Output is “Enabled”.

• Occurrence by Interval

• Occurrence - All Intervals

• Occurrence Total

• Stress Range by Interval

Release 2020 R1 - © ANSYS, Inc.


1538
Predefined Assessment Types

• Stress Range - All Intervals

The stress range and occurrence of stress range data for each joint (worst case for each inspection point,
shown on the brace and chord elements) can be displayed. In the case where the result is for an indi-
vidual interval, the Interval value needs to be entered.

When Stress Histogram Results Output is set to “By Transfer Function”, the following results are applicable:

• Occurrence by Transfer Function and Interval

• Occurrence by Transfer Function - All Intervals

• Occurrence by Interval - All Transfer Functions

The occurrence data for each joint (worst case for each inspection point, shown on the brace and chord
elements) can be displayed for a given or all Transfer functions and a given or all Intervals.

When Stress Histogram Results Output is set to “By Spectrum”, the following results are applicable:

• Occurrence by Spectrum and Interval

• Occurrence by Spectrum - All Intervals

• Occurrence by Interval - All Spectrums

The occurrence data for each joint (worst case for each inspection point, shown on the brace and chord
elements) can be displayed for a given or all Spectrum(s) and a given or all Intervals.

Stress Range Results


These results are only applicable to Stress History results; in addition, Stress Range Output must be set
to either Peak Stress or Stress Range appropriately.

• Signed Peak Stress

• Signed Peak Stress – All Wave Cases

• Peak Stress Utilization

• Peak Stress Utilization – All Wave Cases

• Stress Range

• Stress Range – All Wave Cases

• Stress Range Utilization

• Stress Range Utilization – All Wave Cases

The stress data for each joint (worst case for each inspection point, shown on the brace and chord
elements) can be displayed. When a Wave Case is being specified, the Wave Case number is the case
entered in the Deterministic (p. 1533) analysis data.

Utilization results are only available if an allowable stress has been entered. Non-utilization results are
only available if a zero allowable stress has been entered.

Release 2020 R1 - © ANSYS, Inc.


1539
Using Design Assessment

Changing the Assessment Type or XML Definition File Contents


If you change the Assessment Type of your Design Assessment system, or if you change the location
or contents of the XML definition file, the Mechanical application will evaluate the existing Design As-
sessment objects in your project and modify those objects as indicated below. If no content changes
are found in the XML definition file (even if the file location changes), or if only the Solve or Evaluate
script locations change, no changes are made in the Design Assessment objects in the tree.

If you change the Assessment Type of the Design Assessment system:

From Solution Combination Only to BEAMCHECK


All existing Attribute Group and DA Result objects will be refreshed based on certain criteria (p. 1540).

From Solution Combination Only to FATJACK


All Mechanical results inserted under the Solution object will be deleted and existing Attribute Group and
DA Result objects will be refreshed based on certain criteria (p. 1540).

From FATJACK to BEAMCHECK


All existing Attribute Group and DA Result objects will be refreshed based on certain criteria (p. 1540).

From FATJACK to Solution Combination Only


All Attribute Group objects will be deleted and DA Result objects will be refreshed based on certain criter-
ia (p. 1540).

From BEAMCHECK to FATJACK


All Mechanical results will be deleted and Attribute Group and DA Result objects will be refreshed based
on certain criteria (p. 1540).

From BEAMCHECK to Solution Combination Only


All Attribute Group objects will be deleted and DA Result objects will be refreshed based on certain criter-
ia (p. 1540).

Note

The behavior described above also corresponds to the settings of the DAData and
CombResults properties in the DAScripts section of the XML definition file. For BEAMCHECK,
DAData=1 and CombResults=1; for FATJACK, DAData=1 and CombResults=0; for Solution
Combination Only, DaData=0 and CombResults=1. So, for example, if you have the DAData
and CombResults properties both set to 1 in a user defined XML file, and you change the
DAData property to 0, the behavior would be that described in the From BEAMCHECK to
Solution Combination Only entry above.

If the contents of any Design Assessment XML definition file change, the Mechanical application
refreshes the existing Design Assessment objects as follows:

When the Group Type in use is not present in the file


The affected Attribute Group or DA Result is initialized to default values. Default values are the values
which you get when an Attribute Group or DA Result is inserted in the tree.

When the Group Sub Type in use is not present in the file
The affected Attribute Group or DA Result is initialized to default values. Default values are the values
which you get when an Attribute Group or DA Result is inserted in the tree.

Release 2020 R1 - © ANSYS, Inc.


1540
Solution Selection

When the Attribute IDs present for a Group Type and Sub Type combination in use are changed (IDs
added or removed)
The affected Attribute Group or DA Result is initialized to default values. Default values are the values
which you get when an Attribute Group or DA Result is inserted in the tree.

Group Type not in use is changed/added/removed


No existing Design Assessment objects are affected.

Group Sub Type not in use is changed/added/removed


No existing Design Assessment objects are affected.

Attribute IDs are changed/added/removed for a Group Type and Sub Type combination which is not in
use
No existing Design Assessment objects are affected.

Validation/Default Value/Attribute Name/Geometry Application/Property type is changed


Design Assessment object is modified as indicated.

Note

For any above mentioned change, the state of the system becomes obsolete, forcing the
user to solve again.

Solution Selection
A Solution Selection object is automatically included as part of the Design Assessment environment.
This object allows you to select upstream solutions to be used in a way similar to the standard Solution
Combination (p. 1370) object available in the Mechanical application.

To use the Solution Selection object, the individual analysis systems should be connected in sequence
on the Project Schematic (sharing the Engineering Data, Geometry and Model cells), with the Design
Assessment system at the end of the chain.

Depending upon the Assessment Type, various types of upstream systems are valid as shown in the
table below.

Assessment Type Valid systems


Solution Combination Static Structural, Modal, Harmonic Response, Random Vibration Analysis,
Only Response Spectrum Analysis, or Transient Structural
BEAMCHECK Transient Structural or Static Structural
FATJACK Transient Structural, Static Structural, or Harmonic Response
User Defined Static Structural, Modal, Harmonic Response, Random Vibration, Response
Spectrum, Explicit Dynamics, or Transient Structural

The Solution Selection Table


When you click the Solution Selection object in the tree, the Solution Selection table is displayed. To
include systems in the Solution Selection table either for access to the results or inclusion in the solution
combination, right-click the table and select Add. In the Environment Name column of the row that
is added, click Choose.... and select the name of the system that you want to add to the table. For
Static, Transient, Explicit, and Harmonic systems, you can specify that a set of results is returned for a

Release 2020 R1 - © ANSYS, Inc.


1541
Using Design Assessment

particular system. (Other types of systems will only return a single result for each system at the indicated
Time/Step, Frequency/Phase Angle, or Mode.) If a Random Vibration analysis is selected, 1-sigma results
are used in solution combination.

Set the values in the columns to select the results that are returned for each solution.

• Multiple Sets – Values are Enabled or Disabled. This column applies to any upstream solution that supports
Multiple Set data, i.e. Static, Transient, Explicit Dynamics and Harmonic.

– If Enabled, then the user can enter Start/End Times, or Min/Max Frequencies to define a result step/substep
for combination (all result sets found within the boundaries of the defined step are used) or to use during
the execution of their scripts.

– If Disabled, then only the End Time and Max Frequency columns will be available in order to define a
single result point to be used for combination (the result set defined is used for every calculated point in
the combined result) or to use during the execution of the scripts.

• Start Time (s) – Will define the start time of the step/substep used from the upstream solution.

• End Time (s) – Will define the end time of the step/substep used from the upstream solution.

• Step – The step number used from the upstream solution. Value can also be “Multiple” and “All”, in cases
where the Start and End Times defined cover more than one step or the entire analysis from the upstream
solution.

• Min Frequency (s) – Will define the start frequency of the step/substep used from the upstream solution.

• Max Frequency (s) – Will define the end frequency of the step/substep used from the upstream solution.

The Step column in the solution selection table defaults to 'All' which means all steps from your upstream
solution are available. All can be specified by entering '0' in the Step column. Otherwise this column
can take any integer value that lies within the step boundaries to define a single step. If you define a
start or end time that is outside the boundaries of one step, then the Step column will say Multiple.

Steps are inclusive of their Start/End Times or Min/Max Frequencies. During combination, the data from
all result points within the steps/substeps defined are linearly combined to produce a result containing
multiple sets. Therefore the limits of the combined result will be defined by the smallest and greatest
values (Start/End Time or Min/Max Frequency) found within the Solution Selection table.

Results Availability
The Results Availability field in the Details panel for the Design Assessment system Solution object
allows you to specify which Mechanical results will be available to the Design Assessment system. If
Results Availability is set to Filter Combination Results and different upstream system types are se-
lected, only results that are valid for all selected systems can be inserted under the Solution object.
However, if you set the Results Availability field to Allow all Available Results, you can add any results

Release 2020 R1 - © ANSYS, Inc.


1542
Solution Selection

valid for any of the selected systems to the Solution object. In this case, results that are inserted will
be combined for those systems for which they are valid. You can set the default value for the Results
Availability field in the Mechanical Options (p. 105).

If Results Availability is set to Filter Combination Results, and additional upstream systems are selected
which cause a result type to be invalid, then its state will change accordingly and a solution will not
be possible.

Note

• When used in a solution combination based result, it may not be correct to combine the results.
Any combined results are formed by linear combination only.

• The available systems in the drop-down list are not constrained depending upon the Assessment
Type.

• The Results Availability setting will only appear under the Design Assessment Solution object
in the tree if the <CombResults> tag within the XML that is being used by the Design Assessment
system is set to 1. Otherwise it has no function.

• User defined results (p. 1340) containing complex expressions are supported through the use of
DA Results (p. 1495). In addition, you can access results from various environments, using python
scripts to combine results with highly complex, user defined mathematical functions (see Cre-
ateSolutionResult in the Solution (p. 1579) class).

Solution Combination Behavior


The Solution Selection object differs in several ways from a standard Solution Combination object:

• There is an ability to add extra columns to the worksheet using the XML configuration file. Each row in
the table can be used to enter additional data that can be passed out to the processing script. These
values can be obtained using the Design Assessment API.

• Results are added to the Solution object in the Design Assessment system, not directly under the
Solution Selection object.

• The Solution Selection object can be configured such that select results from multiple upstream systems
are available for use in post processing scripts, but the display of combined results is suppressed. For
the FATJACK Assessment Type, or when CombResults = 0 in a user defined XML file, Solution Selection
will make the results of the selected solutions available for external processing, but no solution com-
bination is done, and no Mechanical results are available.

• Appropriate columns are enabled to access appropriate result sets defined by start time, end time, step,
minimum frequency, maximum frequency, phase angle, and mode, based on the upstream system.

• Upstream results systems can be accessed via the python scripts using the Selection class (p. 1578).

Where times or frequencies overlap, data will be combined. However, where these values are unique
to an upstream solution, the data will be the equivalent to the result point held in the upstream solution.

The following tables and charts illustrate how the combination takes place. Here is an example of
solutions entered in the Solution Combination table:

Release 2020 R1 - © ANSYS, Inc.


1543
Using Design Assessment

The individual uncombined results are:

The combined results would be as follows. Notice here that the solution with Multiple Sets Disabled is
a single result point and therefore combined over the entire result.

The Effective Result for the deformation values of Node X in the combined result would be:

Release 2020 R1 - © ANSYS, Inc.


1544
Using the Attribute Group Object

The combined plot, where the Combination line illustrates the combined values of Node X in Solutions
1 to 4 at these time points, would be:

Using the Attribute Group Object


Attribute Group objects allow the Mechanical application to collect inputs. They are available in Pre-
defined Assessment Types such as BEAMST and FATJACK, or can also be configured in the XML definition
file of a User Defined Type. After you have opened the project in the Mechanical application, insert an
Attribute Group by one of the following methods:

1. Right click the Design Assessment object and select Insert > Attribute Group

or

Click on the Design Assessment object, then click the Attribute Group button in the toolbar.

An Attribute Group object will be added to the analysis.

Release 2020 R1 - © ANSYS, Inc.


1545
Using Design Assessment

2. Click on the Attribute Group and then set it up by selecting the appropriate AttributeGroupType and
AttributeGroupSubtype. This will display the attributes for that group subtype.

3. Enter the attribute values that you wish to pass out to the postprocessing script defined in the XML
definition file, along with any associated geometry information.

Note

Numerical attributes within an attribute group can be parameterized.

Developing and Debugging Design Assessment Scripts


The scripting environment used in Design Assessment is the same as that used in the Workbench and
is based on IronPython, which is well integrated into the rest of the .NET Framework (on Windows) and
Mono CLR (on Linux). For more details see the Workbench Scripting documentation.

Release 2020 R1 - © ANSYS, Inc.


1546
Using the DA Result Object

With the help of a development environment, such as Microsoft® Visual Studio®, Python scripts can be
developed and “debugged”. To debug a script, open its text file in your development environment and
attach the debugger to the AnsysWBU.exe process of interest. Be sure to specify managed code mode.
You will then be able to control the execution of your script, stepping along and reviewing the values
obtained.

Using the DA Result Object


DA Result objects allow you to specify what results to calculate and how to display them. You can add
DA Result objects to the analysis system for the BEAMCHECK, FATJACK or Solution Combination assess-
ment types, and for any custom scripts you create.

Important

Note the following:

• For Shells, the DA Result types only produce results for the top surface of the Shell.

• DA Result types do not support Cyclic Symmetry.

Define a DA Result object in a Design Assessment system as follows:

1. Insert a DA Result object using one of the following methods.

• Right click the Solution object under Design Assessment and select Insert > DA Result, or

• Click on the Solution object, then click the DA Result button in the toolbar.

Click on the newly added DA Result object to setup the fields in the Details panel.

2. Set the Scoping Method for the DA Result.

• If you choose Geometry Selection, Geometry defaults to All Bodies; or you can select the part of the
geometry for which you want to see results and click Apply.

• If you choose Named Selection, select a defined Named Selection from the drop-down list.

3. Select the desired Result Type and Result Subtype from the drop-down lists.

4. Set By to Substep Value or Result Set.

• If you choose Result Set, enter the result Set Number that you want to observe.

• If you choose Substep Value, enter the Substep Value. Substep Value is equivalent to the Result
Time/Result Frequency on a normal Result Object, and as such if you enter '0' in the user interface you
will automatically receive the 'Last' result point. Otherwise you can enter any double value that is within
the boundaries of your result.

5. Set the Entry Value for each attribute in the DA Result object to return the Results of interest to you.

6. Right click the DA Result object and select Solve. The results of the post processing script are displayed in
the Results section of the Details panel, and the resulting contour is shown in the Graphics window if ap-
plicable for that result type.

Release 2020 R1 - © ANSYS, Inc.


1547
Using Design Assessment

The Design Assessment XML Definition File


The Design Assessment system is driven in part by an XML definition file (referred to as the XML
definition file). This file can be user defined or provided by ANSYS or a third party. This section defines
the format of the XML definition file. The XML definition file is split into four parts to define the following:

• Available Attributes (p. 1549)

• Attribute Groups (p. 1552)

• Scripts (p. 1553)

• Result Availability (p. 1555)

For each Design Assessment system, a copy will be made of the selected XML definition file and associ-
ated with that Design Assessment system to define the visibility of the tree objects. The entries in the
tree objects will be saved with the Mechanical project database file; this includes the actual script used
for the assessment. The overview of the file format is shown below.
<?xml version="1.0"?>
<Attributes>
definition of attributes for re-use throughout the attribute groups.

Release 2020 R1 - © ANSYS, Inc.


1548
The Design Assessment XML Definition File

</Attributes>
<AttributeGroups>
grouping of attributes; used to define the available options in the attribute groups objects
</AttributeGroups>
<DAScripts>
analysis script language & contents; used to define a script covering how the design assessment
will be performed and a script used to obtain results
</DAScripts>
<DAResults>
definition of the available results and the available options in the results object.
</DAResults>

Note

For all sections of the XML definition file, all values entered as part of a list in a tag must be
separated by commas only (no spaces); for example in the following tag, <Validation Prop-
Type="vector&lt;string>">0.5,10</Validation>, there should not be any space between the
values 0.5 and 10.

Attributes Format
Within the Attributes section there are a number of options to define the name and type of attribute
(for example, whether it’s a double, integer, drop-down list, text, etc.), and what it applies to (for example,
can it be applied to selectable geometry or loadcases, and if geometry, is it vertex, lines, surfaces or
solids). Depending upon the type, default values and validation ranges can be set. Attributes of int and
double types can be parameterized.
<Attributes ObjId="2" Type="CAERepBase" Ver="2"></Attributes>
<DAAttribute ObjId="100" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">attr name</name>
<AttributeType PropType="string">type keyword</type>
<Application PropType="string">selection keyword</application>
<Validation PropType="string">validation data</validation>
<Default PropType="string">default value</default>
<DisplayUnits PropType="string">display units keyword</DisplayUnits>
</DAAttribute>
</Attribute>

The attribute is defined in the Details panel with 4 rows:

If Scoping Method is set to Named Selection, the fourth row will contain a drop-down of all defined
named selections that contain geometric entities of the type specified in the attribute definition.

The Attributes tag properties should be set as follows:

Property Value Meaning


ObjId enter an Number identifying this attribute collection
integer
Type CAERepBase Specifies that the file is in ANSYS intermediate file format

Release 2020 R1 - © ANSYS, Inc.


1549
Using Design Assessment

Property Value Meaning


Ver enter an Version of the Attributes object definition; this should be set to
integer 2

The DAAttribute tag properties should be set as follows:

Property Value Meaning


ObjId enter an Unique number identifying this DAAttribute, suggest starting at a fixed number
integer (e.g. 100) to avoid conflict with other objects
Type DAAttribute Signifies that the contents of the DAAttribute tag define an attribute
Ver enter an Version of the DAAtribute object definition; this should be set to 2
integer

The following tags can be included as children of a DAAttribute tag (note that each tag must have a
property PropType=”string” or PropType=”vector&lt;string>” (the latter if entering more than a single
value in the tag contents).

Property Value Meaning


AttributeName enter a string Displayed name of the attribute
AttributeType, with following Int Integer entry only
values of type keyword Double Double precision entry only
allowed:
Text Text entry only
DropDown Drop down list selection
Browse Text based, but includes browse
to a file button
None Only Geometry Selection
required, hides Value Cell
Application, with following values Vertices Enables Geometric selection of
of selection keyword vertices only
allowed: Lines Enables Geometric selection of
line bodies only
Surfaces Enables Geometric selection of
surface bodies only
Solids Enables Geometric selection of
solid bodies only
Geometry Enables Geometric selection of
lines, surfaces and solids
All Hides Geometry Selection cell,
applies to the whole analysis
Validation, with following values Two comma separated numbers For Int or Double type keywords
of validation data allowed: defining a min and max
Multiple comma separated strings For DropDown type keywords
defining the available entries
A single number to define the For the Text or Browse type
maximum length of the string keywords

Release 2020 R1 - © ANSYS, Inc.


1550
The Design Assessment XML Definition File

Property Value Meaning


Default, with following values of Default value in SI units; if default For Int or Double type keywords
default value allowed: is within the valid range, when
it’s created the object state will
be checked, otherwise “?”
String; used to set the default For DropDown type keywords
entry in the drop-down
Default text string For the Text or Browse type
keywords
DisplayUnits, with following No Units No units are associated with the
values of display units value (default if field is not
keywords allowed: defined)
Stress Values are treated as stress
(Only used if version number
of DAAttribute > 2 and Distance Values are treated as distance
AttributeType is Double) Strain Values are treated as strain
Force Values are treated as force
When a display unit is
defined the value will Moment Values are treated as moment,
automatically scale i.e. force x distance
depending on the defined Rotation Values are treated as rotation
unit system for the Analysis
Angular Acceleration Values are treated as angular
and for the unit system used
acceleration, i.e. rotation / time2
to view
Angular Velocity Values are treated as angular
velocity, i.e. rotation / time
Velocity Values are treated as velocity, i.e.
distance / time
Acceleration Values are treated as acceleration,
i.e. distance / time2
Temperature Values are treated as temperature
Pressure Values are treated as pressure, i.e.
force / distance2
Voltage Values are treated as voltage
Energy Values are treated as energy
Volume Values are treated as volume, i.e.
distance3
Area Values are treated as area, i.e.
distance2
Current Values are treated as current
Heat Rate Values are treated as heat rate
Current Density Values are treated as current
density
Power Values are treated as power
Heat Generation Values are treated as heat
generation

Release 2020 R1 - © ANSYS, Inc.


1551
Using Design Assessment

Property Value Meaning


Magnetic Flux Values are treated as magnetic
flux

Attribute Groups Format


The AttributeGroups tag contains DAAttributeGroup tags that provide a means for the user to select
the groups of attributes shown in the Details panel when an Attributes Group tree object is selected.
A maximum of 10 attributes can be grouped per attribute group object. Attribute group objects auto-
matically sort themselves by drop-downs of available types and subtypes.
<AttributeGroups ObjId="3" Type="CAERepBase" Ver="2">
<DAAttributeGroup ObjId ="100001" Type="DAAttributeGroup" Ver="2">
<GroupType PropType="string">Group Type</GroupType>
<GroupSubtype PropType="string">Group Subtype</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">list of attribute numbers</AttributeIDs>
</DAAttributeGroup>
</AttributeGroups>

The group is defined in the Details panel with 3 standard rows and then up to 10 attributes:

The AttributeGroups tag properties should be set as follows:

Property Value Meaning


ObjId enter an Number identifying this attribute group collection
integer
Type CAERepBase Specifies that the file is in ANSYS intermediate file format
Ver enter an Version of the AttributeGroups object definition; this should be set to
integer 2

The DAAttributeGroup tag properties should be set as follows:

Property Value Meaning


ObjId enter an integer Unique number identifying this DAAttributeGroup, suggest starting at fixed
number (e.g. 500) to avoid conflict with other objects
Type DAAttributeGroup Signifies that the contents of the DAAttributeGroup tag define an attribute
group
Ver enter an integer Version of the DAAttributeGroup object definition; this should be set to 2

Release 2020 R1 - © ANSYS, Inc.


1552
The Design Assessment XML Definition File

The following tags can be included as children of a DAAttributeGroup tag:

Property Value Meaning


GroupType enter a string Type of this attribute group
GroupSubtype enter a string Subtype of this attribute group
AttributeIDs enter a comma separated list of Attributes that will be displayed
attribute ID numbers for this attribute group

The PropType property of the GroupType and GroupSubtype tags must be set to string, and the
PropType property of the AttributeIDs tags must be set to vector&lt;unsigned int>.

Script Format
This section defines the location for the Design Assessment post processing scripts and also defines
what values can be accessed in this Design Assessment system. The scripts are to be written using the
Python scripting language.

There are three Design Assessment specific system environment variables that can be used when spe-
cifying script paths:

DAPROGFILES
Default: C:\Program Files

DANSYSDIR
Default: C:\Program Files\ANSYS Inc\v182

DAUSERFILES
The Workbench project user_files subfolder

The Solve tag defines the location of the script that will be run upon pressing the solve button within
the Mechanical application. The Evaluate tag defines the location of the script that will be run when
evaluating the DAResult objects. The Evaluate script will be run by default after the solve script when
solve has been selected. This separation enables the ability for any intensive processing to be performed
and saved to files during the solve stage and then results extraction and presentation to be scripted
during the evaluation stage. Alternatively, you may want all the processing performed during the
evaluate script and enter None in the Solve Script section.

Additional tags allow you to:

• permit or prevent the inclusion of Design Assessment Attribute Groups and Results in the tree for the
associated Design Assessment system

• permit or prevent the availability of solution combination results in the associated Design Assessment
system

• add additional columns to the Solution Selection Worksheet

• define which upstream solution types are permitted in the Solution Selection Worksheet
<DAScripts ObjId="4" Type="DAScripts" Ver="2"/>
<!--analysis script language & contents; used to define a script covering
how the design assessment will be performed and a script used to obtain results-->
<Solve PropType="string">"c:\mysolve.py"</Solve>
<Evaluate PropType="string">"c:\myevaluate.py"</Evaluate>
<DAData PropType="int">1</DAData>

Release 2020 R1 - © ANSYS, Inc.


1553
Using Design Assessment

<CombResults PropType="int">1</CombResults>
<CombExtra PropType="vector&lt;string>">Extra 1,Extra 2,Extra 3</CombExtra>
<CombTypes PropType="vector&lt;unsigned int>">1,2,3,4,5,6,7</CombTypes>
lt;/DAScripts>

The DAScripts tag properties should be set as follows:

Property Value Meaning


ObjId enter an Number identifying this script set
integer
Type DAScripts Signifies that the contents of the DAScripts tag define solve and evaluate
postprocessing scripts
Ver enter an Version of the DAScripts tag; this should be set to 2
integer

The following tags can be included as children of a DAScripts tag:

Property Value Meaning


Solve enter a string Path to the file called during
the solution; a relative path
can be entered. A relative
path will be relative to
{install}\aisol\bin\{platform},
so for example,
..\..\..\My_Solve.py would
need to be located in the
same folder as the
installation.

Standard environment
variables or one of the
Design Assessment specific
environment variables may
be used in the path
(enclosed in percent signs).
For example:

%TEMP%\My_solve.py

%DAPROGFILES%\My_solve.py

If no solve script is required,


the keyword None can be
entered.
Evaluate enter a string Path to the file called during the
evaluate. As per the Solve string,
this can be relative or use
standard environment variables
or the Design Assessment specific
environment variables.
DAData enter either 1 or 0 Set to 0 to prevent any DA Data
(Attribute Groups or DA Results)

Release 2020 R1 - © ANSYS, Inc.


1554
The Design Assessment XML Definition File

Property Value Meaning


from being added to the project,
or 1 to allow them
CombResults enter either 1 or 0 Set to 0 to prevent Mechanical
Results objects from being added
to the Design Assessment
Solution, or 1 to allow them
CombExtra enter a comma separated list of Enter a string for each extra
strings column heading that you want
to appear in the Solution
Selection Worksheet.
CombTypes enter a comma separated list Each of the numbers
of positive numbers represents a system type.
between 1 and 7 Only system types in this list
will be permitted to be
selected in the Solution
Selections table. The
numbers correspond to the
systems as follows:

1: Static Structural

2: Transient Structural

3: Explicit Dynamics

4: Modal

5: Harmonic Response

6: Random Vibration

7: Response Spectrum

If CombTypes is not defined,


there will be no restrictions
applied.

The PropType property of the Solve and Evaluate tags must be set to string, The PropType property
of the DAData and CombResults tags must be set to int, and the PropType property of the CombExtra
tag must be set to vector&lt;string> and the PropType property of the CombTypes tag must be
set to vector&lt;unsigned int>.

Results Format
The DA Results format defines the available DA Results tree objects. A maximum of 10 attributes can
be included per DA Result object; for example to define direction components. For attributes applied
to results objects, the application entry is ignored. DA Result objects automatically sort themselves by
drop-downs of available types and subtypes. Each DA Result object also contains information on how
it should display results; this can either be set in this XML definition file or programmatically in the python
solve or evaluate scripts.

Release 2020 R1 - © ANSYS, Inc.


1555
Using Design Assessment

Minimum and maximum values are also reported and can be parametrized. Probe labels can be added
to the graphic to identify specific results, or the minimum and maximum locations.
<Results ObjId="3" Type="CAERepBase" Ver="2">
<DAResult ObjId ="100001" Type="DAResult" Ver="2">
<GroupType PropType="string">Group Type</GroupType>
<GroupSubtype PropType="string">Group Subtype</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">list of attribute numbers</AttributeIDs>
<DisplayType PropType="string">display type keyword</DisplayType>
<DisplayStyle PropType="string">display style keyword</DisplayStyle>
<DisplayUnits PropType="string">display units keyword</DisplayUnits>
</DAResult>
</Results>

The result is defined in the Details panel with standard rows and then up to 10 attributes:

Note that if the Display Style of a result is anything other than scalar, a "Components" field is shown in
the Definitions section.

The Results tag properties should be set as follows:

Property Value Meaning


ObjId enter an Number identifying this attribute group collection
integer
Type CAERepBase Specifies that the file is in ANSYS intermediate file format
Ver enter an Version of the Results definition section; this should be set to
integer 2

The DAResult tag properties should be set as follows:

Property Value Meaning


ObjId enter an Unique number identifying this DA Result; suggest starting at a fixed number
integer (e.g. 1000) to avoid conflict with other objects

Release 2020 R1 - © ANSYS, Inc.


1556
The Design Assessment XML Definition File

Property Value Meaning


Type DAResult Signifies that the contents of the DAResult tag defines a result group
Ver enter an Version of the DA Result object definition; this should be set to 3
integer

The following tags can be included as children of a DAResult tag:

Property Value Meaning


GroupType enter a string Type of this DA Result object
GroupSubtype enter a string Subtype of this DA Result object
AttributeIDs enter a comma separated list of Attributes that will be displayed
attribute ID numbers for this DA Result object
DisplayType, with following Element Values per element are expected
values of display type Nodal Values per node are expected.
keywords allowed:
ElementNodal Values per node of each element
are expected
DisplayStyle, with following Scalar A single number is expected for
values of display style each element / node depending
keywords allowed: upon the DisplayType set (default
if field is not defined)
(Only used if version number
Vector X, Y and Z component
of DAResult > 2)
values are expected for each
element / node depending
upon the DisplayType

An additional drop-down will


be provided to choose
between X, Y, Z, Resultant
and Vector Display

The Resultant, R, is
determined by

Tensor X, Y, Z, XY, YZ and XZ


component values are
expected for each element /
node depending upon the
DisplayType

An additional drop-down will


be provided to choose
between X, Y, Z, XY, YZ and
XZ, Maximum
Principal (p. 1231), Middle
Principal (p. 1231), Minimum
Principal (p. 1231),
Intensity (p. 1231),
Equivalent (p. 1230), Vector

Release 2020 R1 - © ANSYS, Inc.


1557
Using Design Assessment

Property Value Meaning


Principal (p. 1232), and
Maximum Shear (p. 1231)
StrainTensor As Tensor, but without the
Maximum Shear option
DisplayUnits, with following No Units No units are associated with the
values of display units result (default if field is not
keywords allowed: defined)
Stress Results are treated as stress
(Only used if version number
of DAResult > 2) Distance Results are treated as distance
Strain Results are treated as strain
When a display unit is
Force Results are treated as force
defined the result will
automatically scale Moment Results are treated as moment,
depending on the given unit i.e. force x distance
system Rotation Results are treated as rotation
Angular Acceleration Results are treated as angular
acceleration, i.e. rotation / time2
Angular Velocity Results are treated as angular
velocity, i.e. rotation / time
Velocity Results are treated as velocity, i.e.
distance / time
Acceleration Results are treated as
acceleration, i.e. distance / time2
Temperature Results are treated as
temperature
Pressure Results are treated as pressure,
i.e. force / distance2
Voltage Results are treated as voltage
Energy Results are treated as energy
Volume Results are treated as volume, i.e.
distance3
Area Results are treated as area, i.e.
distance2
Current Results are treated as current
Heat Rate Results are treated as heat rate
Current Density Results are treated as current
density
Power Results are treated as power
Heat Generation Results are treated as heat
generation
Magnetic Flux Results are treated as magnetic
flux

The DisplayType, DisplayStyle and Display unit can all be over-ridden or set within the python script if
desired. However, DisplayStyle needs to be set here to enable the addition of the drop-down to choose

Release 2020 R1 - © ANSYS, Inc.


1558
Design Assessment API Reference

the component and automatic calculation of additional results (e.g. Resultant, Maximum Principal, etc.)
in the cases of vector or tensor display. See the DAResult class (p. 1589) in the API for details on how to
set these programmatically.

The PropType property of the GroupType, GroupSubtype, and DisplayType tags must be set to string,
and the PropType property of the AttributeIDs tags must be set to vector&lt;unsigned int>.

Design Assessment API Reference


These guidelines describe the Design Assessment API. Included with the standard ANSYS Workbench
installation is the IronPython scripting environment that allows a Python script to be run. Within Design
Assessment scripts can be run upon Solve and Evaluate. These Python based scripts have a DesignAs-
sessment object defined as an entry point to access to the API functions to enable data to be processed
either directly in python, or externally by calling 3rd party programs.

The following API classes are available:


DesignAssessment class
Helper class
MeshData class
DAElement class
DANode class
SectionData class
AttributeGroup class
Attribute class
SolutionSelection class
Solution class
SolutionResult class
DAResult class
DAResultSet class

The API is structured as shown in this diagram:

Release 2020 R1 - © ANSYS, Inc.


1559
Using Design Assessment

Every effort is made to ensure compatibility of the API across versions. However, there are occasions
where functions or properties need to be modified. In these scenarios, the existing function will be
deprecated, i.e. it will become undocumented.

Any data output via the print command will be added to the appropriate script output file which can
be reviewed via the Solution Information object. If a deprecated function is called a message will be
added to the appropriate script output file with a suggested alternative methodology. These can be
viewed via the Solution Information object. This inclusion of the message in the file can be controlled
by the OutputDeprecatedWarnings function in the DesignAssessment (p. 1566) class. Additional text
output from your script can be included in a file that is displayed using the Solver Output (p. 1395) option
(see Helper (p. 1568) class, ReplaceSolverOutputFile).

Undocumented functions (including those recently deprecated) may be removed or altered in subsequent
releases if it becomes impractical to maintain a backwards compatible interface, so effort should be
made to update any calls to deprecated functions.

Functions may not work on previous releases; therefore, all users should use the same release of
Workbench to ensure compatibility.

API Change Log for R14.5


No functions were deprecated or modified with this release. Newly added functions are not detailed
here, but were mainly contained within the Solution (p. 1579) class.

API Change Log for R14.0


Release 14 represents the first release after the initial version. In response to feedback, we have made
a number of changes of functions to properties where appropriate, hence there are an unusually high
number of deprecated functions. These changes are tabulated below, grouped by class name. The tables
do not include newly added functions.

Design Assessment Class:

Method/Property Description of Change


getHelper() Changed to property Helper, old code: DesignAssessment.getHelper(), new
code DesignAssessment.Helper
GeometryMeshData() Changed to property MeshData, old code:
DesignAssessment.GeometryMeshData(), new code
DesignAssessment.MeshData
Selections() Changed name to SolutionSelections() to be consistent with the Mechanical
application
Selection(int Duplication of python functionality. Old code
Index) DesignAssessment.SolutionSelection(0), new code MyArray =
DesignAssessment.SolutionSelections() then MyArray[0] (NB, using the shortcut
DesignAssessment.SolutionSelections()[index] in a loop is less efficient than
assigning it to an array within python)
ResultGroups() Changed name to DAResults() to be consistent with the Mechanical application
ResultGroup(int Duplication of python functionality. Old code DesignAssessment.DAResult(0),
Index) new code MyArray = DesignAssessment.DAResults() then MyArray[0] (NB,
using the shortcut DesignAssessment.DAResults()[index] in a loop is less
efficient than assigning it to an array within python)

Release 2020 R1 - © ANSYS, Inc.


1560
Design Assessment API Reference

Method/Property Description of Change


NoOfAttributeGroups() Changed to property AttributeGroupCount, old code:
DesignAssessment.NoOfAttributeGroups(), new code
DesignAssessment.AttributeGroupCount
NoOfSelections() Changed to property SolutionSelectionCount, old code:
DesignAssessment.NoOfSelections(), new code
DesignAssessment.SolutionSelectionCount
NoOfResultGroups() Changed to property DAResultCount, old code: DesignAssessment.
NoOfResultGroups(), new code DesignAssessment.DAResultCount
ProjectName() Changed to property ProjectTitle, old code: DesignAssessment. ProjectName(),
new code DesignAssessment.ProjectTitle
AttributeGroup(int Duplication of python functionality. Old code
Index) DesignAssessment.AttributeGroup(0), new code MyArray =
DesignAssessment.AttributeGroups() then MyArray[0] (NB, using the shortcut
DesignAssessment.AttributeGroups()[index] in a loop is less efficient than
assigning it to an array within python)

Helper Class:

A number of functions related to an internal file, the CAERep, were previously documented in error.
These have been removed from the documentation; it is not recommended that these are used as the
file structure is subject to change.

Function/Property Description of Change


getUnits() Replaced by property Units in the DesignAssessment class, for the units set
for the Design Assessment System and also the property Units in the Solution
class for the units system used in upstream solution.
getSolverOut() Changed to property SolverOutputFilePath, old code: Helper.getSolverOut(),
new code Helper.SolverOutputFilePath
getOutputFile() Changed to property SystemDirectory, old code: Helper.getOutputFile(), new
code Helper.SystemDirectory
getGeometryPath Changed to property GeometryPath, old code: Helper. getGeometryPath (),
() new code Helper.GeometryPath
getResultPath Changed to property ResultPath, old code: Helper.getResultPath(), new code
() Helper.ResultPath
getSystemDirectory Changed to property SystemDirectory, old code: Helper.getSystemDirectory(),
() new code Helper.SystemDirectory
getLogFile() Removed as the log file can be displayed via Solution Information and its
contents can be added to via the standard python print function
WriteToLog () Removed as the log file contents can be added to via the standard python
print function

MeshData Class (previously named GeometryMeshData):

A number of functions related to an internal reference, the TopologyID, were previously documented
in error. These have been removed from the documentation.

Release 2020 R1 - © ANSYS, Inc.


1561
Using Design Assessment

Method/Property Description of Change


NoOfNodes() Changed to property NodeCount, old code: MeshData. NoOfNodes(), new
code MeshData.NodeCount
NoOfElements() Changed to property ElementCount, old code: MeshData.NoOfElements(),
new code MeshData.ElementCount
ElementbyID(int Corrected capitalization, old code: MeshData.ElementbyID(Id), new code
ID) MeshData.ElementById(Id)
NodebyID(int ID) Corrected capitalization, old code: MeshData.NodebyID(Id), new code
MeshData.NodeById(Id)
getConnectedElementIDs Removed as incorrectly located and duplicated functionality; the method
(int ID) should be the responsibility of the Node object, old code:
MeshData.getConnectedElementIDs(Id), new code
MeshData.NodeById(Id).ConnectedElementIds()
getConnectedElements Removed as incorrectly located and duplicated functionality; the method
(int ID) should be the responsibility of the Node object, old code:
MeshData.getConnectedElementIDs(ID), new code
MeshData.NodeById(Id).ConnectedElements()
getElementsByID(int[] Consistency issue, old code: MeshData.getElementsByID (ID[]), new code
ID) MeshData.ElementsByIds(ID[])
Element(int Index) Duplication of python functionality. Old code MeshData.Element(0), new
code MyArray = MeshData.Elements() then MyArray[0] (NB, using the
shortcut MeshData.Elements()[index] in a loop is less efficient than assigning
it to an array within python)
Node(int Index) Duplication of python functionality. Old code MeshData.Node(0), new code
MyArray = MeshData.Nodes() then MyArray[0] (NB, using the shortcut
MeshData.Nodes()[index] in a loop is less efficient than assigning it to an
array within python)

DAElement Class:

The function TopologyID() related to an internal reference was previously documented in error. This
has been removed from the documentation.

Method/Property Description of Change


Type() Replaced with property Description, this provides a text description of the
element, rather than an internal number which was subject to change, old
code: DAElement.Type(), new code DAElement.Description
SectionData() Changed to property CrossSectionData, old code: DAElement.SectionData(),
new code DAElement.CrossSectionData
getNodeIDs() Consistency issue, old code: DAElement.getNodeIDs(), new code
DAElement.NodeIds()
ID() Changed to property Id, old code: DAElement.ID(), new code DAElement.Id
NoOfConnectedNodes() Changed to property NodeCount, old code:
DAElement.NoOfConnectedNodes(), new code DAElement.NodeCount

DANode Class:

Release 2020 R1 - © ANSYS, Inc.


1562
Design Assessment API Reference

Method/Property Description of Change


ID() Changed to property Id, old code: DANode.ID(), new code DANode.Id
x() Changed to property X, old code: DANode.x(), new code DANode.X
y() Changed to property Y, old code: DANode.y(), new code DANode.Y
z() Changed to property Z, old code: DANode.z(), new code DANode.Z
NoOfConnectedElements() Changed to property ConnectedElementCount, old code:
DANode.NoOfConnectedElements(), new code
DANode.ConnectedElementCount
ConnectedElementIDs() Corrected capitalization, old code: DANode.ConnectedElementIDs(Id), new
code DANode.ConnectedElementIds(Id)

SectionData Class:

Method/Property Description of Change


Type() Replaced with property Description, this provides a text description of the element,
rather than an internal number which was subject to change, old code:
SectionData.Type(), new code SectionData.Description
Diameter() Changed to property TubeDiameter, old code: SectionData.Diameter(), new code
SectionData.TubeDiameter
Thickness() Changed to property TubeThickness, old code: SectionData.Thickness(), new code
SectionData.TubeThickness
WebThickness() Changed to property BeamWebThickness, old code: SectionData.WebThickness(),
new code SectionData.BeamWebThickness
FlangeThickness() Changed to property BeamFlangeThickness, old code:
SectionData.FlangeThickness(), new code SectionData.BeamFlangeThickness
FilletRadii() Changed to property BeamFilletRadii, old code: SectionData.FilletRadii(), new code
SectionData.BeamFilletRadii
Height() Changed to property BeamHeight, old code: SectionData.Height(), new code
SectionData.BeamHeight
Width() Changed to property BeamWidth, old code: SectionData.Width(), new code
SectionData.BeamWidth

AttributeGroup Class:

Method/Property Description of Change


NoOfAttributes() Changed to property AttributeCount, old code: AttributeGroup.NoOfAttributes(),
new code AttributeGroup.AttributeCount
Name() Changed to property TreeName, old code: AttributeGroup.Name(), new code
AttributeGroup.TreeName
Type() Changed to property XmlType, old code: AttributeGroup.Type(), new code
AttributeGroup.XmlType
SubType() Changed to property XmlSubType, old code: AttributeGroup.SubType(), new code
AttributeGroup.XmlSubType

Attribute Class:

Release 2020 R1 - © ANSYS, Inc.


1563
Using Design Assessment

Method/Property Description of Change


Name() Changed to property AttributeName, old code: Attribute.Name(), new
code Attribute.AttributeName
Value() Replaced with the properties ValueAsInt, ValueAsDouble, ValueAsString
in order to simplify the interface, old code: ValueObj = Attribute.Value()
then ValueObj.GetAsInt(), new code: Attribute.ValueAsInt
getNoOfSelectedElements() Changed to property SelectedElementCount, old code:
Attribute.getNoOfSelectedElements(), new code
Attribute.SelectedElementCount
getSelectedElements() Consistency issue, old code: Attribute.getSelectedElements(), new code
Attribute.SelectedElements()
getNoOfSelectedNodes() Changed to property SelectedNodeCount, old code:
Attribute.getNoOfSelectedNodes(), new code
Attribute.SelectedNodeCount
getSelectedNodes() Consistency issue, old code: Attribute.getSelectedNodes(), new code
Attribute.SelectedNodes()

SolutionSelection Class (previously named Selection):

Method/Property Description of Change


NoOfSolutions() Changed to property SolutionCount, old code: Selection.NoOfSolutions(), new
code SolutionSelection.SolutionCount
Solution(int Replaced with method SolutionByRow(int Row), Row is 1 based. Old code:
index) Selection.Solution(0), new code SolutionSelection.SolutionByRow(1)

Solution Class:

Method/Property Description of Change


NoOfAdditionalSolutionData() Changed to property AdditionalSolutionDataCount, old code:
Solution.NoOfAdditionalSolutionData(), new code
Solution.AdditionalSolutionDataCount
EnvironmentName() Changed to property Id, old code: Solution.EnvironmentName(), new
code Solution.Id
getResult() This method and the object it returned have been removed and the
objects functions replaced with properties within the Solution Class.
Old code: Solution.getResult().ResultFilePath(), new code:
Solution.ResultFilePath
AdditionalSolutionData(int Replaced with method AdditionalSolutionDataByColumn (int Col), Col
Index) is 1 based. Old code: Solution. AdditionalSolutionData(0), new code
Solution.AdditionalSolutionDataByColumn(1)

SolutionResult Class:

Method/Property Description of Change


ResultFilePath() Function moved to SolutionClass. Old code: Solution.getResult().ResultFilePath(),
new code: Solution.ResultFilePath

DAResult Class (previously named ResultGroup):

Release 2020 R1 - © ANSYS, Inc.


1564
Design Assessment API Reference

Method/Property Description of Change


Name() Changed to property TreeName, old code: ResultGroup.Name(), new code
DAResult.TreeName
Type() Changed to property XmlType, old code: ResultGroup.Type(), new code
DAResult.XmlType
AddStepResult() Renamed to AddDAResultSet, old code: ResultGroup.AddStepResult(), new
code DAResult.AddDAResultSet()
AddStepResult(Result Function has been removed, use AddDAResultSet to create the DAResultSet
myResult) object then define values within that object.
StepResult() Renamed to DAResultSets(), old code: ResultGroup.StepResult(), new code
DAResult.DAResultSets()
StepResult(int Renamed to DAResultSet(), old code: ResultGroup.StepResult(index), new code
index) DAResult.DAResultSet(SetNumber). Note: SetNumber is 1 based.
NoOfAttributes() Changed to property AttributeCount, old code: ResultGroup.NoOfAttributes(),
new code DAResult. AttributeCount

DAResultSet Class (previously named Result):

Method/Property Description of Change


AddElementResultValue(ValueStructureClass Modified so that it’s easier to create sets of result values.
newElementResultValue) Now element result values can be directly defined using
SetElementalValue. Old code
Result.AddElementValue(ValueStructure), new code:
DAResultSet.SetElementalValue(ElementID, Component,
Value)
ValueStructureClass The ValueStructure class has been deprecated as the
AddElementResultValue() result values can be accessed directly. Values are also
now added with a given ElementID, so numerous entries
need not be made. Old code ValueStructure =
Result.AddElementValue() then
ValueStructure.setValue(Value), new code:
DAResultSet.SetElementalValue(ElementID, Component,
Value)
ValueStructureClass[] The ValueStructure class has been deprecated as the
ElementResultValues() result values can be accessed directly for the given
element. It is no longer possible to get all the values
out as an Array, but values can be obtained via
GetElementalValue(ElementID, Component) instead.
ValueStructureClass The ValueStructure class has been deprecated as the
ElementResultValue(int index) result values can be accessed directly for the given
element. Values are also now added with a given
ElementID. Old code ValueStructure = Result.
ElementResultValue(Index) then Value =
ValueStructure.GetAsDouble(), new code: Value =
DAResultSet.GetElementalValue(ElementID, Component)

ValueStructure Class:

Release 2020 R1 - © ANSYS, Inc.


1565
Using Design Assessment

This class has been deprecated; all functionality is now redundant as the values can either be obtained
or set directly.

DesignAssessment class
This class is the parent class of all Design Assessment API objects that can be called from the python
scripts. It is a global variable that can be accessed from anywhere in your script.

Table 95: Members

Name Type Description


Helper Helper (p. 1568) class See Helper class description for available
properties and methods
Units string Returns the solver units defined by
the user in the analysis settings,
represented as a string:

MKS: i.e. Metric (m, Kg, N, s, V, A)

UMKS: i.e. Metric (µm, Kg, µN, s, mV,


mA)

CGS: i.e. Metric (cm, g, dyne, s, V, A)

NMM: i.e. Metric (mm, Kg, N, s, mV,


mA)

LBFT: i.e. US Customary (ft, lbm, lbf, s,


V, A)

LBIN: i.e. US Customary (in, lbm, lbf, s,


V, A)
MeshData MeshData (p. 1570) class See MeshData class description for
available properties and methods
AttributeGroups() AttributeGroup[] (p. 1576) Array of AttributeGroup objects
class
AttributeGroups(string AttributeGroup[] (p. 1576) Array of AttributeGroup objects with the
TreeName) class given TreeName filtered from the available
AttributeGroups
AttributeGroups(string Type, AttributeGroup[] (p. 1576) Array of AttributeGroup objects with the
string SubType) class given Type and SubType filtered from the
available AttributeGroups
SolutionSelections() SolutionSelection[] (p. 1578) Array of SolutionSelection class objects
class
DAResults() DAResult[] (p. 1589) class Array of DAResult objects
DAResults(string TreeName) DAResult[] (p. 1589) class Array of DAResult objects with the given
TreeName filtered from the available
DAResults

Release 2020 R1 - © ANSYS, Inc.


1566
Design Assessment API Reference

Name Type Description


DAResults(string Type, string DAResult[] (p. 1589) class Array of DAResult objects with the given
SubType) Type and SubType filtered from the
available DAResults
AttributeGroupCount int A count of the number of AttributeGroup
objects
SolutionSelectionCount int A count of the number of SolutionSelection
objects
DAResultCount int A count of the number of DAResult objects
ProjectTitle string The title of the project
OutputDeprecatedWarnings(bool void Sets the verbosity of the warnings
ShowWarnings) related to deprecated
properties/methods:

False – for no output

True – for full output for each call

Warnings are presented as text output


to the solve or evaluate debug logs.

By default only a summary is shown;


the user can then decide to add this
function to their script to display them
all, or display none.

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_DesignAssessment():
DA = DesignAssessment #just to save typing.
#To know full details of deprecated functions.
DA.OutputDeprecatedWarnings(True)

#Get the helper object


HelperObject = DA.Helper
#Output units string, e.g. MKS
print DA.Units
# Get the MeshData object
MeshDataObject = DA.MeshData
print DA.ProjectTitle

#Attribute Groups:
#Obtain an array of all attribute group objects.
AllAttributeGroupsObjects = DA.AttributeGroups()
#Filter for an array of attribute group objects called Bob
NameFilterAttributeGroupsObject = DA.AttributeGroups("Bob")
#Filter for an array of attribute groups with type Sam, subtype Phil
TypeFilterAttributeGroupsObject = DA.AttributeGroups("Sam", "Phil")
#Returns the total number of attribute groups
print str(DA.AttributeGroupCount)

#Solution Selection:
#Obtain all solution selection objects
AllSolutionSelections = DA.SolutionSelections()

#DA Results:
#Obtain an array of all DA Result objects.

Release 2020 R1 - © ANSYS, Inc.


1567
Using Design Assessment

AllDAResultsObjects = DA.DAResults()
#Filter for an array of DA Result objects called John
NameFilterDAResultsObject = DA.DAResults("John")
#Filter for an array of DA Result with with type Paul, subtype Mike
TypeFilterDAResultsObject = DA.DAResults("Paul", "Mike")
#Returns the total number of DA Result objects
print str(DA.DAResultCount)

#Access first object in NameFilterAttributeGroupsObject array


if (NameFilterAttributeGroupsObject != None):
AGObjectA = NameFilterAttributeGroupsObject[0]

#Example Loop around Array AllAttributeGroupsObjects


for AGObject in AllAttributeGroupsObjects:
#Now AGObject is a representation of each Attribute Group.
print AGObject.TreeName
runClassDemo_DesignAssessment()

Typical Evaluate (or Solve) Script Output


The output will depend upon the number of Attribute Group and DA Result objects defined and used
in the model.
MKS
HelpFileExample--Design Assessment (B5)
1
1
Attribute Group

Helper class
This class provides some general functions to assist the user writing scripts.

Table 96: Members

Name Type Description


GeometryPath string Returns the directory where the Geometry file is saved.
ResultPath string Returns the directory where the Result files should be
written. During the solving process this can be an
intermediate directory, not the project system directory.
SystemDirectory string Returns the project system directory.
UserFilesDirectory string Returns the user_files directory for the current project.
RunMAPDL(string input, string output, void Runs an instance of the Mechanical APDL solver. You
string CommandLineParams) must provide file names which may include the full
path or may be in the application or current directory
for input and output. Specify any additional Mechanical
APDL command line parameters for
CommandLineParams, or a blank string if none are
required.
SetLastError(string errorString) void Sets the text message to show in the output messages
of the editor. This can be used to present a message
to the user of the script for a reason for failure,
ReplaceSolverOutputFile(string FileLoc) void Specifies a text file produced during output to replace
the default solve.out log file. The solve.out log
file will be shown in the Solution Information
Worksheet view if selected from the drop-down.

Release 2020 R1 - © ANSYS, Inc.


1568
Design Assessment API Reference

Name Type Description


SolverOutputFilePath string Gets the file name and path of the file that is displayed
when the Solution Output displays the Solver Output
data.
AppendToSolverOutputFile(string void Appends a line of text to the Solver Output display.
AdditionalText)
ClearSolverOutputFile() void Deletes contents of the Solver Output File.

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_Helper():
HelperObject = DesignAssessment.Helper #Get the helper object

#Obtain some Helper based properties and print them to the debug file.
print "GeometryPath = " + HelperObject.GeometryPath
print "ResultPath = " + HelperObject.ResultPath
print "SystemDirectory = " + HelperObject.SystemDirectory
print "SolverOutputFilePath = " + HelperObject.SolverOutputFilePath

#Use some Helper based design assessment methods


#Create a text file with write access in the result path location
NewSolverFilePathAndName = HelperObject.ResultPath+"\\MySolverFile.txt"
MySolverFile = open(NewSolverFilePathAndName, "w")
MySolverFile.write("This is a solver output file\n")
MySolverFile.write("The backslash n indicates the end of a line\n")
MySolverFile.close()

#Make the solver output file text to be that contained in the MySolverFile
HelperObject.ReplaceSolverOutputFile(NewSolverFilePathAndName)

#uncomment out the below line to clear the previously entered text
#HelperObject.ClearSolverOutputFile()

#Append some more text, note this automatically includes the new line code.
HelperObject.AppendToSolverOutputFile("My First Additional Line")
HelperObject.AppendToSolverOutputFile("My Second Additional Line")
runClassDemo_Helper()

Typical Evaluate (or Solve) Script Output


GeometryPath = D:\Data\Documents\HelpFileExample_files\dp0\SYS\DM\SYS.agdb
ResultPath = D:\Data\Documents\HelpFileExample_files\dp0\SYS-1\MECH\
SystemDirectory = D:\Data\Documents\HelpFileExample_files\dp0\SYS-1\MECH\
SolverOutputFilePath = D:\Data\Documents\HelpFileExample_files\dp0\SYS-1\MECH\solve.out

Typical Solver Output


This is a solver output file
The backslash n indicates the end of a line
My First Additional Line
My Second Additional Line

Release 2020 R1 - © ANSYS, Inc.


1569
Using Design Assessment

MeshData class
This class provides access to the mesh created for the analysis, including all elements and nodes, which
can be filtered or obtained as required.

Table 97: Members

Name Type Description


NodeCount int Total of number of nodes in this mesh
ElementCount int Total of number of elements in this mesh
ElementById(int Id) DAElement (p. 1571) class Obtains the DAElement class object with the given Id.
Represents a single element in the Mesh.
Elements() DAElement[] (p. 1571) class Array of all DAElement class objects representing all
the elements in the mesh
NodeById(int Id) DANode (p. 1573) class Obtains the DANode class object with the given Id.
Represents a single node in the Mesh
Nodes() DANode[] (p. 1573) class Array of all DANode class objects representing all the
nodes in the mesh
NodesByIds (int[] Ids) DANode[] (p. 1573) class Array of DANode class objects that belong to any of
the array of element Ids specified in ids.
ElementsByIds(int[] DAElement[] (p. 1571) class Array of DAElement class objects that belong to any
Ids) of the array of element Ids specified in Ids.

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
#we need to use arrays for the ElementsByIds and NodesByIds methods
from System import Array

def runClassDemo_MeshData():
MeshDataObject = DesignAssessment.MeshData #Get the MeshData object

#Output some data to the debug log file.


print "Number of Nodes = " + str(MeshDataObject.NodeCount)
print "Number of Elements = " + str(MeshDataObject.ElementCount)

#Loop around all element objects.


for ElementIterator in MeshDataObject.Elements():
print "ElementId = " + str(ElementIterator.Id)

#Three ways of getting elements.


#It can not be assumed that Element Ids start at 1 and are contiguous
Elements = MeshDataObject.Elements()
FirstElementId = Elements[0].Id
ByIdMethodElement = MeshDataObject.ElementById(FirstElementId)
# print true if they are the same Id.
print str(FirstElementId == ByIdMethodElement.Id)
# Create an Array so we can iterface with the .NET code
ElementIdArray = Array[int]([FirstElementId,MeshDataObject.Elements()[1].Id])
print ElementIdArray
#Pass the array into the ElementsById method.
ByIdArrayMethodElement = MeshDataObject.ElementsByIds(ElementIdArray)
# print true if they are the same Id.
print str(FirstElementId == ByIdArrayMethodElement[0].Id)

#Three ways of getting nodes.


#It can not be assumed that Node Ids start at 1 and are contiguous
Nodes = MeshDataObject.Nodes()

Release 2020 R1 - © ANSYS, Inc.


1570
Design Assessment API Reference

FirstNodeId = Nodes[0].Id
ByIdMethodNode = MeshDataObject.NodeById(FirstNodeId)
# print true if they are the same Id.
print str(FirstNodeId == ByIdMethodNode.Id)
# Create an Array so we can iterface with the .NET code
NodeIdArray = Array[int]([FirstNodeId,MeshDataObject.Nodes()[1].Id])
print NodeIdArray
#Pass the array into the NodesById method.
ByIdArrayMethodNode = MeshDataObject.NodesByIds(NodeIdArray)
# print true if they are the same Id.
print str(FirstNodeId == ByIdArrayMethodNode[0].Id)
runClassDemo_MeshData()

Typical Evaluate (or Solve) Script Output


The output will depend upon the mesh used in the model.
Number of Nodes = 457
Number of Elements = 236
ElementId = 237
ElementId = 238
....
ElementId = 470
ElementId = 471
ElementId = 472
True
Array[int]((237, 238))
True
True
Array[int]((1, 3))
True

DAElement class
This class represents an element on the mesh for this model, providing access to the element, its con-
nectivity and, if it is a beam or tube, the associated section data.

Table 98: Members

Name Type Description


Description string A description of the
element:

Tetrahedral

Hexagonal

Wedge

Pyramid

Triangle

Triangle,Shell

Quadrilateral

Quadrilateral,Shell

Line

Point

Release 2020 R1 - © ANSYS, Inc.


1571
Using Design Assessment

Name Type Description


EMagLine

EMagArc

EMagCircle

Surface

Edge

Beam

Special
CrossSectionData SectionData (p. 1574) class Section data for this element,
describes beam cross sections for
beam types; Only elements that
have a Circular Hollow Section,
Rectangular Hollow Section or I
Section are supported, all other
elements will return NULL
NodeIds() int[] Array of integer values
representing Ids of the Element’s
Nodes
Nodes() DANode[] (p. 1573) class Array of DANode class objects for
each node of this Element
Id int Returns the unique Id number of
this Element
NodeCount int Returns the number of Nodes for
this Element
ElementThickness double The shell thickness of the
element. If the element is not a
shell, the value returned will be
zero. Where shell thickness can
be applied via geometry or by a
Shell Thickness object, that
defined by the Shell Thickness
will take precedence.
ElementThicknessAtNode(NodeId) double The shell thickness of the
element at position of Node with
NodeId. If the element is not a
shell, the value returned will be
zero. Where shell thickness can
be applied via geometry or by a
Shell Thickness object, that
defined by the Shell Thickness
will take precedence. If shell
thickness varies across the
element then it is determined by

Release 2020 R1 - © ANSYS, Inc.


1572
Design Assessment API Reference

Name Type Description


the average thickness of the
element nodes.

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_DAElement():
#Loop around all element objects.
for ElementIterator in DesignAssessment.MeshData.Elements():
#General info:
print "Element Description = " + ElementIterator.Description
print "Element Id = " + str(ElementIterator.Id)

# Information about the nodes of the element


print "Number of connected Nodes = " + str(ElementIterator.NodeCount)
NodeIdArray = ElementIterator.NodeIds()
print NodeIdArray
ConnectedNodeObjects = ElementIterator.Nodes()

#Cross Section Data is only available for beams.


#First test to see if it's a beam as they support it.
if 'Beam' in ElementIterator.Description:
XSectionDataObj = ElementIterator.CrossSectionData

#Element Thickness only applies to some elements, returns 0.0 if not supported.
print "Element Thickness = " + str(ElementIterator.ElementThickness)
ThicknessAtNode = ElementIterator.ElementThicknessAtNode(NodeIdArray[0])
print "Thickness at Node Id " + str(NodeIdArray[0]) + " = " + str(ThicknessAtNode)
runClassDemo_DAElement()

Typical Evaluate (or Solve) Script Output


The output will depend upon the elements used in the model; this output is for beams.
Element Description = Beam
Element Id = 237
Number of connected Nodes = 3
Array[int]((1, 3, 222))
Element Thickness = 0.0
Thickness at Node Id 1 = 0.0

DANode class
This class represents a node on the mesh for this analysis. It can be used to find the coordinates of the
node and the elements that it is connected to.

Table 99: Members

Name Type Description


Id int Returns the unique Id number of this Node
X double Returns the x coordinate of this Node in solver units
as set in Analysis settings
Y double Returns the y coordinate of this Node in solver units
as set in Analysis settings
Z double Returns the z coordinate of this Node in solver units
as set in Analysis settings

Release 2020 R1 - © ANSYS, Inc.


1573
Using Design Assessment

Name Type Description


ConnectedElementIds() int[] Array of integer values representing Ids of the
connected Elements
ConnectedElements() DAElement[] (p. 1571) Array of DAElement class objects that represent the
class elements that this Node is connected to
ConnectedElementCount int Returns the number of Elements this node is
connected to
IsOrientationNode bool Some beam nodes are created to orient the
local axis system for the section; if this node is
used for orientation this function will return
true

Note: results cannot be displayed on orientation


nodes

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_DANode():
#Loop around all nodes.
for NodeIterator in DesignAssessment.MeshData.Nodes():
#General info:
print "Node Id = " + str(NodeIterator.Id)
print "Node X = " + str(NodeIterator.X)
print "Node Y = " + str(NodeIterator.Y)
print "Node Z = " + str(NodeIterator.Z)
print "Node only used for beam orientation? " + str(NodeIterator.IsOrientationNode)
# Information about the elements that connect to this node
print "Number of connected Elements = " + str(NodeIterator.ConnectedElementCount)
ElementIdArray = NodeIterator.ConnectedElementIds()
print "Connected Element Ids = " + str(ElementIdArray)
ConnectedElementObjects = NodeIterator.ConnectedElements()
runClassDemo_DANode()

Typical Evaluate (or Solve) Script Output


The output will depend upon the nodes used in the model.
Node Id = 1
Node X = -2.0
Node Y = 4.4408920985e-16
Node Z = 5.0
Is the node only used for beam orientation? False
Number of connected Elements = 4
Connected Element Ids = Array[int]((408, 400, 245, 237))

SectionData class
This class provides Section Data properties for a beam based element in solver units as set in Analysis
settings. It can be accessed via DAElement (p. 1571).

Table 100: Members

Name Type Description


Description string Returns a description of the type of cross section:

CHS,Tube

Release 2020 R1 - © ANSYS, Inc.


1574
Design Assessment API Reference

Name Type Description


I,Beam

RHS,Beam
TubeDiameter double Returns the Diameter as double, only applicable to sections that are tubular
TubeThickness double Returns the Thickness as double, only applicable to sections that are tubular
BeamWebThickness double Returns the WebThickness as double, only applicable to sections that are
beam based
BeamFlangeThickness double Returns the FlangeThickness as double, only applicable to sections that
are beam based
BeamFilletRadii double Returns the FilletRadii as double, only applicable to sections that are beam
based
BeamHeight double Returns the Height as double, only applicable to sections that are beam
based
BeamWidth double Returns the Width as double, only applicable to sections that are beam
based

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_SectionData():
#Loop around all element data objects.
for ElementIterator in DesignAssessment.MeshData.Elements():
#Cross Section Data is only available for beams.
#First test to see if it's a beam as they support it.
if 'Beam' in ElementIterator.Description:
XSectionData = ElementIterator.CrossSectionData
print XSectionData.Description
if 'Tube' in XSectionData.Description:
print "Diameter = " + str(XSectionData.TubeDiameter)
print "Thickness = " + str(XSectionData.TubeThickness)

if 'Beam' in XSectionData.Description:
print "Web Thickness = " + str(XSectionData.BeamWebThickness)
print "Flange Thickness = " + str(XSectionData.BeamFlangeThickness)
print "Fillet Radii = " + str(XSectionData.BeamFilletRadii)
print "Height = " + str(XSectionData.BeamHeight)
print "Width = " + str(XSectionData.BeamWidth)
runClassDemo_SectionData()

Typical Evaluate (or Solve) Script Output


The output will depend upon the elements used in the model; this output is for a tube and a beam.
CHS,Tube
Diameter = 0.5
Thickness = 0.01
I,Beam
Web Thickness = 0.01
Flange Thickness = 0.01
Fillet Radii = 0.03
Height = 0.65
Width = 0.5

Release 2020 R1 - © ANSYS, Inc.


1575
Using Design Assessment

AttributeGroup class
This class represents the Attribute Group entries in the tree view and provides access to the data entered.
This tree object is defined in the AttributeGroups (p. 1552) section of the XML definition file.

Table 101: Members

Name Type Description


Attributes() Attribute[] (p. 1577) class Array of all the Attribute class objects held under
this AttributeGroup
Attribute(int index) Attribute (p. 1577) class An Attribute class object at the index as defined in
the AttributeIDs field in the XML definition file. Index
is zero based.
Attribute(string Attribute (p. 1577) class An Attribute class object of the name defined in the
XMLName) XML definition file, from the Attribute array
AttributeCount int The number of Attribute class objects in the Attribute
array
TreeName string The name of this AttributeGroup as defined by the
user in the user interface
XmlType string The Type of this AttributeGroup as defined in the
XML definition file
XmlSubType string The Sub Type of this AttributeGroup as defined in
the XML definition file

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_AttributeGroups():
#Loop around all attribute group objects.
for AGIterator in DesignAssessment.AttributeGroups():
#Attribute Group info
print "Name = " + AGIterator.TreeName
print "Type = " + AGIterator.XmlType
print "Subtype = " + AGIterator.XmlSubType

#Obtaining contained attributes


print "No of Attributes = " + str(AGIterator.AttributeCount)
Index = 0
for AttributeIterator in AGIterator.Attributes():
#Get the name of this attribute
AName = AttributeIterator.AttributeName
#Get the attribute, based on the index
AttributeMethod1 = AGIterator.Attribute(Index)
#Get the attribute, based on the Name, it's easier to look up by name.
AttributeMethod2 = AGIterator.Attribute(AName)
print "Attribute Name: " + AName
print "Check names are the same: " + str(AName == AttributeMethod1.AttributeName)
print "Are attrib. objects the same: " + str(AttributeMethod1 == AttributeMethod2)
#Add to the index (there are more concise ways of doing this in a loop)
Index = Index + 1
runClassDemo_AttributeGroups()

Typical Evaluate (or Solve) Script Output


The output will depend upon the XML definition file used in the model and the attribute groups used.

Release 2020 R1 - © ANSYS, Inc.


1576
Design Assessment API Reference

Name = Attribute Group


Type = Geometry Factor
Subtype = My Factors
No of Attributes = 1
Attribute Name: Factor
Check names are the same: True
Are attrib. objects the same: True

Attribute class
This class provides access to the input provided for each attribute in the attribute group. The attributes
are defined in the Attributes (p. 1549) section of the XML definition file.

Table 102: Members

Name Type Description


AttributeName int The name of this Attribute
ValueAsInt int Returns the value entered as an integer; double values
will be truncated. Accepted input is determined by the
XML definition file.
ValueAsDouble double Returns the value entered as a double. Accepted input
is determined by the XML definition file.
ValueAsString string Returns the value entered as text; if the value is
numerical, it will automatically be converted to text.
Accepted input is determined by the XML definition
file.
SelectedElementCount int Returns the number of elements included in the
selected geometry
SelectedElements() DAElement[] (p. 1571) Returns an array of DAElements included in the selected
class geometry
SelectedNodeCount int Returns the number of nodes included in the selected
geometry
SelectedNodes() DANode[] (p. 1573) class Returns an array of DANodes included in the selected
geometry

Note

The functions SelectedNodes and SelectedElements will return None if no geometry is spe-
cified. These functions, plus the SelectedNodeCount and SelectedElementCount are only
valid if the <Application> field in the attributes section of the XML definition file is used to
enable geometry selection.

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_Attributes():
#Loop around all attribute group objects
for AGIterator in DesignAssessment.AttributeGroups():
for AttributeIterator in AGIterator.Attributes():
#Get info about the attribute
print "Attribute Name = " + AttributeIterator.AttributeName
print "Value via ValueAsInt = " + str(AttributeIterator.ValueAsInt)
print "Value via ValueAsDouble = " + str(AttributeIterator.ValueAsDouble)

Release 2020 R1 - © ANSYS, Inc.


1577
Using Design Assessment

print "Value via ValueAsString = " + AttributeIterator.ValueAsString


print "No Elements in Selection = " + str(AttributeIterator.SelectedElementCount)
print "1st Element in Selection = " + str(AttributeIterator.SelectedElements()[0])
print "No of Nodes in Selection = " + str(AttributeIterator.SelectedNodeCount)
print "First Node in Selection = " + str(AttributeIterator.SelectedNodes()[0])
runClassDemo_Attributes()

Typical Evaluate (or Solve) Script Output


The output will depend upon the XML definition file used in the model and the attributes and attribute
groups used.
Attribute Name = Factor
Value via ValueAsInt = 1
Value via ValueAsDouble = 1.0
Value via ValueAsString = 1
No Elements in Selection = 236
1st Element in Selection = <Ans.Simulation.DesignAssessmentAssembly.DAElementClass object at
0x000000000000002B [Ans.Simulation.DesignAssessmentAssembly.DAElementClass]>
No of Nodes in Selection = 221
First Node in Selection = <Ans.Simulation.DesignAssessmentAssembly.DANodeClass object at
0x000000000000002C [Ans.Simulation.DesignAssessmentAssembly.DANodeClass]>

SolutionSelection class
This class represents the Solution Selection object in the tree view and provides access to the Solutions
entered in the Worksheet view. Each solution represents an upstream analysis.

Table 103: Members

Name Type Description


Solutions() Solution[] (p. 1579) class Array of all the Solution class objects held under this
Solution Selection, each being a row of the table.
SolutionByRow(int Solution (p. 1579) class A Solution class object at the given row in the
row) SolutionSelections worksheet, a one based value, so to
obtain the Solution class object for the first row, enter
1
SolutionCount int The number of Solution class objects in the Solutions
array

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_SolutionSelection():
#Loop around all solution selection objects (NB only 1 currently supported)
for SolutionSelectionIterator in DesignAssessment.SolutionSelections():
print "No of Solutions in selection = " + str(SolutionSelectionIterator.SolutionCount)
print "1st row in Solseln = " + str(SolutionSelectionIterator.SolutionByRow(1).Id)
for SolutionIterator in SolutionSelectionIterator.Solutions():
print "Id for solution = " + str(SolutionIterator.Id)
runClassDemo_SolutionSelection()

Typical Evaluate (or Solve) Script Output


The output will depend upon the XML definition file used in the model and the attributes and attribute
groups used.

Release 2020 R1 - © ANSYS, Inc.


1578
Design Assessment API Reference

No of Solutions in selection = 1
1st row in Solseln = 23
Id for solution = 23

Solution class
This class represents a row in the Worksheet of the Solution Selection tree object.

Table 104: Members

Name Type Description


AdditionalSolutionData() string[] Array of strings representing all the
additional data entered in to the
Solution Selection table additional
data columns
AdditionalSolutionDataByColumn(int
string The string object at the Column of
Column) the AdditionalSolutionData
AdditionalSolutionDataCount int The number of
AdditionalSolutionData text files in
the AdditionalSolutionData array
Id int The unique Id number for the
solution. Solution Id’s do not
change once the solution is created.
Type string The type of solution as defined
by the description:

Static Structural

Transient Structural

Explicit Dynamics

Modal

Harmonic Response

Random Vibration

Response Spectrum
CreateSolutionResult() SolutionResult (p. 1583) class Create a new result based on this
analysis system. Returns the created
object.
CreateSolutionResult(string SolutionResult (p. 1583) class Create a new result of the given
Name) Name based on this analysis system.
Returns the created object.
CreateSolutionResult(string SolutionResult (p. 1583) class Create a new result of the
Name, string Expression, string given Name, Expression and
ResultType) ResultType based on this
analysis system. Returns the
created object.

Release 2020 R1 - © ANSYS, Inc.


1579
Using Design Assessment

Name Type Description


ResultType string should be set
to one of the values listed for
DisplayUnits keyword (p. 1557)
in the DAResult (p. 1555) section
of the XML definition file.
CreateSolutionResultSets(int SolutionResult[] (p. 1583) class Creates a number of new Solution
NumSets) Result objects determined by the
given NumSets, based on this
Solution. These Solution Results are
substeps spread evenly across the
result step provided by the
definition in the Solution Selection
table (p. 1541). The created Solution
Result objects are then returned in
the form of an array.
CreateSolutionResultSets(int SolutionResult[] (p. 1583) class Creates a number of new Solution
NumSets, string Name) Result objects determined by the
given NumSets and Name, based
on this Solution. These Solution
Results are substeps spread evenly
across the result step provided by
the definition in the Solution
Selection table (p. 1541). The created
Solution Result objects are then
returned in the form of an array.
CreateSolutionResultSets(int SolutionResult[] (p. 1583) class Creates a number of new Solution
NumSets, string Name, string Result objects determined by the
Expression, string ResultType) given NumSets, Name, Expression
and ResultType, based on this
Solution. These Solution Results are
substeps spread evenly across the
result step provided by the
definition in the Solution Selection
table (p. 1541). The created Solution
Result objects are then returned in
the form of an array. ResultType
string should be set to one of the
values listed for DisplayUnits
keyword (p. 1557) in the
DAResult (p. 1555) section of the XML
definition file.
ClearSolutionResultSets() void Clears all SolutionResult objects
created for this Solution class.
SolutionResults() SolutionResult[] (p. 1583) class Array of results containing all the
result objects.
SolutionResults(string Name) SolutionResult[] (p. 1583) class Array of results containing specific
results filtered on the given Name.

Release 2020 R1 - © ANSYS, Inc.


1580
Design Assessment API Reference

Name Type Description


Units string Returns the Units used in this
solution, represented as a
string:

CGS

NMM

LBFT

LBIN

UMKS

MKS

No Units System
ResultFilePath string String representing the solution
combination result file path (rst file)
for the loadcase.
Time double Gets the value of time that has
been entered by the user in the
Solution Selection table (p. 1541), if
applicable.
Freq double Gets the value of frequency that has
been entered by the user in the
Solution Selection table (p. 1541), if
applicable.
Coefficient double Gets the Coefficient entered by the
user.
Phase double Gets the value of Phase Angle that
has been entered by the user in the
Solution Selection table (p. 1541), if
applicable.
Mode int Gets the value of Mode that has
been entered by the user in the
Solution Selection table (p. 1541), if
applicable.
StepStartTime double Gets the value of the start time that
has been entered by the user in the
Solution Selection table (p. 1541), if
applicable.
StepEndTime double Gets the value of the end time that
has been entered by the user in the
Solution Selection table (p. 1541), if
applicable.
StepMinFrequency double Gets the value of the minimum
frequency that has been entered by

Release 2020 R1 - © ANSYS, Inc.


1581
Using Design Assessment

Name Type Description


the user in the Solution Selection
table (p. 1541), if applicable.
StepMaxFrequency double Gets the value of the maximum
frequency that has been entered by
the user in the Solution Selection
table (p. 1541), if applicable.
StepCount int Returns the number of inclusive
steps used in this Upstream
Solution. This is only applicable
when the Solution is based on a
Static or Transient analysis type.
SubstepCount int Returns the number of inclusive
substeps used in this Upstream
Solution. This is only applicable
when the Solution is based on a
Static, Transient or Explicit analysis
type.
Steps() Int[] Gets an array of inclusive step
numbers used in this Upstream
Solution. This is only applicable
when the Solution is based on a
Static or Transient analysis type.
Substeps() Int[] Gets an array of inclusive Substep
numbers used in this Upstream
Solution. This is only applicable
when the Solution is based on a
Static, Transient, or Explicit analysis
type.
TimePoints() Double[] Gets an array of result time points
for all inclusive Substeps used in
this Upstream Solution. This is only
applicable when the Solution is
based on a Static, Transient, or
Explicit analysis type.
MultipleSets bool Returns True if the Solution has
Multiple Sets set to ‘Enabled’ in the
Solution Selection table (p. 1541).

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_Solution2():
#Get all results called bob and set the expression to SX.
AllBobs = DesignAssessment.SolutionSelections()[0].SolutionByRow(1).SolutionResults("Bob")
for BobResultIter in AllBobs:
print "Bob found at " + str(BobResultIter)
BobResultIter.Expression = "SX"

def runClassDemo_Solution():
#Get the first entered upstream solution.
UpstreamSoln = DesignAssessment.SolutionSelections()[0].SolutionByRow(1)

Release 2020 R1 - © ANSYS, Inc.


1582
Design Assessment API Reference

#Get properties that identify this solution.


print "Id = " + str(UpstreamSoln.Id)
print "Type = " + str(UpstreamSoln.Type)

#Get properties defined for this entry in the solution selection worksheet
print "Time = " + str(UpstreamSoln.Time)
print "Frequency = " + str(UpstreamSoln.Frequency)
print "Phase = " + str(UpstreamSoln.Phase)
print "Mode = " + str(UpstreamSoln.Mode)
print "Coefficient = " + str(UpstreamSoln.Coefficient)
print "Result File Path = " + str(UpstreamSoln.ResultFilePath)
print "Units system used = " + str(UpstreamSoln.Units)

#XML defined properties in the solution selection worksheet


print "Number of Additional strings = " + str(UpstreamSoln.AdditionalSolutionDataCount)
print "Additional strings = " + str(UpstreamSoln.AdditionalSolutionData())
print "Additional string, col 1 = " + str(UpstreamSoln. AdditionalSolutionDataByColumn(1))

#Create a new result object for this solution


#this object can then be used directly to set expressions, etc.
MyResult = UpstreamSoln.CreateSolutionResult()
#Use the Name for identification,
#useful to obtain the results in another subroutine in python.
MyBobResult = UpstreamSoln.CreateSolutionResult("Bob")
MyFredResult = UpstreamSoln.CreateSolutionResult("Fred")
My2ndBobResult = UpstreamSoln.CreateSolutionResult("Bob")

#Define expression at same time as creating the result.


MySXDefinedResult = UpstreamSoln.CreateSolutionResult("FredSX","sx")
runClassDemo_Solution()

Typical Evaluate (or Solve) Script Output


The output will depend upon the XML definition file used in the model and the attributes and attribute
groups used.
Id = 23
Type = Static Structural
Time = 1.0
Frequency = 0.0
Phase = 0.0
Mode = 0
Coefficient = 1.0
Result File Path = D:\Data\Documents\HelpFileExample_files\dp0\SYS\MECH\file.rst
Units system used = MKS
Number of Additional strings = 1
Additional strings = Array[str]((''))
Additional string, col 1 =
Bob found at <Ans.Simulation.DesignAssessmentAssembly.SolutionResultClass object at
0x000000000000002D [Ans.Simulation.DesignAssessmentAssembly.SolutionResultClass]>
Bob found at <Ans.Simulation.DesignAssessmentAssembly.SolutionResultClass object at
0x000000000000002E [Ans.Simulation.DesignAssessmentAssembly.SolutionResultClass]>

SolutionResult class
This class holds the solution result data that can be accessed, directly related to the solution. The solution
result class will be initialized with the unit system specified for the Design Assessment analysis. Only
when a valid unit system and type are set will results obtained be converted correctly to the expected
result units.

Results are organized in sets; each set contains the results at a given time, frequency, etc. depending
upon the analysis type. It is more efficient to get all the required results at a given set, before changing
sets. For convenience the set can be identified automatically by defining a time or frequency. If the
value is not exact then the results will be interpolated from the adjacent values.

Release 2020 R1 - © ANSYS, Inc.


1583
Using Design Assessment

If the value cannot be obtained (for example, requesting elemental values for a nodal result), the max-
imum value for a double type is returned (1.79769e+308).

Note

DefineCoordinateSystem and CoordinateSystem are mutually exclusive; if both are used, the
last one defined takes precedence.

Table 105: Members

Name Type Description


Name string Gets or sets the name of the result, so that it
can be found from the solution class.
ElementNodalValues(int double[] Array of values of an element nodal result at
ElementId, int NodeId) the given ElementId and NodeId. The size of
the returned array will depend upon the
number of result components. If required, this
can be determined using ComponentCount or
the python len() function.
ElementalValues(int ElementId) double[] Array of values of an element result at the given
ElementId. The size of the returned array will
depend upon the number of result components.
If required, this can be determined using
ComponentCount or the python len() function.
NodalValues(int NodeId) double[] Array of values of a nodal result at the given
NodeId. The size of the returned array will
depend upon the number of result components.
If required, this can be determined using
ComponentCount or the python len() function.
DisplayStyle string Returns the DisplayStyle: i.e. if it’s a Vector,
Tensor, Scalar, etc. The returned string can
be used to programmatically set the
ResultGroup’s DisplayStyle.

Note: the returned value is dependent on


provided Expression and
IntegrationMethod, so these should be
called beforehand.
DisplayType string Returns the DisplayType: i.e. if it’s a Nodal,
Elemental or ElementNodal result. The
returned string can be used to
programmatically set the ResultGroup’s
DisplayType.

Note: the returned value is dependent on


provided Expression and
IntegrationMethod, so these should be
called beforehand.
ComponentCount int Returns the number of components for this
result, typically 1, 3, or 6.

Release 2020 R1 - © ANSYS, Inc.


1584
Design Assessment API Reference

Name Type Description


Note: the returned value is dependent on
provided Expression and
IntegrationMethod, so these should be
called beforehand.
ResultSetCount int Returns the total number of results sets for this
system. The Result Set count is read directly
from the underlying file containing the results..
Expression string Set the expression by assigning a string. Valid
expressions are the same as those used for user
defined results and can include mathematical
modifiers.
CoordinateSystem string Sets the coordinate system type by
assigning a string. Valid inputs are either
the name of a user coordinate system in
the Mechanical application or one of the
following:

Global (default)

Solution

The solution coordinate system is generally


associated with beam based results.
DefineCoordinateSystem(string void Defines a custom coordinate system
Axes, double Axis1X, double orientation matrix to obtain results in. Use
Axis1Y, double Axis1Z, double as an alternative to CoordinateSystem to
Axis2X, double Axis2Y, double enable an axis to be defined directly in the
Axis2Z, double OriginX, double python code. Axes is one of the following
OriginY, double OriginZ) strings used to define what two axes of
the orientation matrix are being entered,
the third axis is calculated automatically.

XY

YZ

ZX
SetUnitsSystem(string void Defines the units system that the results
UnitsSystem, string RotationUnit, are to be obtained in. If a string is blank,
string TemperatureUnit) then the default is assumed.

Options for UnitsSystem are:

MKS: i.e. Metric (m, Kg, N, s, V, A), (Default)

UMKS: i.e. Metric (µm, Kg, µN, s, mV, mA)

CGS: i.e. Metric (cm, g, dyne, s, V, A)

NMM: i.e. Metric (mm, Kg, N, s, mV, mA)

Release 2020 R1 - © ANSYS, Inc.


1585
Using Design Assessment

Name Type Description


LBFT: i.e. US Customary (ft, lbm, lbf, s, V, A)

LBIN: i.e. US Customary (in, lbm, lbf, s, V,


A)

Options for RotationUnit are:

Degrees

Radians (Default)

Options for TemperatureUnit are:

Kelvin

Celsius (Default for metric systems)

For US Customary, Fahrenheit is always


used and the entered value is ignored.
ResultType string Gets or Sets the ResultType. ResultType
string should be set to one of the values
listed for DisplayUnits keyword (p. 1557) in
the DAResult (p. 1555) section of the XML
definition file. No Units is the default value.

If not set or left as default No Units, any


results obtained will not be unit converted
to the appropriate units for the Design
Assessment system.
IntegrationMethod string Defines the integration method used when
obtaining results by assigning a string.
Valid options are:

UnAveraged

Averaged (default)

Nodal Difference

Nodal Fraction

Elemental Mean

Elemental Difference

Elemental Fraction

Different Integration options can affect the


DisplayType.
ResultSet int Defines the set that data is obtained from
by assigning an integer value. It is
recommended that this method is used to
specify which results are to be obtained

Release 2020 R1 - © ANSYS, Inc.


1586
Design Assessment API Reference

Name Type Description


for Modal, Spectrum, and Response
Spectrum analyses.

Assigning 0 will obtain data from the last


result set in the analysis.

Default is based on the entry in the


Solution Selection (p. 1541) table.
ResultTimeFrequency double Defines the time or frequency that data is
obtained from by assigning a real number
to indicate the time or frequency. Whether
it is defining Time or Frequency 1 (p. 1587)
is determined automatically from the
analysis type.

Assigning 0.0 will obtain data from the last


time or frequency in the analysis.

If the analysis is time or frequency


independent then the ResultSet property
can be used instead.

Default is based on the entry in the


Solution Selection (p. 1541) table.
ShellLayer int Define the layer for which to obtain results.
In the case of composite sections, assigning
ShellLayer to a positive integer can be used
to define the layer number. Alternatively,
assign 0 for the whole section; this is
default behavior. See also
ShellFaceResultDisplay.

Only applicable to shell elements.


ShellFaceResultDisplay string Define what results are displayed on the
faces of shell elements by assigning a
string. Valid entries are:

Top (i.e. results calculated for the top face


on both faces)

Bottom (i.e. results calculated for the


bottom face on both faces)

Middle (i.e. calculated middle values on


both faces - see Surface Body Results
(including Layered Shell Results) (p. 1210) for
details)

Only applicable to shell elements.

1 - Obtaining frequency based results is not presently supported.

Release 2020 R1 - © ANSYS, Inc.


1587
Using Design Assessment

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_SolutionResult():
#Create a scripted, user defined, result
MyRes = DesignAssessment.SolutionSelections()[0].SolutionByRow(1).CreateSolutionResult()

#Define what result we're obtaining.


MyRes.Expression = "UX"

#You can specify the solution or Global system..


MyRes.CoordinateSystem = "Solution"
#Alternatively, define a coordinate system directly.
#The last CS defined takes precidence.
#MyRes.DefineCoordinateSystem("ZX",1,0,0,0,1,0,0,0,0)

#Define the units sytem and the units type to convert the results.
#MyRes.SetUnitsSystem("UMKS","Radians","Celsius","Distance")

#Define the method of integrating the results, this can affect the result type.
#MyRes.IntegrationMethod = "UnAveraged"

#Set the time or set for the results that we want to obtain,
#last one defined takes precidence.
MyRes.ResultSet = 0
MyRes.ResultTimeFrequency = 0

#Get some info about this result


DS = MyRes.DisplayStyle
print DS
DT = MyRes.DisplayType
print DT
NC = MyRes.ComponentCount
print NC
NRS = MyRes.ResultSetCount
print NRS

#Loop around all elements objects.


for ElementIter in DesignAssessment.MeshData.Elements():
print "Element Values = " + str(MyRes.ElementalValues(ElementIter.Id))
for NodeIter in ElementIter.Nodes():
Values = str(MyRes.ElementNodalValues(ElementIter.Id,NodeIter.Id))
print "Element Nodal Result Values = " + Values

#Loop around all node objects.


for NodeIterator in DesignAssessment.MeshData.Nodes():
print "Node Result Values = " + str(MyRes.NodalValues(NodeIterator.Id))
runClassDemo_Solution()

Typical Evaluate (or Solve) Script Output


The output will depend upon the model.
Scalar
Nodal
1
1
Element Value = Array[float](( 1.7976931348623157e+308))
Element Nodal Result Values = Array[float]((-2.5374282230927747e-08))
Element Nodal Result Values = Array[float]((-1.6870160379767185e-08))
Element Nodal Result Values = Array[float]((-9.8640562384844088e-09))
....
Node Result Values = Array[float]((-4.6618247040441929e-08))
Node Result Values = Array[float]((-3.7071398395482902e-08))
Node Result Values = Array[float]((-2.8261506912485856e-08))
....

Release 2020 R1 - © ANSYS, Inc.


1588
Design Assessment API Reference

DAResult class
This class provides access to the results objects, and enables the user to set the results that are to be
displayed when the result object is selected. The DAResult is defined in the DAResults (p. 1555) section
of the XML definition file.

Table 106: Members

Name Type Description


TreeName string Returns the user defined name of this result instance
XmlType string Returns the text string of the Type of this result
instance; the Type is set in the user interface by a
drop-down list (as defined in the XML definition file)
XmlSubType string Returns the text string of the Sub Type of this result
instance; the Sub Type is set in the user interface
by a drop-down list (as defined in the XML definition
file)
DAResultSetCount int Total number of sets that are available for this result
CreateDAResultSet() DAResultSet (p. 1591) Creates a new result set and returns it so that
class values can be defined within it

DisplayStyle and DisplayType will be read from


values in the XML definition file, or if multiple
DAResultSets are created, they’ll be read from
the first set.
CreateDAResultSet(string DAResultSet (p. 1591) Creates a new result set and returns it so that
DisplayStyle, string class values can be defined within it
DisplayType)
overrides the DisplayStyle entered in the XML
definition file for this result group. However,
unlike the XML definition file setting, defining
it here does not enable the option to choose
the component in the user interface of the DA
Result object. However, this option can be used
to force the display to show either a Vector or
Tensor result; 3 or 6 component values should
be defined accordingly.

DisplayStyle strings should be set to one of the


values listed for the DisplayStyle
keyword (p. 1557) in the DAResult (p. 1555) section
of the XML definition file.

DisplayType overrides the DisplayType entered


in the XML definition file, and should be a valid
DisplayType keyword in the DAResult section
of the XML definition file.
DAResultSets() DAResultSet[] (p. 1591) Returns an array of DAResultSets classes from the
class DAResultSet collection for this DAResult

Release 2020 R1 - © ANSYS, Inc.


1589
Using Design Assessment

Name Type Description


DAResultSet(int DAResultSet (p. 1591) Returns a single DAResultSet object for the given
SetNumber) class SetNumber. SetNumber is 1 based and incremented
automatically with each set that is added.
AttributeCount() int Total number of Attributes objects defined
Attributes() Attribute[] (p. 1577) Array of Attribute class objects; the Attribute
class collection for this DAResult as Attribute class type
Attribute(string Attribute (p. 1577) class An Attribute class object of the name defined in the
XMLName) XML definition file, from the Attribute array
Attribute(int index) Attribute (p. 1577) class An Attribute class object at the index as defined in
the AttributeIDs field in the XML definition file. Index
is zero based.
DisplayStyle string Gets the type of display, as defined in the XML
definition file, or as defined when creating a result
set; Scalar, Vector, Tensor, or StrainTensor.
DisplayType string Gets the type of display, as defined in the XML
definition file or as defined when creating a result
set; Elemental, Nodal, or ElementNodal.
DisplayUnits string Gets or sets the DisplayUnits set programmatically.
By default it’s obtained from the display units set
via the XML definition file for this DAResult. If setting
it, the string should be set to one of the values listed
for DisplayUnits keyword (p. 1557) in the
DAResult (p. 1555) section of the XML definition file.
IsUpToDate bool This will return true if the DAResult is currently Up
To Date, otherwise it will return false.

Note

A DAResult that is currently Up To Date is in a read-only state, and therefore its properties
and results can not be modified. In order to modify the DAResult, you will need to clear it
via the User Interface before solving or evaluating.

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_DAResult():

for DAResultIter in DesignAssessment.DAResults():


#General info:
print "Name = " + DAResultIter.TreeName
print "XmlType = " + DAResultIter.XmlType
print "XmlSubType = " + DAResultIter.XmlSubType

#Show and modify display options.


print "Initial DisplayType = " + DAResultIter.DisplayType
print "Initial DisplayStyle = " + DAResultIter.DisplayStyle
print "Initial DisplayUnits = " + DAResultIter.DisplayUnits
DAResultIter.DisplayUnits = "Stress"
print "New DisplayUnits = " + DAResultIter.DisplayUnits

#Attribute access:

Release 2020 R1 - © ANSYS, Inc.


1590
Design Assessment API Reference

print "Number of Attributes = " + str(DAResultIter.AttributeCount)


myAttribute = DAResultIter.Attribute(0)
myAttributeByName = DAResultIter.Attribute("Mathematical Operator")
print "Are they the same? = " + str(myAttribute == myAttributeByName)
print "All attributes = " + str(DAResultIter.Attributes())

NewSet = DAResultIter.CreateDAResultSet()
GetSet = DAResultIter.DAResultSet(1)
print "Are they the same object? = " + str(NewSet == GetSet)
print "Number of Result Sets = " + str(DAResultIter.DAResultSetCount)
print "Result Sets = " + str(DAResultIter.DAResultSets())
runClassDemo_DAResult()

Typical Evaluate (or Solve) Script Output


The output will depend upon the XML definition file used in the model and the attributes and attribute
groups used.
Name = DA Result
XmlType = My Custom Result
XmlSubType = Element
Initial DisplayType = Elemental
Initial DisplayStyle = Scalar
Initial DisplayUnits = No Units
New DisplayUnits = Stress
Number of Attributes = 1
Are they the same? = True
All attributes = Array[AttributeClass]((<Ans.Simulation.DesignAssessmentAssembly.AttributeClass
object at 0x000000000000002F [Ans.Simulation.DesignAssessmentAssembly.AttributeClass]>))
Are they the same object? = True
Number of Result Sets = 1
Result Sets = Array[DAResultSetClass]((<Ans.Simulation.DesignAssessmentAssembly.DAResultSetClass
object at 0x0000000000000030 [Ans.Simulation.DesignAssessmentAssembly.DAResultSetClass]>))

DAResultSet class
This class provides the ability to set result values ready for displaying at the appropriate solution step.

The object stores 3 types of result values:

• Elemental results are for when only a single value is to be displayed for each element.

• ElementNodal results are for when an element has different results at each node, but the result belongs to
the element, hence there can be multiple results at a given node.

• Nodal results have a value at each node.

A DAResultSet is equivalent to a DAResult substep. The SubstepValue parameter enables multiple results
to be calculated and displayed for a DAResult.

Only results that are appropriate for the display type set in the XML definition file should be added to
the object; otherwise an exception will be generated.

Depending upon the display style set in the XML definition file the result can have a 1, 3 or 6 components,
i.e. scalar, vector or tensor. The component input required is 1 based, i.e. use 1 in the case of scalar.

Release 2020 R1 - © ANSYS, Inc.


1591
Using Design Assessment

Setting any value to the capacity of a double (1.79769e+308) will result in the element being displayed
in a translucent manner. This is the default if a value is not defined for a particular element.

Table 107: Members

Name Type Description


SetElementalValue(int ElementId, int void Sets an element result for a given component
Component, double Value) to the specified Value
GetElementalValue(int ElementID, int double Returns the result value
Component)
SetElementalValues(int ElementId, double[] void Sets an element result for all components to
Values) the specified Value array
GetElementalValues(int ElementId) double Returns the result values for all components
[] as an array
SetElementNodalValue(int ElementId, int void Sets a node result at the NodeId of an
NodeId, int Component, double Value) element defined by the provided
ElementId, for the specified Component.

If the NodeId doesn’t exist on the given


ElementId an exception will be generated.
GetElementNodalValue(int ElementId, int double Returns the result for a given NodeId,
NodeId, int Component) ElementId, and Component.

If the NodeId doesn’t exist on the given


ElementId an exception will be generated.
SetElementNodalValues(int ElementId, int void Sets a node result at the NodeId of an
NodeId, double[] Values) element defined by the provided
ElementId for all components.

If the NodeId doesn’t exist on the given


ElementId an exception will be generated.
GetElementNodalValues(int ElementId, int double[] Returns the result for a given NodeId and
NodeId) ElementId for all components as an array.

If the NodeId doesn’t exist on the given


ElementId an exception will be generated.
SetNodalValue(int NodeId, int Component, void Sets a node result value for the given NodeId
double Value) and Component
GetNodalValue(int NodeId, int Component) double Returns the value for the given NodeId and
Component
SetNodalValues(int NodeId, double[] Values) void Sets a node result values for the given NodeId
for all Components
GetNodalValues(int NodeId) double[] Returns the value for the given NodeId as an
array for all Components
SubstepValue double Sets the Substep value of this DAResultSet (i.e.
Time, Frequency, Substep Number)

Release 2020 R1 - © ANSYS, Inc.


1592
Examples of Design Assessment Usage

Example Usage
The following example can be used as a basis of either the solve or evaluate script.
def runClassDemo_DAResultSet():

for DAResultIter in DesignAssessment.DAResults():


#Create Result Set:

Res = DesignAssessment.SolutionSelections()[0].SolutionByRow(1).CreateSolutionResult()
#Set the expression and integration method, result info is dependant on these
Res.Expression = "UX"
Res.IntegrationMethod = "Unaveraged"

#Create a result based on the upstream results type and style.


DT = Res.DisplayType
DS = Res.DisplayStyle
NewDAResultSet = DAResultIter.CreateDAResultSet(DS, DT)

print DT
print DS

if (DT == "Elemental"):
#Loop around all elements objects.
for ElementIter in DesignAssessment.MeshData.Elements():
ElemId = ElementIter.Id
NewDAResultSet.SetElementalValues(Id, Res.ElementalValues(Id))

elif (DT == "ElementNodal"):


#Loop around all elements objects.
for ElementIter in DesignAssessment.MeshData.Elements():
ElemId = ElementIter.Id
#Loop around all node objects attached to the element.
for NodeIter in ElementIter.Nodes():
NodeId = NodeIter.Id
ResultValues = Res.ElementNodalValues(ElemId, NodeId)
NewDAResultSet.SetElementNodalValues(ElemId, NodeId, ResultValues)

elif (DT == "Nodal"):


#Loop around all node objects.
for NodeIterator in DesignAssessment.MeshData.Nodes():
NodeId = NodeIterator.Id
ResultValues = Res.NodalValues(NodeId)
print NodeId + " : " + str(ResultValues)
NewDAResultSet.SetNodalValues(NodeId, ResultValues)
runClassDemo_DAResultSet()

Typical Evaluate (or Solve) Script Output


The output will depend upon the XML definition file used in the model and the attributes and attribute
groups used.
Nodal
Scalar
1 : 9.5726960580577725e-08
2 : -8.2783643051698164e-08
3 : -7.0038652211223962e-08
4 : -1.0865198873943882e-07

Examples of Design Assessment Usage


The following examples show how the Design Assessment system can be used to provide external
processing during an analysis.
Using Design Assessment to Obtain Results from Mechanical APDL
Using Design Assessment to Calculate Complex Results, such as Those Required by ASME
Using Design Assessment to Perform Further Results Analysis for an Explicit Dynamics Analysis

Release 2020 R1 - © ANSYS, Inc.


1593
Using Design Assessment

Using Design Assessment to Obtain Composite Results Using Mechanical APDL


Using Design Assessment to Access and Present Multiple Step Results
Using Design Assessment to Perform an Explicit-to-Implicit Sequential Analysis

The Python script and XML files described in the Design Assessment examples are available from the
ANSYS Customer Portal. Go to http://support.ansys.com/docinfo and locate the Design Assessment ex-
amples zip file. Download the file and unzip it to your local disk. There is a subfolder for each Design
Assessment example.

Using Design Assessment to Obtain Results from Mechanical APDL


The purpose of this example is to illustrate how to run Mechanical APDL in batch mode using Design
Assessment, and how to display the results within the Workbench environment; see the Mechanical
APDL Command Reference for further information.

An example Mechanical APDL data file is shown below. This surf154.dat file is written to obtain
surface 154 results that are not supported natively in the Mechanical application and to output them
to a CSV file called data.csv. In this scenario, results are element based. Two arguments are to be
passed in:

• ARG1 = Result file path (without file extension)

• ARG2 = Time point to obtain results

The surf154.dat file


/batch
/post1
FILE,ARG1
set,NEAR,,1.0,,ARG2
esel,s,ename,,154
ETABLE,my_press,smisc,13
*get,ecount,elem,0,count
*dim,output,arra,ecount,10
curre = 0
*do,i,1,ecount
curre = ELNEXT(curre)
output(i,1) = curre
*get,output(i,2),etab,1,elem,curre
*enddo
*cfopen,data,csv
*vwrite,output(1,1), output(1,2)
(2(F16.7,','))
*cfclose
fini
/exit

It is recommended that the files for this example are to be placed in a folder called DA MAPDL Example
within your ANSYS Inc folder. If you choose not to use this folder, the paths used in the XML definition
file to locate the python scripts will need to be modified.

Creating the XML Definition File


The XML definition file is set up to create an Attribute Group object for the user to browse to the macro,
and a DA Result object to indicate which column from the CSV file to present results for.

It will run two scripts. Upon solve, the macro file defined by the user in the Attribute Group will be run
by Mechanical APDL and the CSV file created. Upon evaluate, values will be read from the appropriate
column in the CSV file and displayed in the Details view of the Design Assessment system.

Release 2020 R1 - © ANSYS, Inc.


1594
Examples of Design Assessment Usage

MAPDL.xml
<?xml version="1.0" encoding="utf-8"?>
<DARoot ObjId ="1" Type="CAERep" Ver="2">
<Attributes ObjId="2" Type="CAERepBase" Ver="2">
<DAAttribute ObjId="100" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">MAPDL Macro File</AttributeName>
<AttributeType PropType="string">Browse</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">256</Validation>
<Default PropType="string"></Default>
</DAAttribute>
<DAAttribute ObjId="101" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Column</AttributeName>
<AttributeType PropType="string">Int</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">1,100</Validation>
<Default PropType="string">1</Default>
</DAAttribute>
</Attributes>

<AttributeGroups ObjId ="3" Type="CAERepBase" Ver="2">


<DAAttributeGroup ObjId ="110000" Type="DAAttributeGroup" Ver="2">
<GroupType PropType="string">Select MAPDL File</GroupType>
<GroupSubtype PropType="string">By Browsing</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">100</AttributeIDs>
</DAAttributeGroup>
</AttributeGroups>

<DAScripts ObjId="4" Type="DAScripts" Ver="2">


<Solve PropType="string">%DAPROGFILES%\Ansys Inc\DA MAPDL Example\MAPDL_S.py</Solve>
<Evaluate PropType="string">%DAPROGFILES%\Ansys Inc\DA MAPDL Example\MAPDL_E.py</Evaluate>
<DAData PropType="int">1</DAData>
<CombResults PropType="int">0</CombResults>
</DAScripts>

<Results ObjId="5" Type="CAERepBase" Ver="2">


<DAResult ObjId ="120000" Type="DAResult" Ver="2">
<GroupType PropType="string">Select Result Column</GroupType>
<GroupSubtype PropType="string">Number Input</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101</AttributeIDs>
<DisplayType PropType="string">Elemental</DisplayType>
<DisplayStyle PropType="string">Scalar</DisplayStyle>
<DisplayUnits PropType="string">No Units</DisplayUnits>
</DAResult>
</Results>
</DARoot>

The Attributes section defines two DAAttributes:

1st Attribute: Enables the users to browse to the Macro file, Attribute Id = 100:

• Named “MAPDL Macro File”

• Browse control type

• Applies to all geometry

• Validates for a maximum length of 256 characters

• No default entry

2nd Attribute: Enables the users to select a column in the CSV file, Attribute Id = 101:

• Named “Column”

• Integer entry type

Release 2020 R1 - © ANSYS, Inc.


1595
Using Design Assessment

• Applies to all geometry

• Validates to check the value is between 1 and 100 (inclusive)

• Defaults to a value of 1

In the AttributeGroups section, we define a single Attribute Group object. As we have only one, the
GroupType and GroupSubtype fields are effectively redundant, but ought to be entered.

• Allow the users to browse to the Macro file, Attribute Id = 110000:

– Type = Select MAPDL File

– SubType = By Browsing

– Include Attribute with Id = 100

This becomes the following object in the Mechanical application:

In the DAScripts section we set the path to the scripts to be run on Solve and on Evaluate. In this case
we use the %DAPROGFILES% option to direct the program to the Program Files folder, wherever it’s
defined locally. The scripts in this case are called MAPDL_S.py and MAPDL_E.py. We want to permit
Design Assessment results and prevent combination results

In the Results section, we define a single DAResult object. As we have only one, the GroupType and
GroupSubtype fields are effectively redundant, but ought to be entered.

• Allow the users to browse to the Macro file, Attribute Id = 110000:

– Type = Select Result Column

– SubType = Number Input

– Include Attribute with Id = 101

– DisplayType is set to show results per element

– DisplayStyle is set to show a single, scalar, result

– There are no units associated to this result, we’ll set this in the python script

This becomes the following object in the Mechanical application:

Release 2020 R1 - © ANSYS, Inc.


1596
Examples of Design Assessment Usage

Creating the Script to be Run on Solve, MAPDL_S.py


When the user selects “solve” the python script will:

1. Find out what macro file has been selected

a. Display a message to the Solver Script Output if more than one attribute group is defined

2. Obtain selected upstream solution data

a. Display a message to the Solver Script Output if more than one upstream system is entered

3. Run the macro with Mechanical APDL

a. It is assumed that the macro will write data out to a CSV file so it can be read at the evaluate stage

b. Display the output from running the macro as the Solver Output
import os

DA = DesignAssessment

def runDADemoSolve():
#1.a - display message
if DA.AttributeGroupCount != 1:
print "Only one Attribute Group should be entered"

#2.a - Display message


if DA.SolutionSelections()[0].SolutionCount != 1:
print "Only one upstream solution should be entered"

#1 - Get the macro path


MAPDLMacro = DA.AttributeGroups()[0].Attribute("MAPDL Macro File").ValueAsString

SolPath = DA.SolutionSelections()[0].SolutionByRow(1).ResultFilePath

#2 - Form the command line strings


SolPath_Output = "Macro.out"
SolTime_ARG2 = str(DA.SolutionSelections()[0].SolutionByRow(1).Time)
BatchArgs = " -par1 file -par2 " + SolTime_ARG2

#2 - Run the solve with MAPDL


#Change to the path where the results are kept
os.chdir(SolPath.rstrip('file.rst'))
#Run MAPDL
DA.Helper.RunMAPDL(MAPDLMacro,SolPath_Output,BatchArgs)

Release 2020 R1 - © ANSYS, Inc.


1597
Using Design Assessment

#2.b - Display the output


DA.Helper.ReplaceSolverOutputFile(SolPath_Output)

runDADemoSolve()

Creating the Script to be Run on Evaluate All Results, MAPDL_E.py


When the user selects “evaluate” the python script will:

1. Read the CSV file

a. Identify the location of the CSV file; this is stored in the upstream result path

b. Convert it to a dictionary based on the element ID; each entry of the dictionary is a list of values for
each column in the file

i. Read each line of the file

ii. Split using the commas as the delimiter

iii. Convert the text into numeric values

iv. Store the values in an array

v. Add the array into the dictionary based on the ID

2. For each DAResult create a DAResultSet. Each DAResultSet will display a value for each element

a. Find the column to use based on the users entry

b. Create the DAResultSet

c. The value is found by looking it up in the dictionary with the given element ID
#import System
DA = DesignAssessment

#1.b.iii - Define a rountine to convert text to either a real or integer number.


def convertStr(s):
#remove the comma
s = s.translate(None,',')
#If a value exists
if len(s) > 0:
#Try to convert to an integer
try:
ret = int(s)
except ValueError:
#couldn't convert to an integer, try a real number
try:
ret = float(s)
except ValueError:
#couldn't convert to a number, set to large value
#(makes Mechanical display translucent)
ret = 1.7976931348623157e+308
return ret

#1.b - Define seperate routine to convert CSV to a dictionary for in-memory access.
def CSVToDictionary(PathAndFile):
#Define a dictionary
IDToDataDict = {};

#Open the file


CSVFile = open(PathAndFile,"r")

Release 2020 R1 - © ANSYS, Inc.


1598
Examples of Design Assessment Usage

#1.b.i - step through the file, line by line.


for line in CSVFile:
#1.b.ii - Split into an array of words.
words = line.split(",")

#Get the first column, this is the identifier (e.g. Element or Node ID)
ID = convertStr(words[0])

#1.b.iv - All other data becomes a list of numbers


Data = []
for i in range(len(words)-1):
Data.append(convertStr(words[i+1]))

#1.b.v - Assign the list to the identifier in the dictionary


IDToDataDict[ID] = Data

#Close the file and return the dictionary.


CSVFile.close()
return IDToDataDict

def runDADemo():

#1.a - Find where the CSV fle is stored.


SolPath = DA.SolutionSelections()[0].SolutionByRow(1).ResultFilePath
CSVPath = SolPath.rstrip('file.rst') + "data.csv"
#1.b - Call the function to convert the CSV file into a dictionary
IDToDataDict = CSVToDictionary(CSVPath)

#2 - access each DA Result object in the available results


for DAResult in DA.DAResults():
#2.a - Find the column to look up in the CSV data
ColIndex = DAResult.Attribute("Column").ValueAsInt - 1

#2.b - Create a result set to display the results using.


#We know that in this case it's scalar and element based.
DAResultSet = DAResult.CreateDAResultSet("Scalar","Elemental")

#2.c - For each element set the value.


for Element in DA.MeshData.Elements():
DAResultSet.SetElementalValue(Element.Id,1,IDToDataDict[Element.Id][ColIndex])

runDADemo()

Expanding the Example


The example given was for a scalar, elemental result. However, if the result required was say a nodal,
vector based result, then this example could easily modified by changing a few lines in the evaluate
script.

Assume that the CSV file contains a first column for the node Id, then 3 columns for X, Y, Z components
of the vector.

Then, these lines where it previously used SetElementValue:


DAResultSet = DAResult.CreateDAResultSet("Scalar","Elemental")

#2a - For each element set the value.


for Element in DA.MeshData.Elements():
DAResultSet.SetElementalValue(Element.Id,1,IDToDataDict[Element.Id][ColIndex])

Would change to the following, using the SetNodalValue function:


DAResultSet = DAResult.CreateDAResultSet("Vector","Nodal")

#2a - For each element set the value.


for Node in DA.MeshData.Nodes():
DAResultSet.SetNodalValue(Node.Id,1,IDToDataDict[Node.Id][0])

Release 2020 R1 - © ANSYS, Inc.


1599
Using Design Assessment

DAResultSet.SetNodalValue(Node.Id,2,IDToDataDict[Node.Id][1])
DAResultSet.SetNodalValue(Node.Id,3,IDToDataDict[Node.Id][2])

Alternatively, if the CSV file was always of this NodeId, X, Y, Z format, and given that this is converted
into a dictionary of arrays using the Node Id as the key, then the SetNodalValues function could be used
instead:
DAResultSet = DAResult.CreateDAResultSet("Vector","Nodal")

#2a - For each element set the value.


for Node in DA.MeshData.Nodes():
DAResultSet.SetNodalValues(Node.Id,IDToDataDict[Node.Id])

Using Design Assessment to Calculate Complex Results, such as Those Required


by ASME
The purpose of this example is to illustrate how to Design Assessment can be used to calculate results
that are beyond the capabilities of the standard user defined result; for example those given in codes
of practice such as those from ASME.

Creating the XML Definition File


The XML definition file defines 4 attributes; 3 are material constants and are to be grouped under a
single Attribute Group. The final one is the result set, used to obtaining intermediary results at a given
time. The attribute section of the XML definition file is defined as:
<Attributes ObjId="2" Type="CAERepBase" Ver="2">
<DAAttribute ObjId="101" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Const 1</AttributeName>
<AttributeType PropType="string">Double</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">-100,100</Validation>
<Default PropType="string">0.247</Default>
</DAAttribute>
<DAAttribute ObjId="102" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Const 2</AttributeName>
<AttributeType PropType="string">Double</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">-100,100</Validation>
<Default PropType="string">2.2</Default>
</DAAttribute>
<DAAttribute ObjId="103" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Const 3</AttributeName>
<AttributeType PropType="string">Double</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">-100,100</Validation>
<Default PropType="string">0.25</Default>
</DAAttribute>
<DAAttribute ObjId="110" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Set Number</AttributeName>
<AttributeType PropType="string">Int</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">1,100</Validation>
<Default PropType="string">1</Default>
</DAAttribute>
</Attributes>

And to group the 3 material constants together we have an Attribute Group. Defining these in the At-
tribute Group means that the values can be parameterized if required. This enables a range of coefficients
and associative results obtained by running Design Explorer.
<AttributeGroups ObjId ="3" Type="CAERepBase" Ver="2">
<DAAttributeGroup ObjId="100000" Type="DAAttributeGroup" Ver="2">
<GroupType PropType="string">ASME VIII Division 3 High Pressure Vessels</GroupType>
<GroupSubtype PropType="string">Material Constants</GroupSubtype>

Release 2020 R1 - © ANSYS, Inc.


1600
Examples of Design Assessment Usage

<AttributeIDs PropType="vector&lt;unsigned int>">101,102,103</AttributeIDs>


</DAAttributeGroup>
</AttributeGroups>

The solve and evaluate files are to reside in the user files folder so that they can be easily distributed
with the project. All of the processing is to be performed during the evaluate script, so no intermediary
files are created to pass data from the solve process to the evaluate process. Combination results are
not required and we have no additional system based selection data to define.
<DAScripts ObjId="4" Type="DAScripts" Ver="2">
<Solve PropType="string">%DAUSERFILES%\DA-AFT-012_m1-S_empty.py</Solve>
<Evaluate PropType="string">%DAUSERFILES%\DA-AFT-012_m1-E_v3_ST.py</Evaluate>
<DAData PropType="int">1</DAData>
<CombResults PropType="int">0</CombResults>
</DAScripts>

In the final section, 3 types of DAResults are defined based on the following equations:

X - Based on 3 entered constants, plus principal and Von Mises stress


(90)

Damage - The damage value: change in plastic strain divided by X


(91)

Damage Sum - Accumulative damage; i.e. sum of current and previous Damage values for each result
set.

The results section of the XML definition file appears as follows:


<Results ObjId="5" Type="CAERepBase" Ver="2">
<DAResult ObjId="100001" Type="DAResult" Ver="3">
<GroupType PropType="string">ASME VIII Division 3 High Pressure Vessels</GroupType>
<GroupSubtype PropType="string">Value X</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">110</AttributeIDs>
<DisplayType PropType="string">ElementNodal</DisplayType>
<DisplayStyle PropType="string">Scalar</DisplayStyle>
<DisplayUnits PropType="string">Stress</DisplayUnits>
</DAResult>
<DAResult ObjId="100002" Type="DAResult" Ver="3">
<GroupType PropType="string">ASME VIII Division 3 High Pressure Vessels</GroupType>
<GroupSubtype PropType="string">Damage</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">110</AttributeIDs>
<DisplayType PropType="string">ElementNodal</DisplayType>
<DisplayStyle PropType="string">Scalar</DisplayStyle>
<DisplayUnits PropType="string">No Units</DisplayUnits>
</DAResult>
<DAResult ObjId="100003" Type="DAResult" Ver="3">
<GroupType PropType="string">ASME VIII Division 3 High Pressure Vessels</GroupType>
<GroupSubtype PropType="string">Culmative Damage</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>"></AttributeIDs>
<DisplayType PropType="string">ElementNodal</DisplayType>
<DisplayStyle PropType="string">Scalar</DisplayStyle>
<DisplayUnits PropType="string">No Units</DisplayUnits>
</DAResult>
</Results>

Creating the Script to be Run on Evaluate


The script first imports the python math function and defines some constants.
import math

DA = DesignAssessment

Release 2020 R1 - © ANSYS, Inc.


1601
Using Design Assessment

DA.OutputDeprecatedWarnings(True)
UpstreamSolution = DesignAssessment.SolutionSelections()[0].Solutions()[0]

Three routines “EvaluateValueX”, “EvaluateDamage”, and “EvaluateCulmativeDamage”, are defined for


performing the calculations for each equation. These are followed with definitions for two additional
routines, “Plot” to plot the results and “EvaluateAllResults” to control the evaluate process. The following
sections look at each of these routines, starting from the “EvaluateAllResults” entry point.
EvaluateAllResults
EvaluateDamage
EvaluateCulmativeDamage
Plot

EvaluateAllResults
After defining a dictionary to store the element nodal based results, this function creates a new result
with part of the required equation and then defines which set to obtain the results from. Then, looping
through each element and its nodes, it calculates the part of the equation that is not possible with the
standard Mechanical equations and assigns it into the dictionary for the given node and element Id.
def EvaluateValueX(Set, Const1, Const2, Const3):

XValues = {} #key = element node id tuple, #data = values array.

SolRes = UpstreamSolution.CreateSolutionResult("",str(Const2/(1+Const3))+"*((((s1+s2+s3)/(3*seqv))-\
(1/3)))","Stress")
SolRes.ResultSet = Set

for Element in DA.MeshData.Elements():


for Node in Element.Nodes():
SolResValue = SolRes.ElementNodalValues(Element.Id,Node.Id)
XValue = Const1 * math.exp(SolResValue[0])
XValues[Element.Id,Node.Id] = XValue

return XValues

EvaluateDamage
This routine calls the “EvaluateValueX” function to obtain the X Values then creates 2 solution results
for the plastic strain results for this and, if one exists, the previous set. A dictionary is created for the
element nodal results being generated and this is populated by performing the required calculation.
def EvaluateDamage(Set, Const1, Const2, Const3):

XValues = EvaluateValueX(Set, Const1, Const2, Const3)

StrainRes = UpstreamSolution.CreateSolutionResult("","EPPLEQV_RST","Strain")
StrainRes.ResultSet = Set

PrevStrainRes = UpstreamSolution.CreateSolutionResult("","EPPLEQV_RST","Strain")
if (Set >= 2):
PrevStrainRes.ResultSet = Set - 1

DamageValues = {} #key = element node id tuple, #data = values array.

for Element in DA.MeshData.Elements():


for Node in Element.Nodes():
S1 = StrainRes.ElementNodalValues(Element.Id,Node.Id)[0]
S2 = 0
if (Set >= 2):
S2 = PrevStrainRes.ElementNodalValues(Element.Id,Node.Id)[0]
XValue = XValues[Element.Id,Node.Id]
DamageValues[Element.Id,Node.Id] = (S1 - S2) / XValue

return DamageValues

Release 2020 R1 - © ANSYS, Inc.


1602
Examples of Design Assessment Usage

EvaluateCulmativeDamage
This routine creates a dummy result to obtain the number of result sets. Then, for each set, calls the
“EvaluateDamage” function summing the results into a dictionary of element nodal results called Cul-
mativeDamage.
def EvaluateCulmativeDamage(Const1, Const2, Const3):
DummyRes = UpstreamSolution.CreateSolutionResult("","EPPLEQV_RST","Strain")

CulmativeDamage = {}

for Set in range(DummyRes.ResultSetCount):


DamageValues = EvaluateDamage(Set,Const1, Const2, Const3)

if (Set > 1):


for Element in DA.MeshData.Elements():
for Node in Element.Nodes():
CulmativeDamage[Element.Id,Node.Id] = CulmativeDamage[Element.Id,Node.Id] +\
DamageValues[Element.Id,Node.Id]
else:
CulmativeDamage = DamageValues

return CulmativeDamage

Plot
This routine creates a new result for this DAResult object and then loops over each element and node
setting the value obtained from the passed in dictionary.
def Plot(DAResult, ValuesDictionary):
ResultSet = DAResult.CreateDAResultSet()

for Element in DA.MeshData.Elements():


for Node in Element.Nodes():
Value = ValuesDictionary[Element.Id,Node.Id]
ResultSet.SetElementNodalValue(Element.Id,Node.Id,1,Value)

When the script is run, a contour plot is generated for each DA Result.

Release 2020 R1 - © ANSYS, Inc.


1603
Using Design Assessment

Using Design Assessment to Perform Further Results Analysis for an Explicit


Dynamics Analysis
The purpose of this example is to illustrate how Design Assessment can be used to perform further
processing, presenting results in a text file and graphically. In this example, algorithms are written in
python to identify which elements form fragments of the geometry following an Explicit Dynamics
analysis.

Creating the XML Definition File


The XML definition file defines a number of DA Results. All of the processing is to be performed during
the evaluate script. This approach means that different levels of damage can be used for the fragment
identification within one analysis. This would not be the case if the fragments were determined at the
solve stage, but determining fragments at solve stage could be more efficient. Six different results are
set up as follows:

• Element Results:

– Hide Damaged Elements

– Show User Defined Result

• Fragment Results:

– Number of Elements in Fragment

– Volume of Fragment

Release 2020 R1 - © ANSYS, Inc.


1604
Examples of Design Assessment Usage

– Mass of Fragment

– Average Damage in Fragment

Each can have failure based upon Failure Threshold or Status, with a numeric limit, and all but the Show
User Defined Result can optionally output text to the solver output file. These are attributes 90, 91, and
92 respectively. The Show User Defined Result also has additional input to enable the user to choose
the result to display.

The results section of the XML definition file is as follows:


<Results ObjId="5" Type="CAERepBase" Ver="2">
<DAResult ObjId ="120000" Type="DAResult" Ver="2">
<GroupType PropType="string">Element</GroupType>
<GroupSubtype PropType="string">Hide Damaged Elements</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="120001" Type="DAResult" Ver="2">
<GroupType PropType="string">Element</GroupType>
<GroupSubtype PropType="string">Show User Defined Result</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,103,105,106,107</AttributeIDs>
</DAResult>
<DAResult ObjId ="130000" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>
<GroupSubtype PropType="string">Number of Elements in Fragment</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="130001" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>
<GroupSubtype PropType="string">Volume of Fragment</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="130002" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>
<GroupSubtype PropType="string">Mass of Fragment</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="130003" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>
<GroupSubtype PropType="string">Average Damage in Fragment</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="130004" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>
<GroupSubtype PropType="string">Kinetic Energy Of Fragment</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="130005" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>
<GroupSubtype PropType="string">Characteristic Length of Fragment</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="130006" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>
<GroupSubtype PropType="string">CL Increase</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="130007" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>
<GroupSubtype PropType="string">Momentum</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="130008" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>
<GroupSubtype PropType="string">Origin</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="130009" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>

Release 2020 R1 - © ANSYS, Inc.


1605
Using Design Assessment

<GroupSubtype PropType="string">Centre</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
<DAResult ObjId ="130010" Type="DAResult" Ver="2">
<GroupType PropType="string">Fragment</GroupType>
<GroupSubtype PropType="string">AverageSpeed</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">90,91,92</AttributeIDs>
</DAResult>
</Results>

Creating the Script to be Run on Evaluate


The script first calls the function runDADemo. This loops over each result and, based on the type and
subtype it calls an appropriate sub function to perform the calculation.

In the case of fragmentation results, it first calls a function, IdentifyFragments, to create a dictionary of
fragments. The fragment dictionary created is a data collection that contains the fragment number for
each Element Id. This dictionary is passed to each function so it can be used for the fragment result
calculation.

An example of this fragment result calculation is VolumeOfFragment:


def VolumeOfFragment(SortedDict, DAResult, FragmentDict, NodalMass):
print " "
print "Volume of Fragment"
print " ________________________________"
print "|Fragment | Volume(m^3) |"
print "+------------+-------------------+"
UpstrResDensity = UpstreamSolution.CreateSolutionResult("","DENSITY","No Units")
UpstrResDensity.IntegrationMethod = "unAveraged" # unaveraged because summing indiviual values
# and taking an average afterwards.
Density = 0
NodeCounter = 0

FragmentDataDict = {} #key = elementid, data = mass


FragmentDataDict2 = {}
NodesProcessed = {}
for ElementID in FragmentDict.keys():
NodeList = DA.MeshData.ElementById(ElementID).NodeIds()
for NodeID in NodeList:
if NodesProcessed.has_key(NodeID):
continue
else:
Fragment = FragmentDict[ElementID]
Mass = NodalMass[NodeID] # uses NodalMass dictionary from NodalMassFunc
if FragmentDataDict.has_key(Fragment):
FragmentDataDict[Fragment] += Mass
else:
FragmentDataDict[Fragment] = Mass
NodesProcessed[NodeID] = 0
Density += UpstrResDensity.ElementNodalValues(ElementID, NodeID)[0] # sum all of the
# densities
NodeCounter += 1 # Count the number of nodes which have been processed

Index = 1
Total = 0
for Key in FragmentDataDict.keys():
TVol = (FragmentDataDict[Key])/(Density/NodeCounter) # divide total density by the number
# of nodes
Text = "Fragment :" + str(Index) + " has a Volume of " + str(TVol) + " m^3"
FragmentDataDict2[Key] = TVol

Index += 1
Total += TVol
NewResultData = DAResult.CreateDAResultSet("Scalar","Elemental")
for ElementId in FragmentDict:
NewResultData.SetElementalValue(ElementId, 1, FragmentDataDict2[FragmentDict[ElementId]])
FragmentDataDict2 = Sort(SortedDict, FragmentDataDict2)

Release 2020 R1 - © ANSYS, Inc.


1606
Examples of Design Assessment Usage

for Fragment in FragmentDataDict2:


print "| " + str(Fragment) + " | " + str('%.3e'%FragmentDataDict2[Fragment]) +\
" |"
print "+------------+-------------------+"
print "| Total | " + str('%.3e'%Total) +" |"
print "|____________|___________________|"
print " "
print " "
print " "

The result can then be displayed:

Expanding the Example


Additional results could be obtained on a per fragment basis.

Using Design Assessment to Obtain Composite Results Using Mechanical


APDL
Along with the example Using Design Assessment to Obtain Results from Mechanical APDL (p. 1594), the
purpose of this example is to illustrate how to run Mechanical APDL in batch mode using Design As-
sessment, and how to present the results within the Workbench environment - see MAPDL Command
Reference for further information.

Unlike Using Design Assessment to Obtain Results from Mechanical APDL (p. 1594) which is more generic,
this example is set up to run a specific script and obtain specific results; therefore the interface can be
more targeted and offer better guidance to the user.

In this example the input file for Mechanical APDL is dynamically generated by the python script. This
in turn calls a fix macro with various given parameters as determined from the DA Result objects added
to the model.

Release 2020 R1 - © ANSYS, Inc.


1607
Using Design Assessment

The macro file that is run, named LayerMultiPly.mac, is as follows:


! INPUT:
! Input arguments relate to the failure criteria for one material
! ARG1 Type of result, e.g. 'fail'
! ARG2 Subtype of the result, e.g. 'emax'
! ARG3 1 for nodal or 0 for elemental based results
! ARG4 1 based layer number
!
! OUTPUT: critical layer and Strength Ratio will be written to defined CSV file
!
/post1
/delete,CSVFile_Directory(1),csv
/cwd,Current_Directory(1)

Type = ARG1
SubType = ARG2
DisplayType = ARG3
LayerNum = ARG4

file,SYS_Directory(1),rst

set,last ! set the last set into memory


rsys,solu

! set the failure criteria


FCTYP,add,all
tblist,,1

! set the layer


layer,LayerNum

*if,DisplayType,eq,0,then

! select the elements


esel,s,ename,,181

! get the number of elements that we need to loop over


*get,ecount,elem,0,count

! make sure some elements are selection


*if,ecount,lt,1,then
*MSG,ERROR
THERE ARE NO ELEMENTS SELECTED FOR FAILURE CHECKING
*endif

! dimension the output arrays


*dim,output,arra,ecount,2

etab,bob,Type,SubType

!get elemental results


curre = 0
*do,i,1,ecount
curre = ELNEXT(curre) ! get the element number
output(i,1) = curre
*get,output(i,2),etab,1,elem,curre
*enddo

*cfopen,CSVFileScratch_Directory(1),csv
*vwrite,output(1,1),output(1,2)
(F10.0,',',F16.3)
*cfclose

*elseif,DisplayType,eq,1,then

! select the elements


esel,s,ename,,181
nsle

! get the number of nodes that we need to loop over

Release 2020 R1 - © ANSYS, Inc.


1608
Examples of Design Assessment Usage

*get,ncount,node,0,count

! make sure some nodes are selection


*if,ncount,lt,1,then
*MSG,ERROR
THERE ARE NO NODES SELECTED FOR FAILURE CHECKING
*endif

*dim,output2,arra,ncount,2
curre = 0
*do,i,1,ncount
curre = NDNEXT(curre)
output2(i,1) = curre
*get,output2(i,2),node,i,Type,SubType
*enddo

*cfopen,CSVFileScratch_Directory(1),csv
*vwrite,output2(1,1),output2(1,2)
(F10.0,',',F16.3)
*cfclose

*endif

It is recommended that the files for this example are to be placed in your user_files folder.

Creating the XML Definition File


The XML definition file is set up so that there are no attribute groups, and where appropriate the layer
number, display types, and an option to invert the value attributes are included in the DA Result
definitions.

The failure.xml file


<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<DARoot ObjId="1" Type="CAERep" Ver="2">
<Attributes ObjId="2" Type="CAERepBase" Ver="2">

<DAAttribute ObjId="100" Type="DAAttribute" Ver="2">


<AttributeName PropType="string">Layer</AttributeName>
<AttributeType PropType="string">Int</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">1,1000000</Validation>
<Default PropType="string">1</Default>
</DAAttribute>
<DAAttribute ObjId="101" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Display</AttributeName>
<AttributeType PropType="string">DropDown</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">Elemental,Nodal</Validation>
<Default PropType="string">Elemental</Default>
</DAAttribute>
<DAAttribute ObjId="102" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Inverse</AttributeName>
<AttributeType PropType="string">DropDown</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">Yes,No</Validation>
<Default PropType="string">Yes</Default>
</DAAttribute>
</Attributes>

<AttributeGroups ObjId="3" Type="CAERepBase" Ver="2">


</AttributeGroups>

<DAScripts ObjId="4" Type="DAScripts" Ver="2">


<Solve PropType="string">%DAUSERFILES%\SolveFailure.py</Solve>
<Evaluate PropType="string">%DAUSERFILES%\EvaluateFailure.py</Evaluate>
<DAData PropType="int">1</DAData>
<CombResults PropType="int">0</CombResults>
<SelectionExtra PropType="vector&lt;string>"></SelectionExtra>

Release 2020 R1 - © ANSYS, Inc.


1609
Using Design Assessment

</DAScripts>

<Results ObjId="5" Type="CAERepBase" Ver="2">


<DAResult ObjId="110001" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">Maximum strain</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100</AttributeIDs>
</DAResult>
<DAResult ObjId="110002" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">Maximum stress</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100</AttributeIDs>
</DAResult>
<DAResult ObjId="110003" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">Tsai-Wu strength index</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100,102</AttributeIDs>
</DAResult>
<DAResult ObjId="110004" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">Inverse of Tsai-Wu strength ratio index</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100,102</AttributeIDs>
</DAResult>
<DAResult ObjId="110005" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">Hashin fiber failure</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100,102</AttributeIDs>
</DAResult>
<DAResult ObjId="110006" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">Hashin matrix failure</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100,102</AttributeIDs>
</DAResult>
<DAResult ObjId="110007" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">Puck fiber failure</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100,102</AttributeIDs>
</DAResult>
<DAResult ObjId="110008" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">Puck inter-fiber (matrix) failure</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100,102</AttributeIDs>
</DAResult>
<DAResult ObjId="110009" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">LaRc03 fiber failure</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100,102</AttributeIDs>
</DAResult>
<DAResult ObjId="110010" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">LaRc03 matrix failure</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100,102</AttributeIDs>
</DAResult>
<DAResult ObjId="110011" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">LaRc04 fiber failure</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100,102</AttributeIDs>
</DAResult>
<DAResult ObjId="110012" Type="DAResult" Ver="2">
<GroupType PropType="string">Layer Dependant Failure</GroupType>
<GroupSubtype PropType="string">LaRc04 matrix failure</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">101,100,102</AttributeIDs>
</DAResult>

<DAResult ObjId="120000" Type="DAResult" Ver="2">


<GroupType PropType="string">Maximum Failure Criteria</GroupType>
<GroupSubtype PropType="string">Layer</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>"></AttributeIDs>
<DisplayType PropType="string">Elemental</DisplayType>
</DAResult>

<DAResult ObjId="120001" Type="DAResult" Ver="2">

Release 2020 R1 - © ANSYS, Inc.


1610
Examples of Design Assessment Usage

<GroupType PropType="string">Maximum Failure Criteria</GroupType>


<GroupSubtype PropType="string">Failure Criteria</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>"></AttributeIDs>
<DisplayType PropType="string">Elemental</DisplayType>
</DAResult>

<DAResult ObjId="120002" Type="DAResult" Ver="2">


<GroupType PropType="string">Maximum Failure Criteria</GroupType>
<GroupSubtype PropType="string">Value</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">102</AttributeIDs>
<DisplayType PropType="string">Elemental</DisplayType>
</DAResult>

</Results>
</DARoot>

Creating the Script to be Run on Solve, SolveFailure.py


This is not used as everything is run on the fly, so it is just a simple print statement to say as such.

Creating the Script to be Run on Evaluate All Results, EvaluateFailure.py


Example 1 covers some aspects of this evaluate function. For example reading the CSV file into a dic-
tionary. The following sections concentrate on the new techniques used here:
Using a Dictionary to Avoid a Long if/elif/else Statement.
Writing the MAPDL .inp File from Within Design Assessment
Running Mechanical APDL Multiple Times

Using a Dictionary to Avoid a Long if/elif/else Statement.


At the beginning of the script it sets up a dictionary matching the XML Type and XML SubType to the
Type and SubType of result required in Mechanical APDL:
TypeSubTypeDict = {}

TypeSubTypeDict["Layer Dependant Failure","Maximum strain"] = "fail","emax"


TypeSubTypeDict["Layer Dependant Failure","Maximum stress"] = "fail","smax"
TypeSubTypeDict["Layer Dependant Failure","Tsai-Wu strength index"] = "fail","twsi"
TypeSubTypeDict["Layer Dependant Failure","Inverse of Tsai-Wu strength ratio index"] = "fail","twsr"
TypeSubTypeDict["Layer Dependant Failure","Hashin fiber failure"] = "fail","hfib"
TypeSubTypeDict["Layer Dependant Failure","Hashin matrix failure"] = "fail","hmat"
TypeSubTypeDict["Layer Dependant Failure","Puck fiber failure"] = "fail","pfib"
TypeSubTypeDict["Layer Dependant Failure","Puck inter-fiber (matrix) failure"] = "fail","pmat"
TypeSubTypeDict["Layer Dependant Failure","LaRc03 fiber failure"] = "fail","l3fb"
TypeSubTypeDict["Layer Dependant Failure","LaRc03 matrix failure"] = "fail","l3mt"
TypeSubTypeDict["Layer Dependant Failure","LaRc04 fiber failure"] = "fail","l4fb"
TypeSubTypeDict["Layer Dependant Failure","LaRc04 matrix failure"] = "fail","l4mt"

TypeSubTypeDict["Maximum Failure Criteria","Layer"] = "FCMX","lay"


TypeSubTypeDict["Maximum Failure Criteria","Failure Criteria"] = "FCMX","fc"
TypeSubTypeDict["Maximum Failure Criteria","Value"] = "FCMX","val"

These can then be easily looked up using:


MAPDLKeys = TypeSubTypeDict[str(DAResult.XmlType),str(DAResult.XmlSubType)]

MAPDLKeys can then be accessed like a regular array; i.e. MAPDLKeys[0] will return “fail” or “FCMX”
appropriately.

Release 2020 R1 - © ANSYS, Inc.


1611
Using Design Assessment

Writing the MAPDL .inp File from Within Design Assessment


In this case we want to write the input file for Mechanical APDL from within Design Assessment so that
multiple paths can be set, etc., without having to use command line parameters. Most of the common
functionality is extracted to the macro file so the input file mainly just sets up these parameters.
def CreateMAPDLInputFile(MAPDLKeys,Layer,Display):
ArgList = str(",'" + MAPDLKeys[0]) + "','" + str(MAPDLKeys[1]) + "'," + str(Display) + "," + \
str(Layer)

currentdirectory = os.getcwd()

RunMapdlFile = open(TempMAPDLRunFilePath, "w")

WriteLine(RunMapdlFile,"/batch")

WriteLine(RunMapdlFile,"*DIM,SYS_Directory,string,248")
RSTFileLoc = DesignAssessment.SolutionSelections()[0].SolutionByRow(1).ResultFilePath.rstrip('.rst')
WriteLine(RunMapdlFile,"'SYS_Directory(1)' = " + "'" + RSTFileLoc + "'")

WriteLine(RunMapdlFile,"*DIM,CSVFile_Directory,string,248")
WriteLine(RunMapdlFile,"'CSVFile_Directory(1)' = " + "'" + DesignAssessment.Helper.ResultPath + \
"\\TempRes" + "'")

WriteLine(RunMapdlFile,"*DIM,CSVFileScratch_Directory,string,248")
WriteLine(RunMapdlFile,"'CSVFileScratch_Directory(1)' =" + "'" + currentdirectory + "\\TempRes" + \
"'")

WriteLine(RunMapdlFile,"*DIM,Current_Directory,string,248")
WriteLine(RunMapdlFile,"'Current_Directory(1)' =" + "'" + currentdirectory + "'")

WriteLine(RunMapdlFile,"*USE,LayerMultiPly.mac" + ArgList)

WriteLine(RunMapdlFile,"fini")
WriteLine(RunMapdlFile,"/exit")

RunMapdlFile.close()

Running Mechanical APDL Multiple Times


Mechanical APDL is run repeatedly for each DA Result object. In each case, the CSV file is read and the
results displayed. In-line if statements are used to determine, among other things, if the value is to be
inverted and what the value is if it is inverted.
def runStressEvaluate(DesignAssessment):

#Change to the result path as the local folder, to save passing in long file names to the MAPDL solve
originaldir = os.getcwd()
os.chdir(DesignAssessment.Helper.ResultPath)

# Make sure the mapdl macro is in this directory


shutil.copy2(DesignAssessment.Helper.UserFilesDirectory + "\\LayerMultiPly.mac", \
DesignAssessment.Helper.ResultPath)

# For now just assume one upstream but could make the code generic if required
if (DesignAssessment.SolutionSelections()[0].SolutionCount > 1):
print "only the first solution in the solution selection object will be used"

for DAResult in DesignAssessment.DAResults():

#Identify the type and subtype to be passed into MAPDL


MAPDLKeys = TypeSubTypeDict[str(DAResult.XmlType),str(DAResult.XmlSubType)]
print MAPDLKeys

#in-line if / else statements, format of N = ValueA if statement [is true] else [N =] ValueB.
Layer = 0 if (DAResult.Attribute("Layer") == None) else DAResult.Attribute("Layer").ValueAsInt
Display = "Elemental" if (DAResult.Attribute("Display") == None) else \
DAResult.Attribute("Display").ValueAsString
Inverse = False if (DAResult.Attribute("Inverse") == None) else \

Release 2020 R1 - © ANSYS, Inc.


1612
Examples of Design Assessment Usage

DAResult.Attribute("Inverse").ValueAsString == "Yes"

#Create the results temp file by running a post script with MAPDL
if Display == "Elemental":
CreateMAPDLInputFile(MAPDLKeys,Layer,0)
elif Display == "Nodal":
CreateMAPDLInputFile(MAPDLKeys,Layer,1)

#Run MAPDL
DesignAssessment.Helper.RunMAPDL(TempMAPDLRunFilePath,"out.lis","/minimise")
DesignAssessment.Helper.ReplaceSolverOutputFile("out.lis")

#Read the results from the temp file to memory.


IDToDataDict = CSVToDictionary(DesignAssessment.Helper.ResultPath + "tempres.csv")

#Present the results


#Elemental
if Display == "Elemental":
DAResultSet = DAResult.CreateDAResultSet("Scalar","Elemental")

for Element in DesignAssessment.MeshData.Elements():


Value = 1/max(IDToDataDict[Element.Id][0],0.01) if Inverse else \
IDToDataDict[Element.Id][0]
DAResultSet.SetElementalValue(Element.Id,1,Value)

#Nodal
elif Display == "Nodal":
DAResultSet = DAResult.CreateDAResultSet("Scalar","Nodal")

for Node in DesignAssessment.MeshData.Nodes():


Value = 1/max(IDToDataDict[Node.Id][0],0.01) if Inverse else IDToDataDict[Node.Id][0]
DAResultSet.SetNodalValue(Node.Id,1,Value)

os.chdir(originaldir)

Expanding the Example


The example could be expanded to perform combinations of results and factor the values based on
the coefficient provided for the upstream system.

Using Design Assessment to Access and Present Multiple Step Results


This example shows how to access upstream results from multiple time points and to create a new
result with a different number of time points as defined in the user object.

Creating the XML Definition File


The following XML definition file defines attributes for a DA Result object that allow you to specify a
particular row in the Solution Selection, an expression and units, along with the number of substeps
for which to present results.
<?xml version="1.0" encoding="utf-8"?>
<DARoot ObjId ="1" Type="CAERep" Ver="2">
<Attributes ObjId="2" Type="CAERepBase" Ver="2">
<DAAttribute ObjId="10" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Row Number</AttributeName>
<AttributeType PropType="string">Int</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">1,50</Validation>
<Default PropType="string">1</Default>
<DisplayUnits PropType="string">No Units</DisplayUnits>
</DAAttribute>
<DAAttribute ObjId="11" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Expression</AttributeName>
<AttributeType PropType="string">Text</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">20</Validation>

Release 2020 R1 - © ANSYS, Inc.


1613
Using Design Assessment

<Default PropType="string">SX</Default>
<DisplayUnits PropType="string">No Units</DisplayUnits>
</DAAttribute>
<DAAttribute ObjId="12" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Number of Substeps</AttributeName>
<AttributeType PropType="string">Int</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">1,1000</Validation>
<Default PropType="string">1</Default>
<DisplayUnits PropType="string">No Units</DisplayUnits>
</DAAttribute>
<DAAttribute ObjId="13" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Units</AttributeName>
<AttributeType PropType="string">DropDown</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">No Units,Stress,Distance,Strain,Force,Moment,Rotation,
Angular Acceleration,Angular Velocity,Velocity,Acceleration,Temperature,Pressure,Voltage,
Energy,Volume,Area,Current,Heat Rate,Current Density,Power,Heat Generation,Magnetic Flux
</Validation>
</DAAttribute>
</Attributes>
<DAScripts ObjId="4" Type="DAScripts" Ver="2">
<Solve PropType="string">%DAUSERFILES%\loadsteps_S.py</Solve>
<Evaluate PropType="string">%DAUSERFILES%\loadsteps.py</Evaluate>
<DAData PropType="int">1</DAData>
<CombResults PropType="int">1</CombResults>
</DAScripts>
<Results ObjId="5" Type="CAERepBase" Ver="2">
<DAResult ObjId ="120002" Type="DAResult" Ver="2">
<GroupType PropType="string">Load Steps</GroupType>
<GroupSubtype PropType="string">Single</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">10,11,12,13</AttributeIDs>
</DAResult>
</Results>
</DARoot>

Creating the Script to be Run on Evaluate


The below code snippet shows it looping though the creation of a number of these sets, then setting
the ResultTimeFrequency value for it to use for each result set in the display.
while substepvalue <= EndTime:

#Create a DA Result set for each substep


NewResultData = DAResult.CreateDAResultSet(UpstreamResult.DisplayStyle,"Nodal")

#Set the substep value


NewResultData.SubstepValue = substepvalue

#Set the Solution result to obtain results at this time


UpstreamResult.ResultTimeFrequency = NewResultData.SubstepValue

#Loop over elements


for Element in DesignAssessment.MeshData.Elements():
ElementID = Element.Id
#Loop over nodes
for Node in Element.Nodes():
NodeID = Node.Id
#Set the value for each Node in the Values Dictionary
ValueDict[NodeID] = UpstreamResult.NodalValues(NodeID)[0]

#Loop over Nodes in the mesh


for Node in DesignAssessment.MeshData.Nodes():
NodeID = Node.Id
#Set the value at the node to be the value set for that node in the Values Dictionary
NewResultData.SetNodalValue(NodeID, 1, ValueDict[NodeID])

#increment substep value


substepvalue += increment

Release 2020 R1 - © ANSYS, Inc.


1614
Examples of Design Assessment Usage

Using Design Assessment to Perform an Explicit-to-Implicit Sequential Ana-


lysis
The purpose of this example is to illustrate how Design Assessment can be used to write Mechanical
APDL commands to perform an explicit-to-implicit sequential analysis. Relevant data is obtained from
the Explicit Dynamics analysis, and Design Assessment then writes Mechanical APDL commands to a
file for execution in the implicit analysis within Workbench.

Note

This method is currently limited to cases where there is no change in mesh topology between
the start of both the explicit and implicit analyses.

Creating the XML Definition File


An XML file is needed to specify the script that will read the explicit results, initialize the implicit model
using those results, then view the implicit results using the Mechanical APDL post processor.
<?xml version="1.0" encoding="utf-8"?>
<DARoot ObjId ="1" Type="CAERep" Ver="2">
<Attributes ObjId="2" Type="CAERepBase" Ver="2">
<DAAttribute ObjId="11" Type="DAAttribute" Ver="2">
<AttributeName PropType="string">Expression</AttributeName>
<AttributeType PropType="string">Text</AttributeType>
<Application PropType="string">All</Application>
<Validation PropType="vector&lt;string>">20</Validation>
<Default PropType="string">SX</Default>
<DisplayUnits PropType="string">No Units</DisplayUnits>
</DAAttribute>
</Attributes>
<DAScripts ObjId="4" Type="DAScripts" Ver="2">
<Solve PropType="string">%DAUSERFILES%\Solve.py</Solve>
<Evaluate PropType="string">%DAUSERFILES%\Evaluate.py</Evaluate>
<DAData PropType="int">1</DAData>
<CombResults PropType="int">1</CombResults>
</DAScripts>
<Results ObjId="5" Type="CAERepBase" Ver="2">
<DAResult ObjId="120002" Type="DAResult" Ver="2">
<GroupType PropType="string">Explicit</GroupType>
<GroupSubtype PropType="string">Explicit</GroupSubtype>
<AttributeIDs PropType="vector&lt;unsigned int>">11</AttributeIDs>
</DAResult>
</Results>
</DARoot>

Creating the Solve Script


The main stages involved in the process for Solids are:

1. Enter the pre-processor /prep7

2. Initialize model with deformations from end of the explicit analysis

3. Specify reduced element integration

4. Enter solution processor

5. Initialize implicit model with stresses from end of the explicit analysis

6. Initialize implicit model with plastic strains from end of the explicit analysis

Release 2020 R1 - © ANSYS, Inc.


1615
Using Design Assessment

The first thing to consider is the deformation at the end of the explicit analysis. Deformation is a nodal
result and thus deformation components are obtained at every node.
UpstreamSolution = DesignAssessment.SolutionSelections()[0].SolutionByRow(1)
UpstreamResult1 = UpstreamSolution.CreateSolutionResult("","UVECTORS","Distance")

#write "Text" to solver output file"


DesignAssessment.Helper.AppendToSolverOutputFile(Text)
for Node in DesignAssessment.MeshData.Nodes():
NodeID = Node.Id

#set variables to components of deformation vector result


U1 = UpstreamResult1.NodalValues(NodeID)[0]
U2 = UpstreamResult1.NodalValues(NodeID)[1]
U3 = UpstreamResult1.NodalValues(NodeID)[2]
print str(NodeID) + ": " +str(U3)

#write commands to redefine node locations


Text = "*GET, X_CO, NODE, " + str(NodeID) +", LOC, X,\n\
*GET, Y_CO, NODE, " + str(NodeID) + ", LOC, Y,\n\
*GET, Z_CO, NODE, " + str(NodeID) + ", LOC, Z,\n\
N, "+str(NodeID) + ", X_CO + ("+ str(U1) +"), Y_CO + (" + str(U2) + "), Z_CO + (" + str(U3)+")\n"

DesignAssessment.Helper.AppendToSolverOutputFile(Text)

DesignAssessment.Helper.AppendToSolverOutputFile(Text) writes whatever is stored in the variable


Text to the Solver Output File of the Design Assessment system.

The Mechanical APDL commands then are written in the following format:
*GET, X_CO, NODE, 1, LOC, X,
*GET, Y_CO, NODE, 1, LOC, Y,
*GET, Z_CO, NODE, 1, LOC, Z,
N, 1, X_CO + (0.0159664358944), Y_CO + (-0.478581756353), Z_CO + (4.01744182454e-05)

*GET, X_CO, NODE, 2, LOC, X,


*GET, Y_CO, NODE, 2, LOC, Y,
*GET, Z_CO, NODE, 2, LOC, Z,
N, 2, X_CO + (0.0159850046039), Y_CO + (-0.478512704372), Z_CO + (2.13666535274e-05)

*GET, X_CO, NODE, 3, LOC, X,


*GET, Y_CO, NODE, 3, LOC, Y,
*GET, Z_CO, NODE, 3, LOC, Z,
N, 3, X_CO + (0.0159850046039), Y_CO + (-0.478512704372), Z_CO + (-2.13666735362e-05)

These commands obtain the original location of the nodes from the mesh of the implicit analysis, add
the deformation of those nodes from the end of the explicit analysis, and redefine the position of the
nodes to the new location. Refer to the Mechanical APDL Command Reference for more information on
the specific Mechanical APDL commands.

It is now necessary to write Mechanical APDL commands to initialize the model with the stresses and
plastic strains from the end of the explicit analysis. The Mechanical APDL command used for this is
INISTATE.

Solution results are created for each of the results that are of interest. The integration method is set to
unaveraged because the result for the element is required, as opposed to the result at the node. Using
an unaveraged integration method means that all of the nodes on one element have the same value.
It is therefore only necessary to get the value at one of the nodes. Element.Nodes()[0].Id gets the Node
ID of the first node in the array of nodes for the current element. The results are then obtained for this
node.
#stress components
SX = UpstreamSolution.CreateSolutionResult("","SX","No Units")
SY = UpstreamSolution.CreateSolutionResult("","SY","No Units")
SZ = UpstreamSolution.CreateSolutionResult("","SZ","No Units")

Release 2020 R1 - © ANSYS, Inc.


1616
Examples of Design Assessment Usage

SXY = UpstreamSolution.CreateSolutionResult("","SXY","No Units")


SYZ = UpstreamSolution.CreateSolutionResult("","SYZ","No Units")
SXZ = UpstreamSolution.CreateSolutionResult("","SXZ","No Units")

#specify unaveraged integration method


SX.IntegrationMethod = ("unaveraged")
SY.IntegrationMethod = ("unaveraged")
SZ.IntegrationMethod = ("unaveraged")
SXY.IntegrationMethod = ("unaveraged")
SYZ.IntegrationMethod = ("unaveraged")
SXZ.IntegrationMethod = ("unaveraged")

for Element in DesignAssessment.MeshData.Elements():

#get ID of first node in element


FirstNodeId = Element.Nodes()[0].Id

#write commands to initialize stress


Text = "INISTATE, SET, DTYP, STRESS\nINISTATE, DEFINE, " + str(Element.Id) + \
", all,all,all, "
+ str(SX.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(SY.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(SZ.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(SXY.ElementNodalValues(Element.Id, FirstNodeId)[0])+ ", " \
+ str(SYZ.ElementNodalValues(Element.Id, FirstNodeId)[0])+ ", " \
+ str(SXZ.ElementNodalValues(Element.Id, FirstNodeId)[0])
DesignAssessment.Helper.AppendToSolverOutputFile(Text)

This generates Mechanical APDL commands as follows:


INISTATE, SET, DTYP, STRESS
INISTATE, DEFINE, 1, all,all,all,77669520.0,-108961984.0,8667132.0,-127329504.0,40947276.0,-21408484.0
INISTATE, SET, DTYP, STRESS
INISTATE, DEFINE, 2, all,all,all,73086624.0,-54661364.0, 2108868.5,-50930028.0,-2542906.5,-13913089.0
INISTATE, SET, DTYP, STRESS
INISTATE, DEFINE, 3, all,all,all, 57340700.0, -85816616.0, -16383176.0, -96323688.0, 0.0, 0.0

For shells, the layers and integration points within layers have to also be considered. These are also
defined as parameters of the INISTATE command. In the Design Assessment script, you must specify
which integration point within the layer to obtain results for. This is done as follows:
SX.ShellFaceResultDisplay = "Top"
SY.ShellFaceResultDisplay = "Top"
SZ.ShellFaceResultDisplay = "Top"
SXY.ShellFaceResultDisplay = "Top"
SYZ.ShellFaceResultDisplay = "Top"
SXZ.ShellFaceResultDisplay = "Top"
for Element in DesignAssessment.MeshData.Elements():

FirstNodeId = Element.Nodes()[0].Id
Text = "INISTATE, SET, DTYP, STRESS\nINISTATE, DEFINE, " + str(Element.Id) + ", all,all,3, " \
+ str(SX.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(SY.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(SZ.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(SXY.ElementNodalValues(Element.Id, FirstNodeId)[0])+ ", " \
+ str(SYZ.ElementNodalValues(Element.Id, FirstNodeId)[0])+ ", " \
+ str(SXZ.ElementNodalValues(Element.Id, FirstNodeId)[0])
DesignAssessment.Helper.AppendToSolverOutputFile(Text)

This obtains results from the explicit analysis on the top surface of the layer. When writing the Mechan-
ical APDL commands, the layers are counted from the bottom, so here we specify layer 3 as we are
defining the values for the top layer.

The same thing is done for plastic strain and accumulated equivalent plastic strain. The full Solve script
for Solids is included as a reference below:
def RunDA():

UpstreamSolution = DesignAssessment.SolutionSelections()[0].SolutionByRow(1)

Release 2020 R1 - © ANSYS, Inc.


1617
Using Design Assessment

UpstreamResult1 = UpstreamSolution.CreateSolutionResult("","UVECTORS","Distance")

#enter pre-processor
Text = "/prep7\n"

#write "Text" to solver output file"


DesignAssessment.Helper.AppendToSolverOutputFile(Text)
for Node in DesignAssessment.MeshData.Nodes():
NodeID = Node.Id

#set variables to components of deformation vector result


U1 = UpstreamResult1.NodalValues(NodeID)[0]
U2 = UpstreamResult1.NodalValues(NodeID)[1]
U3 = UpstreamResult1.NodalValues(NodeID)[2]
print str(NodeID) + ": " +str(U3)

#write commands to redefine node locations


Text = "*GET, X_CO, NODE, " + str(NodeID) +", LOC, X,\n\
*GET, Y_CO, NODE, " + str(NodeID) + ", LOC, Y,\n\
*GET, Z_CO, NODE, " + str(NodeID) + ", LOC, Z,\n\
N, "+str(NodeID) + ", X_CO + ("+ str(U1) +"), Y_CO + (" + str(U2) + "), Z_CO + (" + str(U3)+")\n"

DesignAssessment.Helper.AppendToSolverOutputFile(Text)

#stress components
SX = UpstreamSolution.CreateSolutionResult("","SX","No Units")
SY = UpstreamSolution.CreateSolutionResult("","SY","No Units")
SZ = UpstreamSolution.CreateSolutionResult("","SZ","No Units")
SXY = UpstreamSolution.CreateSolutionResult("","SXY","No Units")
SYZ = UpstreamSolution.CreateSolutionResult("","SYZ","No Units")
SXZ = UpstreamSolution.CreateSolutionResult("","SXZ","No Units")

#specify unaveraged integration method


SX.IntegrationMethod = ("unaveraged")
SY.IntegrationMethod = ("unaveraged")
SZ.IntegrationMethod = ("unaveraged")
SXY.IntegrationMethod = ("unaveraged")
SYZ.IntegrationMethod = ("unaveraged")
SXZ.IntegrationMethod = ("unaveraged")

#plastic strain components


EPPLX = UpstreamSolution.CreateSolutionResult("","EPPLX","No Units")
EPPLY = UpstreamSolution.CreateSolutionResult("","EPPLY","No Units")
EPPLZ = UpstreamSolution.CreateSolutionResult("","EPPLZ","No Units")
EPPLXY = UpstreamSolution.CreateSolutionResult("","EPPLXY","No Units")
EPPLYZ = UpstreamSolution.CreateSolutionResult("","EPPLYZ","No Units")
EPPLXZ = UpstreamSolution.CreateSolutionResult("","EPPLXZ","No Units")

EPPLX.IntegrationMethod = ("unaveraged")
EPPLY.IntegrationMethod = ("unaveraged")
EPPLZ.IntegrationMethod = ("unaveraged")
EPPLXY.IntegrationMethod = ("unaveraged")
EPPLYZ.IntegrationMethod = ("unaveraged")
EPPLXZ.IntegrationMethod = ("unaveraged")

#accumulated equivalent plastic strain


EFF_PL_STNALL = UpstreamSolution.CreateSolutionResult("","EFF_PL_STNALL","No Units")

EFF_PL_STNALL.IntegrationMethod = ("unaveraged")

#specify reduced integration formulation for SOLID185


Text = " \n\n\net,1,185,,1\n/solu"
DesignAssessment.Helper.AppendToSolverOutputFile(Text)

for Element in DesignAssessment.MeshData.Elements():

#get ID of first node in element


FirstNodeId = Element.Nodes()[0].Id

#write commands to initialise stress

Release 2020 R1 - © ANSYS, Inc.


1618
Examples of Design Assessment Usage

Text = "INISTATE, SET, DTYP, STRESS\nINISTATE, DEFINE, " + str(Element.Id) + ", all,all,all, " \
+ str(SX.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(SY.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(SZ.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(SXY.ElementNodalValues(Element.Id, FirstNodeId)[0])+ ", " \
+ str(SYZ.ElementNodalValues(Element.Id, FirstNodeId)[0])+ ", " \
+ str(SXZ.ElementNodalValues(Element.Id, FirstNodeId)[0])
DesignAssessment.Helper.AppendToSolverOutputFile(Text)

for Element in DesignAssessment.MeshData.Elements():


FirstNodeId = Element.Nodes()[0].Id

#write commands to initialize plastic strain


Text2 = "INISTATE, SET, DTYP, EPPL\nINISTATE, DEFINE, "+ str(Element.Id) + ", all,all,all, "\
+ str(EPPLX.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(EPPLY.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(EPPLZ.ElementNodalValues(Element.Id, FirstNodeId)[0]) + ", " \
+ str(EPPLXY.ElementNodalValues(Element.Id, FirstNodeId)[0])+ ", " \
+ str(EPPLYZ.ElementNodalValues(Element.Id, FirstNodeId)[0])+ ", " \
+ str(EPPLXZ.ElementNodalValues(Element.Id, FirstNodeId)[0])
DesignAssessment.Helper.AppendToSolverOutputFile(Text2)

for Element in DesignAssessment.MeshData.Elements():


FirstNodeId = Element.Nodes()[0].Id

#write commands to initialize accumulated equivalent plastic strain


Text2 = "INISTATE, SET, DTYP, PLEQ\nINISTATE, DEFINE, "+ str(Element.Id) + ", all,all,all, "\
+ str(EFF_PL_STNALL.ElementNodalValues(Element.Id, FirstNodeId)[0])

DesignAssessment.Helper.AppendToSolverOutputFile(Text2)

Text = "solve"

RunDA()

Release 2020 R1 - © ANSYS, Inc.


1619
Release 2020 R1 - © ANSYS, Inc.
1620
Productivity Tools
The Mechanical application includes several features designed to help you create, navigate, and manage
data in complex databases where a large number of objects are present. These features include tags,
tree filtering, and the object generator.

This section examines the following topics:

• Generating Multiple Objects from a Template Object (p. 1621)

• Tagging Objects (p. 1626)

• Filtering the Tree (p. 14)

Generating Multiple Objects from a Template Object


You can use the Object Generator to make one or more copies of a template object, scoping each to
a different piece of geometry. Almost any tree object that supports the “Duplicate” function can be
used as a template.

To use the Object Generator, you define a tree object to be copied, select the geometry to which it
should be copied, and generate from the Object Generator. The original tree object is copied to all of
the selected geometry, with all details from the original object maintained. You have the option of
adding a common prefix and/or tag to the name of all generated objects.

• If your object must be scoped to more than one geometry set, you have a choice for how that scoping
is handled.

• For objects with locations, such as remote points, you can choose to move the location to the centroid
of the new geometry, or leave the location unchanged.

• If the geometry from the template object is part of the target geometry selection set, you can choose
to ignore or include it.

• For any connections requiring two sets of geometry, you specify one named selection for each side of
the connection. The Object Generator will then generate a connection between any geometry on each
side which falls within a specified distance.

• Since end releases require a vertex and an edge, you can specify named selections for the vertices and
edges. The Object Generator will then generate an end release for every specified vertex with an edge
in the specified set of edges.

• Parameterized properties do not retain their parameterization in the generated objects.

Example 9: Generating Clamping Bolts

For example, you have two retaining collars with one clamping bolt defined.

Release 2020 R1 - © ANSYS, Inc.


1621
Productivity Tools

You can use the object generator to generate the other bolt connections.

Generating an Object
To use the Object Generator:

1. In the standard toolbar, click the View Object Generator button to view the Object Generator window.

Release 2020 R1 - © ANSYS, Inc.


1622
Generating Multiple Objects from a Template Object

2. In the Tree Outline, select the tree object to be copied. Define any details you want included in the
generated objects.

3. In the Geometry window, select the geometry to which the tree object should be copied in the Object
Generator window.

4. In the Object Generator window, select any required options.

The options vary, depending on the selected object. Possible options are:

Option Name Shown for Object Description


Type
Scope to • General When multiple geometry items are selected,
objects you have several options for scoping the new
supporting object.
one geometry
selection • Each Entity: Scope one new object to
each geometric entity selected.
• Connection
objects • Adjacent Entities: Scope one object to
all groups of adjacent selected entities.
This is the default.

• All Entities by Part: Scope one new


object to all selected geometric entities
on each part.

Note

If none of the selected


topologies are adjacent, then
both options will work in a
similar manner.

Ignore Original All If the geometry for the original object is part
of the target selection set, this option directs
the Object Generator to ignore the original and
scope new objects only onto geometry not
scoped to the original object. This option is
selected by default.

If you clear this option, the Object


Generator copies new objects to all
specified geometry, including that of the
original, if selected. Note that this may
result in duplicate objects.
Name Prefix All If you want all generated objects to have a
common name prefix, enter the desired prefix
in the Name Prefix field.
Apply Tag All If you want to apply a label to all generated
objects, enter a tag name in the Apply Tag

Release 2020 R1 - © ANSYS, Inc.


1623
Productivity Tools

Option Name Shown for Object Description


Type
field. Tags can be used to filter your tree. For
more information on tags, see Tagging
Objects (p. 1626).
Relocate When relocation For objects with locations, such as remote
is possible, points, you have an option for how to handle
applies to: the location of the generated objects.

• General objects • Yes: For generated objects, the remote point


supporting one will be the centroid of the new geometry.
geometry selection This is the default.

• Connection objects • No: Leave the location of the remote point


as is when generating the new objects.

Generate from If named Select whether to use the geometric entities


selections are selected in the Geometry window (Current
defined, applies Selection) or a named selection.
to general
objects
supporting one
geometry
selection
Reference Springs Select the named selection to use as the
Reference side of the connection. You specify
the other side using the Mobile option, then
specify the lower and upper boundaries of the
distance between sides to generate
connections.
Mobile Springs Select the named selection to use as the
Mobile side of the connection. You specify the
other side using the Reference option, then
specify the lower and upper boundaries of the
distance between sides to generate
connections.
Master Mesh connections Select the named selection to use as the Master
side of the connection. You specify the other
side using the Slave option, then specify the
lower and upper boundaries of the distance
between sides to generate connections.
Slave Mesh connections Select the named selection to use as the Slave
side of the connection. You specify the other
side using the Master option, then specify the
lower and upper boundaries of the distance
between sides to generate connections.
Contact Contacts Select the named selection to use as the
contact side of the connection. You specify the
other side using the Target option, then
specify the lower and upper boundaries of the

Release 2020 R1 - © ANSYS, Inc.


1624
Generating Multiple Objects from a Template Object

Option Name Shown for Object Description


Type
distance between sides to generate
connections.
Target Contacts Select the named selection to use as the target
side of the connection. You specify the other
side using the Contact option, then specify
the lower and upper boundaries of the distance
between sides to generate connections.
Minimum Connection objects For connections, specify the lower boundary.
The Object Generator will generate a
connection between any geometry on each
side which falls within the specified distance.
The distance is defined as the distance
between the centroid of one geometric
selection and the centroid of another
geometric selection.
Maximum Connection objects For connections, specify the upper boundary.
The Object Generator will generate a
connection between any geometry on each
side which falls within the specified distance.
The distance is defined as the distance
between the centroid of one geometric
selection and the centroid of another
geometric selection.
Edges End releases For end releases, select a named selection that
encompasses edges for which you want to
generate objects. The Object Generator will
generate an end release for every specified
vertex specified in Vertices if it has an edge
in the specified set of edges.
Vertices End releases For end releases, select a named selection that
encompasses vertices for which you want to
generate objects. The Object Generator will
generate an end release for every specified
vertex if it has an edge in the specified set of
edges specified in Edges.
Source Mesh method control Select the named selection to use as the
Source. Source appears in the Object Generator
window for the Sweep and MultiZone mesh
methods only. Specifying a Source is optional.
You specify the target using the Target option.
Target Mesh method control Select the named selection to use as the
Target. Target appears in the Object Generator
window for the Sweep mesh method only.
Specifying a Target is optional. You specify the
source using the Source option.
High Mesh match control Select the named selection to use as the high
side of the match control. You specify the other

Release 2020 R1 - © ANSYS, Inc.


1625
Productivity Tools

Option Name Shown for Object Description


Type
side using the Low option. The Object
Generator will not assign a coordinate system.
You must assign a coordinate system manually.
Low Mesh match control Select the named selection to use as the low
side of the match control. You specify the other
side using the High option. The Object
Generator will not assign a coordinate system.
You must assign a coordinate system manually.
Boundary Mesh inflation control Select the named selection to use as the
inflation boundary.

5. Click Generate to copy the selected tree object to the selected geometry.

Tagging Objects
For complex models, it may be difficult to keep track of all of the objects in your tree. With tags, you
can mark objects in the tree with meaningful labels, which can then be used to filter the tree. For more
information on filtering, see Filtering the Tree (p. 14).

Tags are managed through the Tags window. To view this window, click the Tags button in the
Graphics toolbar.

This section covers the following:


Creating Tags
Applying Tags to Objects
Deleting a Tag
Renaming a Tag
Highlighting Tagged Tree Objects

Creating Tags
To create a tag and apply it to the currently-selected tree object:

1. In the Tree Outline, select an object.

2. In the Tags window, click the Add a Tag icon.

The Add New Tag window appears.

3. Enter a name for the tag and click OK.

The tag is listed in the Tags window. The check box is selected to indicate that it applies to the
selected object in the tree.

Applying Tags to Objects


Once you have created tags, you can apply those tags to other objects in the tree.

To apply a tag to a tree object:

Release 2020 R1 - © ANSYS, Inc.


1626
Tagging Objects

1. In the Tree Outline, select an object.

2. In the Tags window, select the check box for all tags you want to add to that object.

You can now use these tags to filter the tree. For more information on filtering the tree, see Filtering
the Tree (p. 14).

Deleting a Tag
To remove a tag:

1. In the Tags window, select one or more tags.

2. Click the Delete Tag(s) icon, or right-click the Tags window and select Delete Tag(s).

Renaming a Tag
To rename a tag:

1. In the Tags window, select a tag.

2. Click the Rename Tag icon.

The Rename Tag window appears.

3. Enter a name for the tag and click OK.

The new tag name is listed in the Tags window.

Highlighting Tagged Tree Objects


Once a tag is applied to objects in the Tree Outline, you can highlight all of the objects with a selected
tag.

You can search for objects that apply to one or more tags. When you select multiple tags, you have
several options. You can search for objects that contain any of the selected tags, or you can search for
objects that contain all of the selected tags.

To highlight objects:

1. In the Tags window, select one or more tags

2. Right-click the Tags window and select one of the following options:

• Find items with selected tag: Available when only one tag is selected, this option highlights all tree
objects with the selected tag.

• Find items with all selected tags: Available when multiple tags are selected, this option highlights all
items that contain every one of the selected tags.

• Find items with any selected tags: Available when multiple tags are selected, this option highlights
all items that contain one of the selected tags.

Tree objects matching the selected number of tags are highlighted.

Release 2020 R1 - © ANSYS, Inc.


1627
Release 2020 R1 - © ANSYS, Inc.
1628
Mechanical Objects Reference
Welcome to the Mechanical Objects Reference. This reference provides a specification for every Mech-
anical object in the tree. Each object is represented in either its own reference page, or is combined
with similar objects and represented on one group reference page. For example, the Joint object is
represented on its own Joint object reference page (p. 1744), whereas the Acceleration object is repres-
ented on the Loads and Supports (Group) object reference page (p. 1746). All pages representing groups
of objects include "(Group)” as part of the page's title.

Note

Certain types of objects do not appear in the tree but are still represented on their own
pages in this reference. These include Virtual Cell (p. 1844) objects, Virtual Hard Vertex (p. 1845)
objects, Virtual Split Edge (p. 1845) objects, and Virtual Split Face (p. 1846) objects. When
these types of objects are created, they are saved in the database and have editable properties
similar to other objects. For details, refer to the individual reference pages for these objects.

A complete alphabetical listing of Mechanical objects reference pages (p. 1630) is included below. To
determine the reference page for an object in a group, consult the group page whose title matches
the object, and check the entry: “Applies to the following objects”.

The following is a description of each component of a Mechanical object reference page:

• Title: For individual object reference pages, the title is the default name of the object as it appears in the
tree. For group reference pages, the title is a name given to the collection of objects represented.

• Object definition: A brief description of the individual object or group of objects.

• Applies to the following objects: Appears only on group reference pages and includes the default name
of all objects represented on the group reference page.

• Tree dependencies: The valid location of the object or group of objects in the tree (Valid Parent Tree
Object), as well as other possible objects that you can insert beneath the object or group of objects (Valid
Child Tree Objects).

• Insertion options: Procedure for inserting the object (individual or one in the group) in the tree. Typically
this procedure includes inserting the object from a context toolbar (p. 77) button or through a context
menu option when you click the right mouse button with the cursor on the object.

• Additional related information: a listing of topics related to the object or object group that are in the help.
Included are links to those topics.

• Tree location graphic: an indication of where the object or group of objects appears in the tree.

• Object Properties: a listing of every setting or indication available in the Details view (located directly beneath
the object tree) for the object. Included are links to more detailed information on an item within the help.

Release 2020 R1 - © ANSYS, Inc.


1629
Objects Reference

• Relevant right mouse button context menu options: a listing of options directly relevant to the objects
that are available in the context menu by right-clicking the object. Included are links to more detailed in-
formation on an item within the help. The options listed are in addition to options that are common to most
of the objects (such as Solve, Copy, Cut, Duplicate, and Delete).

The objects reference is not intended to be your primary source of procedural information for performing
simulations -- see the Steps for Using the Mechanical Application section for introductory and proced-
ural guidelines concerning when and where to use Mechanical objects.

Page Listings
The following is an alphabetical listing of object reference pages:
Alert
Analysis Ply
Analysis Settings
Angular Velocity
Arbitrary Crack
Beam
Beam Tool (Group)
Bearing
Body
Body Interactions
Body Interaction
Bolt Tool (Group)
Chart
Commands
Comment
Composite Failure Criteria Definitions
Composite Failure Tool (Group)
Condensed Geometry
Condensed Part
Connections
Connection Group
Construction Geometry
Contact Debonding
Contact Region
Contact Tool (Group)
Convergence
Coordinate System
Coordinate Systems
Cross Sections
Cross Section Objects
Distributed Mass
Direct FE (Group)
Drop Height
Element Orientation
End Release
Environment (Group)
Expansion Settings
Fatigue Tool (Group)
Figure
Fluid Surface
Fracture

Release 2020 R1 - © ANSYS, Inc.


1630
Fracture Tool (Group)
Gasket Mesh Control
Geometry
Global Coordinate System
Image
Imported: Constraint Equations or Coupling
Imported: Contacts
Imported: Coordinate Systems
Imported: Element Orientations
Imported: Flexible Remote Connectors
Imported: Nodal Orientations
Imported: Point Masses
Imported: Rigid Remote Connectors
Imported: Shell Thicknesses
Imported: Spring Connectors
Imported Plies
Imported Load (Group)
Imported Material Fields (Group)
Imported Material Field
Imported Remote Loads
Imported Thickness
Imported Thickness (Group)
Imported Trace (Group)
Imported Trace
Initial Conditions
Initial Temperature
Interface Delamination
Joint
Layered Section
Loads, Supports, and Conditions (Group)
Manufacturing Constraint
Mesh
Mesh Connection Group/Contact Match Group
Mesh Connection/Contact Match
Mesh Control Tools (Group)
Mesh Edit
Mesh Group (Group)
Mesh Grouping
Mesh Numbering
Modal
Model
Named Selections
Node Merge Group
Node Merge
Node Move
Numbering Control
Objective
Optimization Region
Part
Path
Periodic/Cyclic Region/Pre-Meshed Cyclic Region
Physics Region

Release 2020 R1 - © ANSYS, Inc.


1631
Objects Reference

Point Mass
Pre-Meshed Crack
Pre-Stress
Probe
Project
Remote Point
Remote Points
Response Constraint
Response PSD Tool (Group)
Result Tracker
Results and Result Tools (Group)
Semi-Elliptical Crack
Solid
Solution
Solution Combination
Solution Information
Spot Weld
Spring
Stress Tool (Group)
Surface
Surface Coating
Symmetry
Symmetry Region
Thermal Point Mass
Thickness
Topology Result Plot Trackers
Validation
Velocity
Virtual Body
Virtual Body Group
Virtual Cell
Virtual Hard Vertex
Virtual Split Edge
Virtual Split Face
Virtual Topology

Alert
Sets pass or fail thresholds for individual results. When a threshold is exceeded, the status symbol (p. 9)
changes in front of the associated result object (p. 1804). The status is also displayed in the Details view
of the Alert object. Alerts facilitate the presentation of comparisons in automatic reports (p. 31).

Tree Dependencies:

• Valid Parent Tree Objects: All result


objects (p. 1804) (independent, or under result tools),
except Damage Matrix (p. 1338), Fatigue Sensitiv-
ity (p. 1339), Hysteresis (p. 1340), Phase Re-
sponse (p. 211), Probe (p. 1175), Rainflow Mat-
rix (p. 1338), Reactions (p. 1290), Status (p. 1243), Vec-
tor Principal Elastic Strain (p. 1232), Vector Princip-
al Stress (p. 1232).

Release 2020 R1 - © ANSYS, Inc.


1632
Analysis Ply

• Valid Child Tree Objects: Comment (p. 1654)

Insertion Options: Click right mouse button on


a result object (p. 1804) or in the Geometry
window after you select the result object, and
then> Insert> Alert.

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties/Options
Defini- Fails If - Set failure threshold as Minimum Below Value or Maximum Above
tion Value, where you set the value in the next field.
Value - Threshold value in the units of the associated result.
Results Status - Read-only indication of the pass/fail status; also includes criterion (for
example: “Passed: Minimum Above Value”).

Analysis Ply
The analysis ply object provides ply data that has been made available from an external system upstream
of the analysis system.

Tree Dependencies:

• Valid Parent Tree Objects: Imported


Plies

• Valid Child Tree Object: Com-


ment (p. 1654), Image (p. 1706), and Fig-
ure (p. 1697)

Insertion Method:

• Appears automatically when


importing ply data from an
external system.

Additional Related Information:

• Specifying Surface Body Layered


Sections (p. 494)

• Composite Analysis (p. 466)

• Composite Analysis Result


Scoping (p. 1214)

• Composite Failure Tool (p. 1265)

• Imported Plies (p. 1723)

Release 2020 R1 - © ANSYS, Inc.


1633
Objects Reference

The following right mouse button context menu options are available for this object.

• Insert for Environment (p. 1214)

• Create Ply Named Selection: this option creates a Worksheet-based Named Selection (p. 587) for the
selected ply object.

• Group (p. 100)

• Remove from Group

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Definition Name in Source: the name of the ply as defined in the upstream
ACP analysis.

Thickness: the thickness of the selected ply.

Angle: the design angle between the reference direction and the
ply fiber direction.

Material: the specified material of the fabric.

Number of Elements: the number of elements contained within the


ply.
Transfer Properties Source: the source ACP system.

Analysis Settings
Allows you to define various solution settings that are customized to specific analysis types.

Tree Dependencies:

• Valid Parent Tree Object: Any environment (p. 1690) object.

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options: Appears by default when you create an analysis


system (p. 173).

Additional Related Information:

• Establish Analysis Settings (p. 183)

• Configuring Analysis Settings (p. 873)

Object Properties
For more information on this object's properties, see the Analysis Settings for Most Analysis Types (p. 873)
section.

Release 2020 R1 - © ANSYS, Inc.


1634
Angular Velocity

Angular Velocity
Applies angular velocity as an initial condition for use in an explicit dynamics analysis.

Note

• For explicit dynamics analyses, the center of rotation for an angular velocity is defined by the
origin of the coordinate system associated with the angular velocity.

• Angular Velocity initial conditions are not supported for 2D axisymmetric Explicit Dynamics
analyses.

Tree Dependencies:

• Valid Parent Tree Object: Initial Conditions (p. 1740)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting Initial Condi-
tions (p. 1740) object:

• Click Angular Velocity button on Initial Conditions


context toolbar.

• Click right mouse button on Initial Conditions (p. 1740)


object or in the Geometry window>Insert>Angular
Velocity.

Additional Related Information:

• Define Initial Conditions (p. 186)

• Explicit Dynamics Analysis

Object Properties
The Details view properties for this object include the following.

Category Properties/Options
Scope Scoping Method

Geometry– appears if Scoping Method is set to Geometry


Selection. In this case, use selection filters (p. 126) to pick
geometry (p. 125), click in the Geometry field, then click
Apply.

Named Selection – appears if Scoping Method is set to


Named Selection.

Release 2020 R1 - © ANSYS, Inc.


1635
Objects Reference

Category Properties/Options
Definition Input Type - choose Angular Velocity, Drop Height, or
Velocity.

Define By

Total - magnitude; appears if Define By is set to Vector.

Direction (p. 149)- appears if Define By is set to Vector.

Coordinate System – available list; appears if Define By is


set to Components.

X, Y, Z Component – values; appears if Define By is set to


Components.

Suppressed (p. 13)

Arbitrary Crack
Defines a crack to analyze planar or non-planar cracks of any arbitrary shape, which already exist on
the geometry model.

Tree Dependencies:

• Valid Parent Tree Object: Fracture (p. 1699)

Insertion Options: Click right mouse button


on Fracture (p. 1699), Arbitrary Crack, Semi-
Elliptical Crack or Pre-Meshed Crack (p. 1791)
object and select Insert>Arbitrary Crack.

Additional Related Information:

• Defining an Arbitrary Crack (p. 859)

• Fracture Analysis (p. 841)

• Fracture Meshing (p. 845)

The following right mouse button context menu options are available for this object.

• Insert>Arbitrary Crack

• Insert>Semi-Elliptical Crack

• Insert>Pre-Meshed Crack

• Generate All Crack Meshes

Release 2020 R1 - © ANSYS, Inc.


1636
Arbitrary Crack

• Suppress

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Scope Source: Read-only property set to Arbitrary Crack

Scoping Method: Read-only property set to Geometry Selection.

Geometry: Use the Body selection filter to pick a solid body, click in the
Geometry field, then click Apply.
Definition Coordinate System: Specifies the user-defined coordinate system that
defines the orientation of the crack. For this user-defined coordinate system,
the Y axis must be directed towards the normal of the crack's top face and
the X axis helps to determine the crack extension direction.

Crack Shape: Read-only property set to Arbitrary.

Crack Surface: This property is used to scope the surface body to be used
as the crack surface. It can be scoped to a single surface body only.

Mesh Method: Read-only property set to Tetrahedrons.

Largest Contour Radius: Specifies the largest contour radius for the crack
shape. Enter a value greater than 0.

Growth Rate: Specifies the factor with which the mesh layers will grow
along the radius of the crack. Specify a value greater than 1. The default
value is 1.2. The recommended value is equal to or greater than 1.1.

Front Element Size: Specifies the element size for the crack front. The
default value is computed from Largest Contour Radius property and the
Growth Rate property. A value of 0 specifies the default. You can specify
an entry greater than 0.

Mesh Contours: Specifies the number of mesh contours for the crack
shape. The value must be equal to or greater than 1. The default value is
6. The Geometry window can display only a maximum of 100 mesh
contours, but you can specify a higher value and fracture meshing will
respect it.

Solution Contours: Specifies the number of mesh contours for which you
want to compute the fracture result parameters. The value must be less
than or equal to the value of the Mesh Contours property and cannot
exceed 99. By default, the value equals the Match Mesh Contours property.
This indicates the number of Solution Contours is equal to the number
of Mesh Contours. Entering 0 resets the value to equal the Match Mesh
Contours value.

Release 2020 R1 - © ANSYS, Inc.


1637
Objects Reference

Category Properties
Suppressed: Toggles suppression of the Arbitrary Crack object. The default
is No. The Arbitrary Crack object is suppressed automatically if both the
scoped body and scoped crack surface are suppressed.
Buffer Zone Scale The Buffer Zone Scale Factors category controls the size of the buffer
Factors zone in the X, Y, and Z directions, relative to the crack surface geometry
dimensions. For each scaling parameter, use the slider to set a value from
2 to 50. The default value is 2. The maximum dimension among the three
dimensions of the crack surface geometry is multiplied by the corresponding
scale factors to create a buffer zone:

• X Scale Factor

• Y Scale Factor

• Z Scale Factor

Named Selections Named Selections are created automatically when the fracture mesh is
Creation generated. These Named Selections are a special type of Named Selection.
For details, refer to the Performing a Fracture Analysis (p. 841) and the
Special Handling of Named Selections for Crack Objects (p. 863) sections
for more information. For information about Named Selections in general,
refer to Specifying Named Selections in the Mechanical Application (p. 583).

Beam
A beam is a structural element that carries load primarily in bending.

Tree Dependencies:

• Valid Parent Tree Object: Connections (p. 1663)

• Valid Child Tree Objects: Commands (p. 1652), Comment (p. 1654), Fig-
ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Connections (p. 1663) object:

• Click Body-Ground> Beam or Body-Body> Beam, as applicable on Connec-


tions context toolbar (p. 80).

• Click right mouse button on Connections (p. 1663) object or in the Geometry
window> Insert> Beam.

Additional Related Information:

• Connections Context Toolbar (p. 80)

• Beam Connections (p. 825)

The following right mouse button context menu options are available for this object.

Release 2020 R1 - © ANSYS, Inc.


1638
Beam

• Enable/Disable Transparency (p. 725) - similar behavior to feature in Contact Region.

• Rename Based on Definition (p. 1366) - similar behavior to feature in Results.

• Promote Remote Point (p. 609) (when the Applied By property is set to Remote Attachment).

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties/Options
Graphics Visible – toggles visibility of the beam.
Properties
Definition Material: Material property defined in the Engineering Data Workspace.
Cross Section: Read-only indication.
Radius
Suppressed (p. 13)
Beam Length: This read-only property displays the actual length of the beam
that is calculated using the end points from the scoping of the Reference and
Mobile categories.
Scope (p. 822) Scope: Includes the options Body-Body or Body-Ground.
- information
on springs also
applies to
beams.
Refer- The following properties are available when the Scope property is set to Body-
ence (p. 822) - Body:
information on
springs also Scoping Method: Specify as Geometry Selection, Named Selection, or Remote
applies to Point.
beams. Applied By: Specify as Remote Attachment (default) or Direct Attachment.
The default for this property can differ if you first select geometry or a mesh
node.
Scope: Displays when the Scoping Method property is set to Geometry Selec-
tion. Once a geometry is selected, click in the Scope field and then click Apply.
Reference Component: Displays when the Scoping Method property is set to
Named Selection. This property provides a drop-down list of available
user–defined Named Selections.
Remote Points: Displays when the Scoping Method property is set to Remote
Point. This property provides a drop-down list of available user–defined Remote
Points.
Body: A read-only indication of scoped geometry. Displays
for Body-Body scoping.

The following properties display for either Body-Body or Body-Ground scoping


when the Applied By property is set to Remote Attachment.

Coordinate System
Reference X Coordinate
Reference Y Coordinate

Release 2020 R1 - © ANSYS, Inc.


1639
Objects Reference

Reference Z Coordinate
Reference Location
Behavior (p. 614): Specify the scoped geometry as either Rigid, Deformable,
or Beam.
Material: This property is available when the Behavior property is set to Beam.
Select a material to define material properties for the beams used in the
connection. Density is excluded from the material definition.
Radius: This property is available when the Behavior property is set to Beam.
Specify a radius to define the cross section dimension of the circular beam used
for the connection.
Pinball Region (p. 715)
Mobile (p. 822) The following properties are available when the Scope property is set to Body-
- information Body:
on springs also
applies to Scoping Method: Specify as Geometry Selection, Named Selection, or Remote
beams. Point.
Applied By: Specify as Remote Attachment (default) or Direct Attachment.
The default for this property can differ if you first select geometry or a mesh
node.
Scope: Displays when the Scoping Method property is set to Geometry Selec-
tion. Once a geometry is selected, click in the Scope field and then click Apply.
Reference Component: Displays when the Scoping Method property is set to
Named Selection. This property provides a drop-down list of available
user–defined Named Selections.
Remote Points: Displays when the Scoping Method property is set to Remote
Point. This property provides a drop-down list of available user–defined Remote
Points.
Body: A read-only indication of scoped geometry. Displays
for Body-Body scoping.
Behavior (p. 614): Specify the scoped geometry as either Rigid, Deformable,
or Beam.
Material: This property is available when the Behavior property is set to Beam.
Select a material to define material properties for the beams used in the
connection. Density is excluded from the material definition.
Radius: This property is available when the Behavior property is set to Beam.
Specify a radius to define the cross section dimension of the circular beam used
for the connection.
Pinball Region (p. 715)

The following properties display for either Body-Body or Body-Ground scoping


when the Applied By property is set to Remote Attachment.

Coordinate System
Mobile X Coordinate
Mobile Y Coordinate
Mobile Z Coordinate
Mobile Location

Beam Tool (Group)


The Beam Tool enables you to examine linearized stresses on beam (line) bodies.

Release 2020 R1 - © ANSYS, Inc.


1640
Beam Tool (Group)

The Beam Tool applies to the following objects: Direct Stress, Minimum Bending Stress, Maximum
Bending Stress, Minimum Combined Stress, Maximum Combined Stress as well as Total Deformation
and Directional Deformation.

Tree Dependencies:

• Valid Parent Tree Objects:

– The Solution (p. 1817) object is the only valid parent object.

• Valid Child Tree Objects The Beam Tool supports the following child
objects:

– Direct Stress

– Minimum Bending Stress

– Maximum Bending Stress

– Minimum Combined Stress

– Maximum Combined Stress

– Total Deformation

– Directional Deformation

– User Defined Results (p. 1340)

Note

For all of the above objects, except User Defined Results,


the Alert (p. 1632) object is the only valid child object.

Insertion Options:

• Select the Solution object and either:

– Select the Beam Tool option from the Tools drop-down menu on the
Solution context toolbar (p. 84).

– Right-click the Solution object or in the Geometry window and select


Insert>Beam Tool>Beam Tool.

Additional Related Information:

• Beam Tool (p. 1275)

• Line Bodies (p. 498)

The following right mouse button context menu options are available for this object.

Release 2020 R1 - © ANSYS, Inc.


1641
Objects Reference

• Evaluate All Results (p. 1212): available for Beam Tool and all child objects when the Beam Tool is inserted
under a Solution (p. 1817) object.

• Group (p. 100)

Object Properties
For more information on this object's properties, see the Beam Tool (p. 1275) section.

Bearing
A bearing is a two-dimensional elastic element used to confine relative motion and rotation of a rotating
part.

Tree Dependencies:

• Valid Parent Tree Object: Connections (p. 1663)

• Valid Child Tree Objects: Commands (p. 1652), Comment (p. 1654), Fig-
ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Connections (p. 1663) object:

• Click Body-Ground>Bearing on the Connections context toolbar (p. 80).

• Click right mouse button on Connections (p. 1663) object or in the Geometry
window and select Insert>Bearing.

Additional Related Information:

• Bearings (p. 831)

• Connections Context Toolbar (p. 80)

The following right mouse button context menu options are available for this object.

• Enable/Disable Transparency (p. 725) - similar behavior to feature in Contact Region.

• Promote to Remote Point (p. 609) (Remote Attachment Only)

• Rename Based on Definition (p. 726) - similar behavior to feature in Contact Region.

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Definition Connection Type: read-only field that describes the bearing - Body-Ground

Stiffness K11, K22 , K12, K21: entry fields.

Release 2020 R1 - © ANSYS, Inc.


1642
Bearing

Damping C11, C22 , C12, C21: entry fields.

Suppressed (p. 13)


Reference Rotation Plane: specify the desired place of rotation. Options include:

• None (default)

• X-Y Plane

• Y-Z Plane

• X-Z Plane

Mobile Scoping Method: specify as Geometry Selection, Named Selection, or Remote


Point.

Based on the selection made for the Scoping Method property of this category,
the next property is:

• Scope: appears if Scoping Method is set to Geometry Selection. Select a geometry


entity and then click Apply.

• Mobile Component: appears if Scoping Method is set to Named Selection. This


property provides a drop-down list of available user-defined Named Selections.

• Remote Points: appears if the Scoping Method is set to Remote Point. This property
provides a drop-down list of available user-defined Remote Points.

Body: read-only indication of scoped geometry.

Coordinate System: Drop-down list of available coordinate systems. Global Co-


ordinate System is the default.

The following read-only properties display the coordinates of the centroid location
for the scoped geometric entities from the origin of the coordinate system selected
in the Coordinate System property.

• Mobile X Coordinate

• Mobile Y Coordinate

• Mobile Z Coordinate

Behavior (p. 823): Rigid (default), Deformable, or Beam. If the Scope Method
property is set to Remote Point, the Bearing will then assume the Behavior defined
in the referenced Remote Point as well as other related properties.

Material: This property is available when the Behavior property is set to Beam.
Select a material to define material properties for the beams used in the connection.
Density is excluded from the material definition.

Radius: This property is available when the Behavior property is set to Beam.
Specify a radius to define the cross section dimension of the circular beam used
for the connection.

Release 2020 R1 - © ANSYS, Inc.


1643
Objects Reference

Pinball Region: the Pinball Region is a radius value (length unit) that defines a
region for selecting elements to be used by the solver for the Bearing's Mobile
scoping.

Note

The Pinball Region and Behavior settings are:

• Applicable to underlying bodies that are flexible.

• Not applicable to a bearing scoped to the vertex of line body.

Body
Defines a component of the attached geometry included under the Geometry (p. 1701) object, or under
a Part object if considered a multibody part (p. 477) (shown in the figure below).

Also see the description of the Virtual Body (p. 1841) object (applicable to assembly meshing algorithms
only).

Tree Dependencies:

• Valid Parent Tree Object: Geometry (p. 1701) or


Part (p. 1781) (if under a multibody part)

• Valid Child Tree Objects: Commands (p. 1652),


Comment (p. 1654), Figure (p. 1697), Gasket Mesh
Control (p. 1701), Image (p. 1706)

Insertion Options: Appears by default when


geometry is attached (p. 174).

Additional Related Information:

• Define Part Behavior (p. 177)

• Specifying Geometry in the Mechanical


Application (p. 477)

The following right mouse button context menu options are available for this object.

• The Insert option provides a menu of the following options.

– Element Orientation (p. 570)

– Point Mass (p. 505)

– Distributed Mass (p. 506)

– Commands (p. 1475)

Release 2020 R1 - © ANSYS, Inc.


1644
Body

• Update

• Generate Mesh

• Preview> Surface Mesh

• Preview> Inflation

• Export (p. 54)>Geometry

• Hide Body

• Hide All Other Bodies

• Suppress Body

• Suppress All Other Bodies

• Search Faces with Multiple Thicknesses (p. 497)

• Update Selected Parts>Update: Use Geometry Parameter Values (p. 176)

• Create Named Selection (p. 583)

• Create Selection Group (p. 94)

• Clear Generated Data

• Rename

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties/Options
Graphics The following properties enable you to change the graphical display of a body.
Properties
• Visible: toggles the display of the part On or Off in the Geometry window.

• Transparency: varies the body between being completely transparent (0) to


completely opaque (1).

• Color: sets the color of the body.

Definition Suppressed (p. 13).

Stiffness Behavior (p. 178)

Brick Integration Scheme (p. 484): appears only if Element Control is set to
Manual in the Details view of the Geometry (p. 1701) object; not available if
Stiffness Behavior is set to Rigid.

Release 2020 R1 - © ANSYS, Inc.


1645
Objects Reference

Coordinate System (p. 178): assign a local coordinate system to specify the
alignment of the elements of the body if previously defined using one or more
Coordinate System (p. 1677) objects; not available if Stiffness Behavior is set to
Rigid.

Reference Temperature (p. 178).

Reference Temperature Value (p. 178): available only when you select By Body
as the Reference Temperature.

Reference Frame (p. 179): only appears when an Explicit Dynamics system is part
of the solution.

Thickness (p. 488): appears only for a surface body.

Thickness Mode (p. 488): appears only for a surface body; read-only indication.

Offset Mode (p. 498): appears only for a line body.

Offset Type (p. 498): appears only for a line body.

Model Type (p. 498): appears only for a line body.

2D Behavior: appears only for 2D analyses (p. 502), when the 2D Behavior
property is set to By Body for the Geometry object.

Behavior: this property for solid and surface bodies. The default setting is None.
You can change the property to Construction Body from the drop-down menu.
A body with the Behavior set to Construction Body can be used as a geometry
selection scoping for Arbitrary Cracks (crack surface) and Coordinate Systems.
All of the other properties in the Details view (except Suppressed and the Graphics
Properties category) become hidden when this property is set to Construction
Body.

Important

• When you scope a surface body to define the crack surface of an


Arbitrary Crack, this property automatically changes to Construction
Body. Only surface bodies are supported for Arbitrary Crack.

• When you specify a Body as a Construction Body, you cannot scope


it to Named Selections, mesh controls, loads, results, etc. A geometry
with the Construction Body behavior does not directly participate
in the Generate Mesh or Solve operations. It is also excluded when
the All Bodies selection is used for post processing of results.

Material Assignment (p. 179).

Nonlinear Effects (p. 180): Not available if Stiffness Behavior is set to Rigid.

Thermal Strain Effects (p. 180).

Release 2020 R1 - © ANSYS, Inc.


1646
Body

Gasket Initial Gap: This property only displays when the Stiffness Behavior
property is set to Gasket and enables you to specify and initial gap for a gasket.
The default value is 0. Valid entries must be greater than or equal to 0.

Fluid/Solid: Available only in the Meshing application (i.e., not available if you
are using the meshing capabilities from within the Mechanical application). Useful
in assembly meshing. Allows you to control the physics that occur on a model.
Valid options are Fluid, Solid, and Defined By Geometry. When set to Defined
By Geometry, the value is based on the Fluid/Solid material property that was
assigned to the body in the DesignModeler application.
Bounding Length X
Box (p. 181)
Length Y

Length Z
Properties - Volume
Indications
of the Mass
properties
originally Length: appears only for line bodies.
assigned to
the body. Note

If the material density is temperature dependent, the Mass will


be computed at the body temperature, or at 22°C (default
temperature for an environment).

The following appear for all bodies except line bodies:

Centroid X
Centroid Y
Centroid Z
Moment of Inertia Ip1
Moment of Inertia Ip2
Moment of Inertia Ip3
Surface Area (approx.) - appears only for a surface body

Note

Surface bodies are dependent upon the 2D Behavior setting of the


Geometry object. Any setting other than the Plane Stress setting
causes the above properties, except Surface Area, to display with
the content "N/A" (Not Applicable) in their field. However, when the
2D Behavior property is set to By Body, you can change the setting
of the 2D Behavior property for each surface body individually. These
individual settings affect what is displayed by a property’s field.

The following appear for line bodies only:

Cross Section
Cross Section Area

Release 2020 R1 - © ANSYS, Inc.


1647
Objects Reference

Cross Section IYY


Cross Section IZZ

The following appear for surface bodies only:

Offset Type (p. 489)


Membrane Offset: appears for surface bodies when Offset Type = User
Defined
Statistics: - Nodes
Read-only
indication of Elements
the entities
that Mesh Metric
comprise
the body.

Body Interactions
Sets global options for all Body Interaction objects in an Explicit Dynamics Analysis.

Tree Dependencies:

• Valid Parent Tree Object: Connections (p. 1663)

• Valid Child Tree Objects: Body Interaction,


Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options: Automatically inserted in


the tree if contact is detected when model is
attached. Also, use any of the following
methods after highlighting Connec-
tions (p. 1663) object:

• Click Body Interaction button on Connections


context toolbar (p. 80).

• Click right mouse button on Connections (p. 1663)


object or in the Geometry window>Insert>Body
Interaction.

Additional Related Information:

• Body Interaction (p. 1649)

• Body Interactions in Explicit Dynamics Analyses

• Explicit Dynamics Analysis Guide

Object Properties
The Details view (p. 17) properties for this object include the following.

Release 2020 R1 - © ANSYS, Inc.


1648
Body Interaction

Category Fields
Advanced Contact Detection
Formulation - appears if Contact Detection = Trajectory.
Shell Thickness Factor - appears if the geometry includes one or more surface bodies
and if Contact Detection = Trajectory.
Pinball Factor - appears if Contact Detection = Proximity Based.
Timestep Safety Factor - appears if Contact Detection = Proximity Based.
Limiting Timestep Velocity - appears if Contact Detection = Proximity Based.
Edge on Edge Contact - appears if Contact Detection = Proximity Based.
Body Self Contact
Element Self Contact
Tolerance - appears if Contact Detection = Trajectory and Element Self Contact
= Yes.

Body Interaction
Creates contact between bodies in an Explicit Dynamics Analysis.

Tree Dependencies:

• Valid Parent Tree Object: Body Interac-


tions (p. 1648)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options:

• Automatically inserted in the tree if model includes


a Body Interactions object.

• For manual insertion, use any of the following


methods after highlighting Connections (p. 1663)
object.

– Choose Body Interaction on Connections


context toolbar (p. 80).

– Click right mouse button on Connections (p. 1663)


object, or in the Geometry window>Insert>Body
Interaction.

Additional Related Information:

• Body Interactions (object reference) (p. 1648)

• Body Interactions

• Explicit Dynamics Analysis

Release 2020 R1 - © ANSYS, Inc.


1649
Objects Reference

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping Method
Geometry – appears if Scoping Method is set to Geometry Se-
lection. In this case, use selection filters (p. 126) to pick
geometry (p. 125), click in the Geometry field, then click Apply.
Named Selection – appears if Scoping Method = Named Selection.
Definition Type
Maximum Offset – appears if Type = Bonded.
Breakable – appears if Type = Bonded.
Normal Stress Limit – appears if Type = Bonded and Breakable =
Stress Criteria.
Normal Stress Exponent – appears if Type = Bonded and Breakable
= Stress Criteria.
Shear Stress Limit – appears if Type = Bonded and Breakable = Stress
Criteria.
Shear Stress Exponent – appears if Type = Bonded and Breakable =
Stress Criteria.
Friction Coefficient – appears if Type = Frictional.
Dynamic Coefficient – appears if Type = Frictional.
Decay Constant – appears if Type = Frictional.
Suppressed

Bolt Tool (Group)


This object provides bolt-specific results for loads that are defined using the Bolt Pretension (p. 967)
boundary condition.

The Bolt Tool applies to the following objects: Adjustment (p. 1274) and Working Load (p. 1274).

Tree Dependencies:

• Valid Parent Tree Objects:

– The Solution (p. 1817) object is the only valid parent object.

• Valid Child Tree Objects:

– The Adjustment or Working Load objects are the only valid child objects.

– For the Adjustment or Working Load objects, the Alert (p. 1632) object is
the only valid child object.

Insertion Options:

• Select the Solution object and either:

Release 2020 R1 - © ANSYS, Inc.


1650
Bolt Tool (Group)

– Select the Bolt Tool option from the Tools drop-down menu on the Solution
context toolbar (p. 84).

– Right-click the Solution object or in the Geometry window and select In-
sert>Bolt Tool>Bolt Tool.

Additional Related Information:

• Bolt Tool (p. 1274)

• Bolt Pretension (p. 967)

The following right mouse button context menu options are available for this object.

• Evaluate All Results (p. 1212): available for Bolt Tool and all child objects when the Bolt Tool is inserted
under a Solution (p. 1817) object.

• Group (p. 100)

Object Properties
The Details view properties for this object's child objects, Adjustment and Working Load, are shown
below. For more information on this object's properties, see the Bolt Tool (p. 1274) section.

Category Properties
Definition Type: read-only display of the bolt tool object name - Adjustment or Working
Load.

By: the options are listed below.

• Time

• Result Set

• Maximum Over Time

• Time of Maximum

Display Time: visible when the By property is set to Time.

Set Number: visible when the By property is set to Result Set.

Calculate Time History: options include Yes or No.

Identifier

Suppressed
Results: Minimum
read-only
properties. Maximum
Information: Time
read-only
properties. Load Step

Release 2020 R1 - © ANSYS, Inc.


1651
Objects Reference

Substep

Iteration Number

Chart
Represents a chart that you can create for loads and/or results against time, or result quantities against
a load or another result quantity.

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Comment (p. 1654), Image (p. 1706)

Insertion Method: Click the Chart and Table button on the standard
toolbar (p. 69).

Additional Related Information:

• Chart and Table (p. 1162)

• Standard Toolbar (p. 69)

Object Properties
For more information on this object's properties, see the Chart and Table (p. 1162) section.

Commands
This object enables you to use:

• Mechanical APDL application commands or Mechanical APDL programming in a simulation.

• Python for the Transient Structural (Rigid Dynamics) system.

Tree Dependencies:

• Valid Parent Tree Objects: Body (p. 1644), Contact Region (p. 1669) (shown in
figure), environment objects (p. 1690), Joint (p. 1744), Pre-Stress (p. 1792), Solu-
tion (p. 1817), Spring (p. 1823)

• Valid Child Tree Objects: Comment (p. 1654), Image (p. 1706)

Insertion Options: Choose one of the following:

• Click right mouse button on either the parent object (see above) or in the
Geometry window> Insert> Commands.

• Highlight the parent object (see above) and choose the Insert Commands
button from the toolbar.

Additional Related Information:

Release 2020 R1 - © ANSYS, Inc.


1652
Commands

• Commands Objects (p. 1475)

Tree Dependencies for the Transient Structural (Rigid dynamics) System


Valid Parent Tree Objects include the Connections Folder, Joint, Spring, Environment, and Joint
Condition.

The following right mouse button context menu options are available for this object. The file modification
options are also present on the Commands toolbar.

• Export: Exports the text contained in the Worksheet to an ASCII text file.

Note

You must right-mouse click the selected object in the tree to use this Export fea-
ture. On Windows platforms, if you have the Microsoft Office 2002 (or later) in-
stalled, you may see an Export to Excel option if you right-mouse click in the
Worksheet. This is not the Mechanical application Export feature but rather an
option generated by Microsoft Internet Explorer.

• Import: Imports an ASCII text file into the Worksheet.

• Refresh: Synchronize the text in the Worksheet to that of the currently used ASCII text file. Refresh
can be used to discard changes made to commands text and revert to a previously imported or exported
version.

• Suppress (p. 13) (available in context menu only): Suppressed commands will not propagate to the
Mechanical APDL application input file.

• Search Parameters (p. 1480): appears only if the Commands object is under a Solution (p. 1817) object.
This option scans the text output and updates the list of detected parameters. Matched the Mechanical
APDL application parameters can be parameterized just as other values in Workbench can be paramet-
erized. Refer to the next section for details.

• Rename Based on Definition: You can rename the Commands object to the name of an imported or
exported file by choosing Rename Based on Definition. The Commands object is renamed to the
name appearing in the File Name property under the Details view.

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties/Descriptions
File File Name: Read-only indication of imported text file name (including path) if
used.

File Status: Read-only indication of the status of an imported text file if used.
Definition Suppressed (p. 13)

Target: displays a list of solvers.

Release 2020 R1 - © ANSYS, Inc.


1653
Objects Reference

Invalidate Solution (p. 1476): applicable for the Solution (p. 1817) object only.

Output Search Prefix (p. 1481): applicable for the Solution (p. 1817) object only.

Step Selection Mode (p. 1480): applicable only when inserting a Commands object
under an environment object for stepped analyses or MSUP Harmonic Response
analyses (standalone or linked).

Step Number (p. 1480): this property displays when you select the By Number
option for the Step Selection Mode property.
Input Argu- Entry fields for ARG1 through ARG9.
ments (p. 1475)
Res- Applicable only when inserting under a Solution (p. 1817) object.
ults (p. 1481)

Comment
Inserts a comment for a Mechanical parent object. The comment editor creates a fragment of HTML,
and the object itself consists of that HTML fragment, a string denoting the author's name, and a color.
Report (p. 31) adds the resulting HTML fragment directly in line, in the specified color and notes the
author. The Comment window provides a number of formatting features, such as inserting an image
or applying various text formats.

Tree Dependencies:

• Valid Parent Tree Objects: All objects.

• Valid Child Tree Objects: None.

Insertion Method: Click the Comment button on the standard


toolbar (p. 69).

Additional Related Information:

• Figures (p. 166)

• Reporting (p. 31)

Note

When inserting images into a Comment, use the Insert


Image option provided on the Comment's format toolbar.
If you attempt to paste an Image (p. 1706) into a Comment,
the application will display an error message that may
require you to close and reopen the Mechanical application.

Object Properties
The Details view (p. 17) for the Comment object contains only one category (Author) and one text
entry field (Name).

Release 2020 R1 - © ANSYS, Inc.


1654
Composite Failure Criteria Definitions

Composite Failure Criteria Definitions


The Composite Failure Criteria Definitions object is a model-level object that is inserted into the tree
when you promote a Composite Failure Tool (p. 1656) object. A child object is automatically created
and is a copy of the promoted Composite Failure Tool that you can then modify using the Worksheet.
In addition, when promoted, the Defined By property of the Composite Failure Tool's Reference category
automatically changes to the setting Composite Failure Criteria Definitions. These actions also cause
the application to display the Composite Failure Criteria property in the Composite Failure Tool Reference
category. The Composite Failure Criteria property provides a drop-down list of available child objects
of the Composite Failure Criteria Definitions object, if available.

Additional child objects can be added for additional Composite Failure Tool objects. The original Com-
posite Failure Tool objects become read-only but may be changed by changing the Defined By property
to Direct Input. The goal of this feature is to enable you to configure your own combinations of failure
criteria.

Tree Dependencies:

• Valid Parent Tree Object: Model

• Valid Child Tree Objects: Composite Failure


Criteria objects

Insertion Options:

• Right-click the Composite Failure Tool object


and select Promote to Composite Failure Criter-
ia.

Additional Related Information:

• Composite Failure Tool (p. 1265)

• Composite Failure Tool (Group) Object


Reference (p. 1656)

The following right mouse button context menu options are available for the Composite Failure Cri-
teria Definitions object.

• Insert>Composite Failure Criteria

• Rename

The following right mouse button context menu options are available for the criteria child objects.

• Insert>Composite Failure Criteria

• Export Text File: export result data to a text file.

• Duplicate

• Copy

• Rename

Release 2020 R1 - © ANSYS, Inc.


1655
Objects Reference

• Group (p. 100)

Details View Properties


The Details view properties for the Composite Failure Criteria Definitions object as well as its child
objects are described below.

Composite Failure Criteria Definitions Object


Type is the only Details view property for this object.

Composite Failure Tool Criteria Objects


The Details view properties for the failure criteria objects include the same properties as the Composite
Failure Tool (p. 1656) as used to create the object except for the Define By property.

Composite Failure Tool (Group)


The Composite Failure Tool is a post-processing tool for composite parts modeled with ANSYS Com-
posite PrePost (ACP). Refer to the ANSYS Composite PrepPost User's Guide for the complete workflow
associated with composite analyses as well as the Composite Failure Tool (p. 1265) section of the ANSYS
Mechanical Help for a description of the use of this tool.

Important

• Currently, this feature is not supported on the Linux platform.

• For a Static Structural system linked to a ACP-Pre system, created prior to 18.2, Mechanical does
not support the Composite Failure Tool. You can resolve this issue by cleaning and updating the
ACP-Pre system and then refreshing the inputs of the Static Structural system.

Tree Dependencies:

• Valid Parent Tree Object: Solution (p. 1817)

• Valid Child Tree Objects:

– Inverse Reserve Factor (p. 1266)

– Safety Margin (p. 1266)

– Safety Factor (p. 1266)

– User Defined Results (p. 1340)

See the Composite Failure Tool Result


Objects (p. 1658) topic below for additional
information.

Insertion Options:

• Display the Tools drop-down menu on the Solu-


tion context toolbar (p. 84) and select Composite
Failure Tool.

Release 2020 R1 - © ANSYS, Inc.


1656
Composite Failure Tool (Group)

• Right-click the Solution object or in the Geometry


window, select Insert, and then select Composite
Failure Tool.

Additional Related Information:

• Composite Failure Tool (p. 1265)

• Composite Failure Criteria Definitions (p. 1655)

• Composite Analysis (p. 466)

• Composite Analysis Result Scoping (p. 1214)

• Analysis Ply (p. 1633)

• Imported Plies (p. 1723)

• Specifying Surface Body Layered


Sections (p. 494)

The following right mouse button context menu options are available for this object.

• The Insert menu provides the following options:

– Composite Failure Tool

– Inverse Reserve Factor

– Safety Margin

– Safety Factor

– User Defined Results (p. 1340)

– Commands (p. 1652)

• Solve (p. 1373)

• Promote to Composite Failure Criteria

• Export Text File: export result data to a text file.

• Clear Generated Data (p. 1199)

• Group (p. 100)

Note

You can use promoted composite failure criteria (p. 1267) over several load cases to ensure
that your failure analysis for composites is based on the same definition.

The Details view (p. 17) properties for this object include the following.

Release 2020 R1 - © ANSYS, Inc.


1657
Objects Reference

Category Properties
Definition Type: read-only field that displays the tool type - Composite Failure Tool.
Reference Defined By: options include:

• Direct Input: define ply criteria properties.

• Composite Failure Criteria Definitions: this option is available as a function of a


Composite Failure Tool being promoted (p. 1267).

Composite Failure Criteria: this property displays when you select Composite Failure
Criteria Definitions for the Defined By property. This property provides a drop-down
list of available Composite Failure Tools that have been promoted.
Reinforced Maximum Strain
Ply
Criteria Maximum Stress

Tsai-Wu

Tsai-Hill

Hoffman

Hashin

Puck

LaCR

Cuntze
Sandwich Face Sheet Wrinkling
Criteria
Core Failure

Shear Crimping
Isotropic Von Mises
Material
Criteria

Composite Failure Tool Result Objects


The result objects Inverse Reserve Factor, Safety Factor, and Safety Margin are only used with the
Composite Failure Tool. The Details view properties for these objects include the following.

Category Fields
Scope Scoping Method: Geometry Selection and Named Selection.

Geometry: appears if Scoping Method = Geometry. Use selection filters (p. 126)
to pick geometry (p. 125), click in the Geometry field, then click Apply.

Named Selection: appears if Scoping Method = Named Selection. Specify named


selection.

Sub Scope By: options include:

Release 2020 R1 - © ANSYS, Inc.


1658
Condensed Geometry

• Entire Section (default)

• Ply: If selected, a Ply property also displays that requires you to select a target ply
from the Modeling Ply object in the tree. The result calculation uses the intersection
of the specified Ply and the Geometry property scoping.

Definition Type: result type indication, can be changed within the same result category.
Options include:

• Inverse Reserve Factor (p. 1266)

• Safety Margin (p. 1266)

• Safety Factor (p. 1266)

Show Critical Failure Mode

Show Critical Layer

Threshold for Text Visualization: Value property.

By: options include Time and Result Set. These options enable you to visualize
the intermediate results by a time value or a result set.

Display Time: appears if By is set to Time.

Set Number: appears if By is set to Result Set.

Calculate Time History: currently, time history is not supported.

Suppressed: suppresses the object if set to Yes.


Integration Display Option: this property is a read-only indication of either Ply Maximum or
Point Results Elemental Maximum.
Results - Minimum
Read-only
status Maximum
indication of
result object. Minimum Occurs On

Maximum Occurs On
Information - Time
Read-only
status of Load Step
available
results. Substep

Iteration Number

Condensed Geometry
This object contains all of the Condensed Part objects that you create.

Release 2020 R1 - © ANSYS, Inc.


1659
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767).

• Valid Child Tree Objects: Condensed Part (p. 1660)

Insertion Options: use any of the following


methods after highlighting the Model object:

• Select Condensed Geometry on the Model


context toolbar (p. 78).

• Right-click the Model object and select


Insert>Condensed Geometry.

• Right-click in the Geometry window and then


select Insert>Condensed Geometry.

Additional Related Information:

• Working with Substructures (p. 835)

• Condensed Part (p. 835)

• Expansion Tool (p. 839)

The following right mouse button context menu options are available for this object.

• Insert>Condensed Part: insert a new Condensed Part object.

• Generate Condensed Parts: automatically generate the interfaces for a Condensed Part object.

• Create Automatic Condensed Parts: automatically generate a Condensed Part object as well as the inter-
faces of the parts.

Object Properties
The Details view (p. 17) for the Condensed Geometry object contains only one category (Transparency)
and one property (Enabled).

Condensed Part
The Condensed Part object defines a set of bodies as a single superelement. The bodies are defined as
flexible bodies but may use the Rigid Dynamics solver.

Release 2020 R1 - © ANSYS, Inc.


1660
Condensed Part

Tree Dependencies:

• Valid Parent Tree Object: Condensed Geo-


metry (p. 1659).

• Valid Child Tree Objects: Commands (p. 1652) and


Solution Information (p. 1820)

Insertion Options: use any of the following


methods after highlighting the Condensed
Geometry object:

• Select Condensed Part on the Condensed Geo-


metry toolbar.

• Select Create Automatic Condensed Parts via


the Condensed Geometry object.

• Right-click the Condensed Geometry object and


select Insert>Condensed Part.

• Right-click in the Geometry window and then


select Insert>Condensed Part.

Additional Related Information:

• Working with Substructures (p. 835)

• Condensed Geometry (p. 1659)

• Expansion Tool (p. 839)

• Expansion Settings on the Worksheet: see the


Expansion (p. 839) section.

The following right mouse button context menu options are available for this object.

• The Insert option provides the following selections:

– Condensed Part: insert a new Condensed Part object.

– Solution Information: insert a new Solution Information object (p. 1395).

– Commands: insert a new Commands object (p. 1475).

• Generate Condensed Parts: automatically generate the interfaces for a Condensed Part object.

• Detect Condensed Part Interface

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Release 2020 R1 - © ANSYS, Inc.


1661
Objects Reference

Category Properties
Scope Scoping Method: Geometry (default) or Named Selection.

Geometry: Visible when the Scoping Method is set to Geometry. Displays the type
of geometry (Body only) and the number of geometric entities (for example: 1 Body)
for your selections.

Named Selection: Visible when the Scoping Method is set to Named Selection. This
field provides a drop-down list of available user-defined Named Selections.
Definition Scope Mode: read-only property indicating the scoping mode (Manual).

Suppressed

Environment Temperature: used for the evaluation of temperature-dependent


material properties.

Physics Type: read-only property indicating the physics type (Structural).

Matrix Reduction Method: read-only property indicating the Component Mode


Synthesis (CMS) method - the only available method.

Number of Modes to Use: this property displays the number of modes to be used.

Interface Method: read-only property indicating Fixed.

Limit Search to Range: options include Yes or No (default). If set to Yes, the Range
Minimum, and Range Maximum properties display.

Range Minimum: defines the minimum frequency for the specified CMS modes.

Range Maximum: defines the maximum frequency for the specified CMS modes.

Point Mass Treatment: options are either Internal or On Interface.


Interfaces Number of Interfaces: a read-only display of the number of interface entries detected
by the application.

Number of Master Nodes: a read-only display of the number of superelement master


nodes resulting from interfaces.
Analysis These properties mimic Analysis Settings (p. 873) for Analysis Data Management.
Data Man- See the Analysis Data Management (p. 910) section of the Help for additional
agement information.

Solver Files Directory: read-only property indicating the location of the solution files
for this analysis.

Future Analysis: options include ANSYS Rigid Dynamics or None.

Solver Units: Active System or Manual.

Solver Unit System: this property is based on the setting of the Solver Units property.
It is read-only if Active System is selected, otherwise you can select the system when
the property is set to Manual.

Release 2020 R1 - © ANSYS, Inc.


1662
Connections

Connections
Defines connections between two or more parts or bodies. Includes global settings in Details view that
apply to all Contact Region (p. 1669), Spot Weld (p. 1821), Body Interaction (p. 1649) (for explicit dynamics
analyses), Joint (p. 1744), Spring (p. 1823), and Beam (p. 1638) child objects.

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Beam (p. 1638), Body


Interactions (p. 1648), Comment (p. 1654), Connec-
tion Group (p. 1664) (including those named Con-
tacts, and Joints; Contact Tool (p. 1268), Fig-
ure (p. 1697), Image (p. 1706), Joint (p. 1744), Solution
Information (p. 1820), Spot Weld (p. 1821),
Spring (p. 1823),

Insertion Options:

• Automatically inserted in the tree if connection


is detected when model is attached.

• For setting connections manually, use any of the


following methods after highlighting Mod-
el (p. 1767) object:

– Click Connections button on Model context


toolbar (p. 78).

– Click right mouse button on Model (p. 1767)


object or in the Geometry window> Insert>
Connections.

Note

These options are not available


if a Connections object already
exists in the tree.

Additional Related Information:

• Beams (p. 825)

• Body Interactions

• Connections Overview

• Automatically Generated Connections

• Contact Region Settings

• Resolving Overlapping Contact Regions

Release 2020 R1 - © ANSYS, Inc.


1663
Objects Reference

• Contact Ease of Use Features

• Contact Tool and Results (p. 1268)

• Contact Options Preferences (p. 105)

• Joints (p. 746)

• Spot Welds (p. 828)

• Springs (p. 818)

The following right mouse button context menu options are available for this object.

• Create Automatic Connections (p. 691) - available only if at least one Connection Group folder is present.

• Check Overlapping Contact Regions

• Redundancy Analysis (p. 816) - available if at least one Joint object is present.

• Enable/Disable Transparency (p. 725)

• Search Connections for Duplicate Pairs

• Rename Based on Definition (p. 1366)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Auto Detec- Generate Automatic Connection On Refresh (p. 682)
tion (p. 691)
Transpar- Enabled
ency (p. 725)

Connection Group
This object defines connections among selected bodies. Includes global settings in Details view that
apply to all Contact Region or Joint (p. 1744) child objects.

Tree Dependencies:

• Valid Parent Tree Object: Connections (p. 1663)

• Valid Child Tree Objects: Comment (p. 1654),


Contact Region (p. 1669), Figure (p. 1697), Im-
age (p. 1706), Joint (p. 1744)

Insertion Options: Use any of the following


methods after highlighting Connec-
tions (p. 1663) object:

Release 2020 R1 - © ANSYS, Inc.


1664
Connection Group

• Click Connection Group on Connections context


toolbar (p. 80).

• Click right mouse button on Connections (p. 1663)


object (or on another Connection Group object),
or in the Geometry window; then Insert>
Connection Group.

• Insert a Contact Region (p. 1669), or Joint (p. 1744)


object. A separate parent Connection Group
object is created automatically for each of these
three types of objects, and is renamed Contacts,
or Joints accordingly.

Additional Related Information:

• Automatically Generated Connections

• Resolving Overlapping Contact Regions

• Contact Region Settings (p. 697)

• Joints (p. 746)

The following right mouse button context menu options are available for this object.

• Check Overlapping Contact Regions

• Create Automatic Connections

• Enable/Disable Transparency (p. 725)

• Search Connections for Duplicate Pairs

• Rename Based on Definition (p. 1366)

• Delete Children

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Definition Connection Type (p. 691)
Scope Scoping Method

Geometry: appears if Scoping Method is set to Geometry Selection. In this case,


use selection filters (p. 126) to pick geometry (p. 125), click in the Geometry field,
then click Apply.

Named Selection: appears if Scoping Method is set to Named Selection.

Release 2020 R1 - © ANSYS, Inc.


1665
Objects Reference

Category Fields
Source Assembly: appears if Scoping Method is set to Source Assembly (Only
applicable for Assembled External and Mechanical Models (p. 554)).
Auto Detec- Tolerance Type (p. 687)
tion (p. 691)
Tolerance Slider (p. 687)

Tolerance Value (p. 687)

Use Range (p. 687)

Min Distance Percentage (p. 687)

Min Distance Value (p. 687)

Face/Face (p. 688)

Face Overlap Tolerance (p. 688): appears only for contact groups when Face/Face
is set to Yes.

Cylindrical Faces (3D Only): This property is only visible when the Connection
Type property is set to Contact and the Face/Face property is set to Yes. Options
include:

• Include (default). Includes contacts that involve cylindrical faces in the detection.

• Exclude. Excludes contacts that involve cylindrical faces from the detection

• Only. Detects only contacts that involve cylindrical faces

Face/Edge (p. 688): appears only for contact groups.

Edge Overlap Tolerance (p. 688): appears only for contact groups when Face/Edge
is set to Yes, Only Solid Body Edges, or Only Surface Body Edges.

Edge/Edge (p. 688): appears only for contact groups.

Priority (p. 690): appears only for contact groups.

Group By (p. 690)

Search Across (p. 690)

Revolute Joints (p. 809): appears only for joint groups.

Fixed Joints (p. 809): appears only for joint groups.


Statistics Connections: displays the number of connections associated with this parent
object.

Active Connections: displays the number of connections that are currently active
for this parent object (i.e., not Suppressed).

Release 2020 R1 - © ANSYS, Inc.


1666
Contact Debonding

Construction Geometry
Houses one or more Path (p. 1783), Surface (p. 1828), and/or Solid (p. 1816) objects. You can apply results
to paths and surfaces that you define.

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Comment (p. 1654),


Figure (p. 1697), Image (p. 1706), Path (p. 1783), Sur-
face (p. 1828), or Solid (p. 1816).

Insertion Options: Use any of the following


methods after highlighting Model (p. 1767)
object:

• Click Construction Geometry button on Model


context toolbar (p. 78)

• Click right mouse button on Model (p. 1767) object


or in the Geometry window Insert>Construction
Geometry.

Note

The Model folder can contain only


one Construction Geometry
object.

Additional Related Information:

• Specifying Construction Geometry (p. 661)

• Path Object Reference (p. 1783)

• Surface Object Reference (p. 1828)

• Solid Object Reference (p. 1816)

Contact Debonding
The Contact Debonding object defines contact regions along a contact interface that will separate.

Release 2020 R1 - © ANSYS, Inc.


1667
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Fracture (p. 1699)

Insertion Options: Use any of the following


methods after highlighting Fracture object:

• Click the Contact Debonding button on the


Fracture context toolbar (p. 81).

• Click right mouse button on the Fracture (p. 1699)


object, Interface Delamination (p. 1741) object, or
Contact Debonding object and select
Insert>Contact Debonding.

Additional Related Information:

• Interface Delamination and Contact


Debonding (p. 865)

• Fracture Analysis (p. 841)

The following right mouse button context menu options are available for this object.

• Insert>Interface Delamination (p. 866)

• Insert>Contact Debonding (p. 868)

• Suppress

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Definition Type - Read-only field that describes the object - Contact Debonding.
Method - Read-only field that describes the formulation used to
introduce the fracture mechanism - Cohesive Zone Material (CZM)
model.
Material - Fly-out menu for Material selection or specification. Materials
are specified in Engineering Data.
Suppressed - Includes or excludes the object in the analysis.
Scope Contact Region - Specify the Contact Region of the contact interface
that is associated with the Contact Debonding object. The properties
for the contact elements require that the contact Type (p. 701) be
Bonded or No Separation contact and that the Formulation (p. 707)
is specified as the Augmented Lagrange method or the Pure Penalty
method.

Release 2020 R1 - © ANSYS, Inc.


1668
Contact Region

Contact Region
Defines conditions for individual contact and target pairs. Several Contact Regions can appear as child
objects under a Connection Group (p. 1664) object. The Connection Group object name automatically
changes to Contacts.

Tree Dependencies:

• Valid Parent Tree Object: Connection Group (p. 1664)

• Valid Child Tree Objects: Commands (p. 1652), Comment (p. 1654), Fig-
ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Connections (p. 1663) or Connection Group (p. 1664) object:

• Inserted automatically if you choose Create Automatic Connections through


a right mouse click Connections (or Contacts) object.

• Click Contact on Connections context toolbar (p. 80) and choose a contact
type.

• Click right mouse button on Connections (p. 1663) (or Connection


Group (p. 1664)) object or in the Geometry window; then Insert> Manual
Contact Region.

Additional Related Information:

• Contact Region Settings (p. 697)

• Automatically Generated Connections (p. 691)

• Global Connection Settings (p. 681) - See the Connections Folder (p. 681) and
Connection Group Folder (p. 685) sections.

• Connections Context Toolbar (p. 80)

• Setting Contact Conditions Manually (p. 723)

• Contact Ease of Use Features (p. 723)

• Contact Tool and Results (p. 1268)

• Contact Options Preferences (p. 105)

• Interface Delamination using ANSYS Composite PrepPost (ACP) (p. 869)

• Mesh Connections

• Contact Matches

The following right mouse button context menu options are available for this object.

Release 2020 R1 - © ANSYS, Inc.


1669
Objects Reference

• Create: When you select a Contact Region object (or multiple Contact Region objects), the Create context
menu option provides the following additional options:

Contact Sizing
This option enables you to create a Contact Sizing control under the Mesh folder.

Contact Tool
This option enables you to create a Contact Tool under the Connections folder. The application auto-
matically scopes the tool to the selected Contact Region(s) only.

Mesh Contact(s) or Connection(s)


This option enables you to create Mesh Connection and Contact Match objects from Contact Regions.
The application scopes the new Mesh Connection or Contact Match objects to the geometries of the
Contact Region(s) and sets the tolerance to be equal to the trim tolerance of the contact region. The
Mesh Connections and Contact Matches are added into new Mesh Connection Group and Contact
Match Group folders.

Environment Submenu
The Create option provides a submenu of options to create specific result objects for environments
that include the options shown below. The application inserts the corresponding object under the
Solution folder for the selected environment and automatically scopes the object to the Contact Region
(or Contact Regions).

– Force Reaction

– Moment Reaction

– Contact Tracker

– Contact Tool

• Enable/Disable Transparency (p. 725)

• Hide All Other Bodies (p. 726)

• Flip Contact/Target (p. 727)

• Search Connections for Duplicate Pairs (p. 691)

• Go To Connections for Duplicate Pairs (p. 691): available if connection object shares the same geometries
with other connection objects.

• Save Contact Region Settings (p. 728)

• Load Contact Region Settings (p. 728)

• Reset to Default (p. 729)

• Promote to Named Selection (p. 597)

• Rename Based on Definition (p. 726)

Object Properties
Choose the object properties below that apply to your analysis type.

Release 2020 R1 - © ANSYS, Inc.


1670
Contact Region

Object Properties - Most Structural Analyses


Object Properties - Explicit Dynamics Analyses
Object Properties - Thermal and Electromagnetic Analyses
Object Properties - Rigid Body Dynamics Analyses

Object Properties - Most Structural Analyses


The Details view (p. 17) properties for this object include the following.

Category Fields/Conditions
Scope (p. 698) Scoping Method (p. 698)
Interface - displays when the Scoping Method is set to Pre-Generated
Interface.
Contact
Target
Contact Bodies
Target Bodies
Contact Shell Face - appears for surface bodies.
Target Shell Face - appears for surface bodies.
Definition (p. 698) Type
Friction Coefficient (p. 702) - if Type = Frictional
Scope Mode
Behavior
Trim Contact (p. 704)
Trim Tolerance - if Trim Contact is set to On.
Suppressed (p. 13)
Advanced (p. 698) Formulation (p. 707)
Detection Method (p. 709)
Penetration Tolerance (p. 710)
Elastic Slip Tolerance (p. 711)
Normal Stiffness (p. 713)
Normal Stiffness Factor (p. 713) - if Normal Stiffness = Manual
Constraint Type (p. 712) - if Formulation = MPC and scoping of Con-
tact Bodies or Target Bodies is to a surface body.
Update Stiffness (p. 713) - if Formulation = Augmented Lagrange or
Pure Penalty
Stabilization Damping Factor (p. 714) - Helps reduce the risk of rigid
body motion. Available for Frictionless, Rough, and Frictional contact
types.
Thermal Conductance (p. 714)
Pinball Region (p. 715)
Pinball Radius (p. 716) - if Pinball Region = Radius
Electric Conductance (p. 716)
Electric Conductance Value - if Electric Conductance = Manual
Time Step Controls (p. 716) - if Type = Frictionless, Rough, or Friction-
al
Restitution Factor (p. 717) - Rigid Body Dynamics Solver Only
Material - if Formulation (p. 707) = Beam
Radius - if Formulation (p. 707) = Beam
Geometric Modific- Interface Treatment (p. 717)
ation (p. 717) Offset (p. 717) - if Interface Treatment = Add Offset

Release 2020 R1 - © ANSYS, Inc.


1671
Objects Reference

Category Fields/Conditions
Contact Geometry Correction (p. 719). Supporting properties include:

• Orientation

• Mean Pitch Diameter

• Pitch Distance

• Thread Angle

• Thread Type

• Handedness

Basics of Contact Region object (p. 1669)

Object Properties - Explicit Dynamics Analyses


The Details view (p. 17) properties for this object include the following.

Category Fields/Conditions
Scope (p. 698) Scoping Method
Contact
Target
Contact Bodies
Target Bodies
Definition Type
Friction Coefficient - if Type = Frictional
Dynamic Coefficient - if Type = Frictional
Decay Constant - if Type = Frictional
Scope Mode (p. 703)
Behavior (p. 703)
Maximum Offset - if Type = Bonded
Breakable - if Type = Bonded
Normal Stress Limit - if Type = Bonded and Breakable = Stress Criteria
Normal Stress Exponent - if Type = Bonded and Breakable = Stress
Criteria
Shear Stress Limit - if Type = Bonded and Breakable = Stress Criteria
Shear Stress Exponent - if Type = Bonded and Breakable = Stress
Criteria
Suppressed (p. 13)

Basics of Contact Region object (p. 1669)

Object Properties - Thermal and Electromagnetic Analyses


The Details view (p. 17) properties for this object include the following.

Category Fields/Conditions
Scope (p. 698) Scoping Method (p. 698)

Release 2020 R1 - © ANSYS, Inc.


1672
Contact Region

Category Fields/Conditions
Contact (p. 698)
Target (p. 699)
Contact Bodies (p. 699)
Target Bodies (p. 699)
Contact Shell Face (p. 699) - appears for surface bodies.
Target Shell Face (p. 699) - appears for surface bodies.
Definition (p. 698) Type (p. 701)
Friction Coefficient (p. 702) - if Type = Frictional
Scope Mode (p. 703)
Behavior (p. 703)
Suppressed (p. 13)
Advanced (p. 698) Formulation (p. 707)
Constraint Type (p. 712) - if Formulation = MPC and scoping of Con-
tact Bodies or Target Bodies is to a surface body.
Interface Treatment (p. 717)
Offset (p. 717) - if Interface Treatment = Add Offset.
Normal Stiffness (p. 713) (Magnetostatic analyses and all thermal
analyses) - if Formulation = Augmented Lagrange, Pure Penalty, or
MPC.
Normal Stiffness Factor (p. 713) (Magnetostatic analyses and all thermal
analyses) - if Normal Stiffness = Manual
Update Stiffness (p. 713) (Magnetostatic analyses and all thermal
analyses) - if Formulation = Augmented Lagrange, Pure Penalty, or
MPC.
Thermal Conductance (p. 714) (Magnetostatic analyses and all thermal
analyses)
Thermal Conductance Value (p. 715) (Magnetostatic analyses and all
thermal analyses) - if Thermal Conductance = Manual.
Electrical Conductance (p. 716) (Electric and Magnetostatic analyses)
Electrical Conductance Value (p. 716) (Electric and Magnetostatic
analyses) - if Electric Conductance = Manual.
Pinball Region (p. 715)
Pinball Radius (p. 716) - if Pinball Region = Radius.
Time Step Controls (p. 716) - if Type = Frictionless, Rough, or Friction-
al.

Basics of Contact Region object (p. 1669)

Object Properties - Rigid Body Dynamics Analyses


The Details view (p. 17) properties for this object include the following.

Category Fields/Conditions
Scope (p. 698) Scoping Method (p. 698)
Contact (p. 698)
Target (p. 699)
Contact Bodies (p. 699)
Target Bodies (p. 699)
Contact Shell Face (p. 699) - appears for surface bodies.
Target Shell Face (p. 699) - appears for surface bodies.

Release 2020 R1 - © ANSYS, Inc.


1673
Objects Reference

Category Fields/Conditions
Definition (p. 698) Type (p. 701)
Advanced (p. 698) Restitution Factor (p. 717)
Statistics Connections: displays the number of connections associated with this
parent object.

Active Connections: displays the number of connections that are currently


active for this parent object (i.e., not Suppressed).

Basics of Contact Region object (p. 1669)

Contact Tool (Group)


Determines contact conditions on an assembly both before loading and as part of the final solution.

Applies to the following objects: Contact Tool (p. 1268), Frictional Stress (p. 1243), Gap (p. 1243), Initial
Information (p. 1272), Penetration (p. 1243), Pressure (p. 1243), Sliding Distance (p. 1243), Status (p. 1243)

Tree Dependencies:

• Valid Parent Tree Objects:

– For Contact Tool: Connections (p. 1663), Solution (p. 1817)

– For Frictional Stress, Pressure, Sliding Distance, and Fluid Pressure:


Contact Tool under Solution (p. 1817) object

– For Gap, Penetration, and Status: Contact Tool under Connections (p. 1663)
object or Solution (p. 1817) object

– For Initial Information: Contact Tool under Connections (p. 1663) object
only

• Valid Child Tree Objects:

– For Contact Tool under Connections (p. 1663) object: Comment (p. 1654), Gap,
Image (p. 1706), Initial Information, Penetration, Status

– For Contact Tool under Solution (p. 1817) object: Comment (p. 1654), Gap,
Frictional Stress, Image (p. 1706), Penetration, Pressure, Sliding Distance,
Fluid Pressure, Status

– For Frictional Stress, Gap, Penetration, Pressure, Sliding Distance, and


Fluid Pressure: Alert (p. 1632), Comment (p. 1654), Convergence (p. 1676), Fig-
ure (p. 1697), Image (p. 1706)

– For Initial Information: Comment (p. 1654), Image (p. 1706)

– For Status: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options:

Release 2020 R1 - © ANSYS, Inc.


1674
Contact Tool (Group)

• For Contact Tool under Connections (p. 1663) object, use any of the following
methods after highlighting Connections object:

– Choose Contact Tool on Connections context toolbar (p. 80) under the
Contact drop-down menu.

– Click right mouse button on Connections (p. 1663) object or in the Geometry
window> Insert> Contact Tool.

• For Contact Tool under Solution (p. 1817) object, use any of the following
methods after highlighting Solution object:

– Choose Tools> Contact Tool on Solution context toolbar (p. 84).

– Click right mouse button on Solution object or in the Geometry window>


Insert> Contact Tool> Contact Tool.

• For any Contact Tool result object, use any of the following methods after
highlighting Contact Tool object:

– Choose Contact> (result object) on Contact Tool context toolbar.

– Click right mouse button on Contact Tool object or in the Geometry


window> Insert> (result object).

Additional Related Information:

• Connections Context Toolbar (p. 80)

• Contact Overview (p. 693)

• Contact Settings (p. 697)

• Setting Contact Conditions Manually (p. 723)

• Contact Ease of Use Features (p. 723)

• Contact Tool and Results (p. 1268)

• Contact Options Preferences (p. 105)

The following right mouse button context menu options are available for this object.

• Generate Initial Contact Results (p. 1268) - available for Contact Tool and all child objects when the Contact
Tool is inserted under a Connections (p. 1663) object.

• Evaluate All Results (p. 1212) - available for Contact Tool and all child objects when the Contact Tool is in-
serted under a Solution (p. 1817) object.

Object Properties
For more information on this object's properties, see the Contact Tool (p. 1268) section.

Release 2020 R1 - © ANSYS, Inc.


1675
Objects Reference

Convergence
Controls the relative accuracy of a solution by refining solution results on a particular area of a model.
The Convergence object is applicable to Static Structural, Modal, Eigenvalue Buckling, Steady-State
Thermal, and Magnetostatic analyses.

Tree Dependencies:

• Valid Parent Tree Objects: Several result objects (p. 1804).

Insertion Options: Click right mouse button on a result object (p. 1804) or
in the Geometry window> Insert> Convergence.

Note

Note the following requirements:

• Only one Convergence object is valid per result object (p. 1804).

• Convergence is not supported:

– For result objects that belong to linked analyses.

– If an imported load object exists in the environment.

– When Imported Plies or Imported Thickness objects are


used.

• When performing an out of process (p. 1376) solution


asynchronously, wherein the solve may finalize during another
Workbench session, the application performs only one
maximum refinement loop. As necessary, you must manually
perform additional loops. To solve with a single user action,
solve synchronously.

Additional Related Information:

• Adaptive Convergence (p. 1411)

• Error (Structural) (p. 1232)

• Error (Thermal) (p. 1313)

• Mechanical Options - Convergence (p. 109)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Definition Type (p. 1411)

Release 2020 R1 - © ANSYS, Inc.


1676
Coordinate System

Allowable Change (p. 1411)


Results Last Change - Read-only indication of the most recent change in
convergence.
Converged - Read-only indication of the convergence state (Yes or No).

Note

• Convergence objects inserted under an environment that is referenced by an Initial Condition


object or a Thermal Condition load object, will invalidate either of these objects, and not
allow a solution to progress.

• Results cannot be converged when you have a Mesh Connection object.

• To use Convergence, you must set Calculate Stress to Yes under Output Controls in the
Analysis Settings details panel. However, you can perform Modal and Buckling Analysis
without specifying this option.

• You cannot use Convergence if you have an upstream or a downstream analysis link.

• Convergence is not available when you import loads into the analysis.

• Convergence is not available when you activate the Nonlinear Adaptive Region (p. 1112)
condition in the analysis.

Coordinate System
Represents a local coordinate system that you can add under a Coordinate Systems (p. 1680) object.

Tree Dependencies:

• Valid Parent Tree Object: Coordinate Systems (p. 1680)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Coordinate Systems (p. 1680) object, or Global Coordinate System (p. 1705)
object, or another Coordinate System object:

• Choose Create Coordinate System button on Coordinate Systems context


toolbar.

• Right-click the mouse button on the Coordinate Systems (p. 1680) object, or
the Global Coordinate System (p. 1705) object, or another Coordinate System
object, or in the Geometry window and then select Insert> Coordinate
System.

Additional Related Information:

• Setting Up Coordinate Systems (p. 671)

• Creating Coordinate Systems (p. 671)

Release 2020 R1 - © ANSYS, Inc.


1677
Objects Reference

The following right mouse button context menu options are available for this object.

• Create Section Plane (p. 154)

• Create Construction Surface (p. 666)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Definition Type
Cartesian or Cylindrical.

Coordinate System
Program Controlled or Manual.

These options assign the coordinate system reference number


automatically or manually. If you specify Manual, the Coordinate
System ID property displays. Enter a value greater than or equal to
12. Coordinate systems must have a unique ID.

APDL Name
When using the Mechanical APDL solver, this text-based field enables you
to create an APDL parameter (in the input file) and assign its value to the
reference number of the coordinate system. This facilitates easy
programmatic identification of the coordinate system for later use/reference
in a Command object (p. 1475).

Suppressed
Yes or No (default). Suppressing a coordinate system removes the object
from further treatment, and writes no data to the input deck, and causes
any objects scoped to the coordinate system to become underdefined
(therefore invalidating solutions).

Origin Define By
Geometry Selection, Named Selection or Global Coordinates.

• Geometry Selection - Default setting, indicating that the coordinate


system is applied to a geometry or geometries, which are chosen using
a graphical selection tools.

When the Define By is set to Geometry Selection, the Geometry


property displays. This property displays the type of geometry
(Body, Face, etc.) and the number of geometric entities (for
example: 1 Body, 2 Edges) to which the boundary has been applied
using the selection tools.

• Named Selection: when this property is selected, the geometry selection


is defined by a Named Selection.

Release 2020 R1 - © ANSYS, Inc.


1678
Coordinate System

When the Define By is set to Named Selection, another Named


Selection property displays. This field provides a drop-down list
of available user-defined Named Selections.

• Global Coordinates

This selection allows you to specify the coordinate system origin


using the Location property in tandem with the Hit Point
Coordinate feature on the Graphics Toolbar (p. 70) or by entering
Origin X, Origin Y, and Origin Z coordinate values directly to
define the origin of the coordinate system.

Origin X
X location on the coordinate axis from the (0, 0, 0) location.

Origin Y
Y location on the coordinate axis from the (0, 0, 0) location.

Origin Z
Z location on the coordinate axis from the (0, 0, 0) location.

Location
This property is visible when the Define By is set to Global Coordinates.
It enables you to change the location of the coordinate system based on
a geometry selection (vertex, edge, or face).

Principal Axis (p. 674) Axis: X, Y, or Z


Define the Principal Axis vector with respect to one of these planes.

Define By
Property options include:

Geometry Selection
Fixed Vector
Global X Axis
Global Y Axis
Global Z Axis
Hit Point Normal

Orientation About Axis


Principal Axis (p. 674) Based on the Principal Axis, define the Orientation About Principal Axis
vector with respect to the X, Y, or Z plane.

Define By
Property options include:

Default
Geometry Selection
Global X
Global Y
Global Z
Fixed Vector

Release 2020 R1 - © ANSYS, Inc.


1679
Objects Reference

Directional Vectors X Axis Data


A read-only mathematical representation, in matrix form, showing of the
X vector orientation in space.

Y Axis Data
A read-only mathematical representation, in matrix form, showing of the
Y vector orientation in space.

Z Axis Data
A read-only mathematical representation, in matrix form, showing of the
Z vector orientation in space.

Transformations (p. 674) Base Configuration


Read-only property - Absolute.

Transformation Features
The following properties can be added to the active coordinate system
object from the Coordinate System Context Toolbar (p. 82). They enable
you to change the location and rotation of the original definition of the
coordinate system. These properties are order-dependent and that order
may be modified using the Move Up and Move Down features of the
Coordinate System Context Toolbar (p. 82).

Offset X
Offset Y
Offset Z
Rotate X
Rotate Y
Rotate Z
Flip X
Flip Y
Flip Z

Transformation Configuration
Read-only property that displays the transformed coordinate point locations
from the origin.

Coordinate Systems
Houses any new coordinate systems that can include a Global Coordinate System (p. 1705) object and
local Coordinate System (p. 1677) objects.

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Comment (p. 1654), Coordinate System (p. 1677),
Figure (p. 1697), Global Coordinate System (p. 1705), Image (p. 1706)

Release 2020 R1 - © ANSYS, Inc.


1680
Cross Section Objects

Insertion Options: The Coordinate Systems object is automatically inserted


into the tree.

Note

Only one Coordinate Systems (Parent) object is valid per


Model (p. 1767).

Additional Related Information:

• Setting Up Coordinate Systems (p. 671)

• Creating Coordinate Systems (p. 671)

Cross Sections
The Cross Sections object houses the Cross Section Objects (p. 1681) for each imported line body.

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: The Cross Sections


object automatically includes one or more child
objects (Cross Section Objects (p. 1681)) that include
the associated cross section data defined in the
upstream system.

Insertion Options: The application


automatically inserts this object as well as its
associated child objects.

Additional Related Information:

• Line Bodies (p. 498)

• Cross Section Objects (p. 1681)

Rename is the only context menu option available for this object.

Object Properties
This object does not include any Details view properties.

Cross Section Objects


The application automatically generates cross section objects when you import a line body that includes
cross sectional data. For each imported cross section, there is an associated cross section object that
displays the cross section type specified in a CAD application as well as via the External Model. These

Release 2020 R1 - © ANSYS, Inc.


1681
Objects Reference

objects are contained in the Cross Sections object (p. 1681) and provide read-only data for the associated
CAD cross section specifications of your imported line body.

Note

You may wish to review the SECTYPE and SECDATA commands. These commands send
cross section data to the MAPDL solver.

Tree Dependencies:

• Valid Parent Tree Object: Cross Sections (p. 1681).

• Valid Child Tree Objects: Not applicable.

Insertion Options: The application


automatically inserts the Cross Sec-
tions (p. 1681) object as well as its associated
child objects.

Additional Related Information:

• Line Bodies (p. 498)

• Cross Section (ANSYS DesignModeler User's


Guide)

The following right mouse button context menu options are available for this object.

• Rename

• Group/Ungroup (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Dimension DesignModeler supports the following Cross Section Types. Also refer to the
SpaceClaim Direct Modeler documentation for additional cross section
information.

Release 2020 R1 - © ANSYS, Inc.


1682
Cross Section Objects

Category Properties
Rectangular

Circular

Circular Tube

Channel Section

I Section

Z Section

L Section

T Section

Hat Section

Rectangular Tube

User Integrated

User Defined
Physical The Physical Properties category provides the following read-only properties
Properties that display the associated cross section information provided by the upstream
system (i.e., CAD application/External Model system):

• Beam Section: This property displays the cross section type as supported by
DesignModeler or SpaceClaim Direct Modeler.

• Type: This property displays the Element type used by the cross section.

• A: This property displays the Area of the cross section.

• Iyy: This property displays moment of inertia about the Y axis.

• Izz: This property displays moment of inertia about the Z axis.

Note

DesignModeler uses a different cross section coordinate system


than Mechanical (MAPDL solver). Mechanical displays Izz
whereas DesignModeler displays Ixx. In DesignModeler, the
cross section lies in the XYPlane and the Z direction corresponds
to the edge tangent. In the Mechanical environment, the cross
section lies in the YZ plane and uses the X direction as the
edge tangent. This difference in orientation has no bearing on
the analysis.

See the Cross Section Types section of the ANSYS DesignModeler User's Guide
for additional information about these properties. You can also refer to the

Release 2020 R1 - © ANSYS, Inc.


1683
Objects Reference

Category Properties
SpaceClaim Direct Modeler documentation for additional cross section
information.

Distributed Mass
3D analyses only. This feature enables you to distribute additional mass across faces or edges on your
model. It can be scoped to flexible parts only (Stiffness Behavior = Flexible).

It is supported for the following Mechanical systems: Eigenvalue Buckling, Modal (including pre-stress
effects), Harmonic Response (Full, linked MSUP, pre-stressed, and standalone), Random Vibration, Response
Spectrum, Static Structural, and Transient Structural (standalone and linked MSUP).

Tree Dependencies:

• Valid Parent Tree Object: Geometry (p. 1701)

• Valid Child Tree Objects: Comment (p. 1654),


Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting Geometry (p. 1701)
object or Part (p. 1781) object:

• Click Distributed Mass button on Geometry


context toolbar (p. 81).

• Right-click the Geometry (p. 1701) object, Part


object, Body object, or in the Geometry window>
Insert> Distributed Mass.

Additional Related Information: Distributed


Mass (p. 506) application.

The following right mouse button context menu options are available for this object.

• Group/Ungroup (p. 100)

• Suppress

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Scope Scoping Method: specify as Geometry Selection (default) or Named Selection.

Geometry: Displayed when the Scoping Method is set to Geometry Selection


(default). Displays the type of geometry (Face or Edge only) and the number
of faces to which the Distributed Mass has been applied using the selection
tools. Use the Face or Edge selection filter to pick geometry, click in the
Geometry field, then click Apply.

Release 2020 R1 - © ANSYS, Inc.


1684
Direct FE (Group)

Category Properties
Named Selection: Displays when the Scoping Method is set to Named
Selection. This field provides a drop-down list of available face- or edge-based
user-defined Named Selections.
Definition Mass Type: The options for this property are Total Mass and Mass per Unit
Area. Once selected addition entry properties are required, including:

• Total Mass (default): Specify the total mass applied to the scoped geometric
entities. This property can be designated as a parameter.

• Mass per Unit Area: Specify the mass per unit area. This property can be
designated as a parameter.

Suppressed

Direct FE (Group)
Defines the node-based boundary conditions that are used in the Environment object of a model.

Applies to the following objects: Nodal Orientation (p. 1120), Nodal Force (p. 1121), Nodal Pres-
sure (p. 1123), Nodal Displacement (p. 1126), and Nodal Rotation (p. 1128).

Tree Dependencies:

• Valid Parent Tree Objects: Environment

• Valid Child Tree Objects:

– Nodal Orientation

– Nodal Force

– Nodal Pressure

– Nodal Displacement

– Nodal Rotation

– EM Transducer

Insertion Options: Use any of the following


methods after highlighting Environ-
ment (p. 1690) object:

• Click Direct FE on Environment context


toolbar (p. 83).

• Click right mouse button on Environment object


or in the Geometry window; then Insert> {load
type}.

Release 2020 R1 - © ANSYS, Inc.


1685
Objects Reference

Object Properties
See the Direct FE (p. 1120) section for more information about the load options as well as Details View
properties.

Drop Height
This object applies a velocity as an initial condition by calculating the velocity at which an object would
be traveling if dropped from rest from a specified height.

Available for use in an Explicit Dynamics analysis.

Tree Dependencies:

• Valid Parent Tree Object: Initial Condi-


tions (p. 1740)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting the Initial Condi-
tions (p. 1701) object:

• Click Drop Height on the Initial Conditions


context toolbar.

• Right-click the Initial Conditions (p. 1740) tree


object or in the Geometry window
InsertVelocity.

Additional Related Information:

• Define Initial Conditions

• Using the Drop Test Wizard

• Explicit Dynamics Analysis Guide Overview

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping Method, options include:

• Geometry Selection: Default setting, indicating that you apply the


feature to one or more bodies, which are chosen using graphical
selection tools.

– Geometry: Visible when the Scoping property is set to Geometry


Selection. In this case, use selection filters to pick geometry, click the
Geometry field, then click Apply.

Release 2020 R1 - © ANSYS, Inc.


1686
Element Orientation

• Named Selection: Indicates that the geometry selection is defined by


a Named Selection.

– Named Selection: Visible when the Scoping property is set to Named


Selection. This field provides a drop-down list of the available Named
Selections.

Definition Input Type: choose either Angular Velocity, Drop Height, or Velocity.

Define By: this property defines how the drop height is specified.

• Drop Height:

– Drop Height: Visible when the Define by property is set to Drop


Height. Height from which object will be dropped from rest prior to
start of the analysis.

• Impact Velocity:

– Impact Velocity: Visible when the Define by property is set to Impact


Velocity. Magnitude of initial velocity.

Coordinate System: Use this property to specify the desired coordinate


system.

Direction: Direction in which initial velocity is applied.

Element Orientation
This object is used to modify the coordinate system of individual solid and shell elements.

Tree Dependencies:

• Valid Parent Tree Object: Geometry (p. 1701)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting the Geo-
metry (p. 1701) object:

• Click Element Orientation button on Geometry


context toolbar (p. 81).

• Click right mouse button on the Geometry (p. 1701)


object or in the Geometry window and select
Insert>Element Orientation.

Additional Related Information:

• Element Orientation (p. 570)

• Setting Up Coordinate Systems (p. 671)

Release 2020 R1 - © ANSYS, Inc.


1687
Objects Reference

• Geometry Context Toolbar (p. 81)

The following right mouse button context menu options are available for this object.

• Insert>Element Orientation

• Generate Orientations

• Suppress

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping, options include:

• Geometry Selection: Default setting, indicating that you apply the


feature to one or more bodies, which are chosen using graphical
selection tools.

– Geometry: Visible when the Scoping property is set to Geometry


Selection. Geometry scoping supports Body selection and direct
element selection (p. 143) (mesh required). Displays the type of
geometry (Body or Element) and the number of geometric entities
(for example: 1 Body, 2 Elements) to which you have scoped the
geometry.

• Named Selection: Indicates that the geometry selection is defined by


a Named Selection.

– Named Selection: Visible when the Scoping property is set to


Named Selection. This field provides a drop-down list of the available
geometry-based or element-based (p. 143) Named Selections.

Definition Defined By: this property how the orientation is specified. Options
include Surface and Edge Guide (default) and Coordinate System.

Suppressed (p. 13)

Coordinate System: this option becomes available when you set the
Defined By property to Coordinate System. Use this property to specify
the desired coordinate system.
Surface Guide Scoping – Geometry Selection or Named Selection.

(Surface and Edge Geometry: face selection, either geometry or named selection.
Guide option only)
Axis: specify the axis (+/- X, +/- Y, or +/- Z) that aligns with the Surface
Guide normal.
Edge Guide Scoping – Geometry Selection or Named Selection.

Geometry: edge selection, either geometry or named selection.

Release 2020 R1 - © ANSYS, Inc.


1688
End Release

(Surface and Edge Axis: specify the axis (+/- X, +/- Y, or +/- Z) that aligns tangentially with
Guide option only) the Edge Guide.

End Release
Allows chosen DOFs to be released on a vertex between line bodies.

Tree Dependencies:

• Valid Parent Tree Object: Connections (p. 1663)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Connections (p. 1663) object:

• Click End Release on Connections context toolbar (p. 80).

• Click right mouse button on Connections (p. 1663) object or in the Geometry
window; then Insert> End Release.

Additional Related Information:

• End Releases (p. 828)

• Connections Context Toolbar (p. 80)

The following right mouse button context menu option is available for this object.

• Rename Based on Definition (p. 726) (1)

(1) - Description for Contact Region object also applies to Mesh Connection object.

The Details view (p. 17) properties for this object include the following.

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties/Conditions
Scope (p. 828) Scoping Method – Geometry Selection or Named Selection.
Edge Geometry
Vertex Geometry
Definition (p. 828) Coordinate System
Translation X
Translation Y
Translation Z
Rotation X
Rotation Y
Rotation Z
Behavior
Suppressed (p. 13)

Release 2020 R1 - © ANSYS, Inc.


1689
Objects Reference

Environment (Group)
An environment object holds all analysis related objects in a given Model (p. 1767) object. The default
name of the environment object is the same as the name of the analysis type (p. 195). All result objects
of an analysis are grouped under the Solution (p. 1817) object.

Note

The application creates reference files that contain analysis information that is read back into
the application during solution processing. Certain textual characters can create issues during
this reading process. Avoid the use of the following characters when renaming your environ-
ment:

• Quote character (“)

• Ampersand (&)

• Apostrophe (‘)

• Greater than and less than characters (< >)

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Analysis Settings (p. 1634), Comment (p. 1654), Fig-
ure (p. 1697), Image (p. 1706), Initial Condition (for some analysis types), all load
and support objects (p. 1746), Solution (p. 1817)

Insertion Options: Appears by default based on the analysis type chosen


in the Project Schematic.

Additional Related Information:

• Analysis Types (p. 195)

• Environment Context Toolbar (p. 83)

• Types of Loads (p. 938)

• Types of Supports (p. 1077)

The following right mouse button context menu options are available for this object.

• Insert>[options for this menu item vary based on the analysis type.]

• Solve (p. 1373)

• Duplicate

• Clear Generated Data (p. 1199)

• Group All Similar Children (p. 100)

Release 2020 R1 - © ANSYS, Inc.


1690
Expansion Settings

• Open Solver Files Directory (p. 910) (available for Windows OS only)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Definition Physics Type
(read-only
indications) Analysis Type

Solver Target
Options Environment Temperature: the temperature of the body unless this temperature is
specified by a particular load such as a thermal condition or an imported temperature.
This will also be the material reference temperature unless overridden by the Body
(see Reference Temperature (p. 178) under Define Part Behavior (p. 177) for more
information). Environment Temperature is not valid for any type of thermal analysis.

Generate Input Only

Expansion Settings
This object is automatically inserted beneath the Solution object when you add a Condensed Part
object.

Tree Dependencies:

• Valid Parent Tree Object: Solution (p. 1817).

• Valid Child Tree Objects: None.

Insertion Options: automatic upon insertion of a Condensed Part


object.

Additional Related Information:

• Working with Substructures (p. 835)

• Condensed Geometry (p. 1659)

• Condensed Part (p. 835)

• Expansion Settings on the Worksheet: see the Expansion (p. 839)


section.

The Details view (p. 17) properties for this object include the following.

Category
Analysis Delete Unneeded Files: Yes (default) or No.
Data Man-
age-
ment (p. 910)

Release 2020 R1 - © ANSYS, Inc.


1691
Objects Reference

Category
Output Stress: Yes (default) or No.
Con-
trols (p. 904) Strain: Yes (default) or No.

Nodal Forces: Yes or No (default).

General Miscellaneous: Yes or No (default).

Fatigue Tool (Group)


Determines life, damage, and factor of safety information using a stress-life or strain-life approach. The
Fatigue Tool is available for Static Structural (p. 339), Transient Structural (p. 384), Harmonic Re-
sponse (p. 211), and Random Vibration (p. 235) (spectral fatigue) analyses only.

Applies to the following objects: Biaxiality Indication (p. 1338), Damage (p. 1337), Damage Matrix (p. 1338),
Equivalent Alternating Stress (p. 1338), Fatigue Sensitivity (p. 1339), Fatigue Tool (p. 1337), Hyster-
esis (p. 1340), Life (p. 1337), Rainflow Matrix (p. 1338), Safety Factor (p. 1337)

Tree Dependencies:

• Valid Parent Tree Object:

– For Fatigue Tool: Solution (p. 1817)

– For Biaxiality Indication, Damage, Damage Matrix, Equivalent Al-


ternating Stress, Fatigue Sensitivity, Hysteresis, Life, Rainflow
Matrix, Safety Factor: Fatigue Tool

• Valid Child Tree Objects:

– For Fatigue Tool: Biaxiality Indication, Comment (p. 1654), Damage,


Damage Matrix, Equivalent Alternating Stress, Fatigue Sensitivity,
Hysteresis, Image (p. 1706), Life, Rainflow Matrix, Safety Factor

– For Biaxiality Indication, Damage, Equivalent Alternating Stress,


Life, Safety Factor: Alert (p. 1632), Comment (p. 1654), Conver-
gence (p. 1676), Figure (p. 1697), Image (p. 1706)

– For Damage Matrix, Fatigue Sensitivity, Hysteresis, Rainflow Matrix:


Comment (p. 1654), Image (p. 1706)

Insertion Options:

• For Fatigue Tool, use any of the following methods after highlighting
Solution (p. 1817) object:

Release 2020 R1 - © ANSYS, Inc.


1692
Fatigue Tool (Group)

– Select Tools>Fatigue Tool on Solution context toolbar (p. 84).

– Click-right on the Solution (p. 1817) object or in the Geometry window


and select Insert>Fatigue>Fatigue Tool.

• For all results of the Fatigue Tool, use any of the following methods after
highlighting Fatigue Tool object:

– Choose Contour Results or Graph Results drop-down menu and the


[specific fatigue result] on Fatigue Tool context toolbar.

– Click-right on the Fatigue Tool object or in the Geometry window and


select Insert>[specific fatigue result].

Additional Related Information:

• Fatigue Overview (p. 1323)

• Fatigue Material Properties (p. 1323)

• Fatigue Stress Life Versus Strain Life (p. 1325)

• Fatigue Analysis Application (p. 1332)

• Fatigue Results (p. 1337)

The following right mouse button context menu options are available for this object.

• Insert: this option provides a menu to add additional result-based objects.

• Solve

• Evaluate All Results (p. 1212):available for the Fatigue Tool and all tool child objects.

• Duplicate/Copy/Cut

• Delete

• Rename

• Clear Generated Data

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Fatigue Tool
The Details view categories and properties differ based on the analysis type. For Static Structural,
Transient Structural, and Harmonic Response analyses, the Details of the Fatigue Tool include:

Category Properties/Description

Release 2020 R1 - © ANSYS, Inc.


1693
Objects Reference

Domain Domain Type: this read-only property displays the following content based on
the analysis type:

• Time: Static or Transient Structural

• Time - Harmonic: Harmonic Response

• Frequency: Random Vibration

Materials Fatigue Strength Factor (Kf) (p. 1333)


Loading Type (p. 1333)

Loading Ratio (p. 1333): only appears if the Type property is set to Ratio.

History Data Location (p. 1333): only appears if the Type property is set to History
Data.

Scale Factor (p. 1334)


Definition Display Time: enter a time value (within the analysis time limit) to display results
at that moment of the analysis.
Options Analysis Type (p. 1334)

Mean Stress Theory (p. 1334)

Stress Component (p. 1334)

Bin Size (p. 1336): only appears if the Type property is set to History Data.

Use Quick Rainflow Counting (p. 1336): only appears if the Type property is set
to History Data.

Infinite Life (p. 1336): only appears if the Analysis Type property is set to Strain
Life; or if the Analysis Type property is set to Stress Life and the Type property
is set to History Data.

Maximum Data Points To Plot (p. 1336): only appears if the Type property is set
to History Data.
Life Units Units Name (p. 1335)

1 cycle is equal to (p. 1336)

For a Random Vibration analysis, the Details of the Fatigue Tool include:

Category Properties/Description
Domain Domain Type: this read-only property displays the following content based on
the analysis type.

• Time: Static or Transient Structural

• Time - Harmonic: Harmonic Response

• Frequency: Random Vibration

Release 2020 R1 - © ANSYS, Inc.


1694
Fatigue Tool (Group)

Options Method Selection: This setting specifies the method to calculate the Probability
Density Function (PDF) from the available PSD stress response.

Stress Component (p. 1334)

Exposure Duration: This setting specifies the time duration for which the loading
is applied. The resulting damage is for this entire duration. By default, this is set
to 1 second This means that the calculated damage is damage per second.

Properties for the Contour Results Menu Options


The properties for the Contour Results menu options (Life, Damage, Safety Factor, Biaxiality Indica-
tion, and Equivalent Alternating Stress) include:

Category Properties/Description
Scope Scoping Method: Specify as Geometry Selection (default), Named Selection,
Path, or Surface. Based on your selection, related properties display.

Geometry: Displayed when the Scoping Method is set to Geometry


Selection (default). Displays the type of geometry and the number of
bodies to which the object has been applied using the selection tools.
Use selection filters (p. 126) to pick geometry (p. 125), click in the Geometry
field, then click Apply.
Named Selection: Displays when the Scoping Method is set to Named
Selection. Select a user-defined Named Selection from the drop-down
list.
Path: Displays when the Scoping Method is set to Path. Select a defined
path (p. 661) from the drop-down list.
Surface: Displays when the Scoping Method is set to Surface. Select a
defined surface (p. 666) from the drop-down list.

Geometry: When you specify Path or Surface as the Scoping Method, this
additional property displays in the Scope category. Use selection filters (p. 126)
to pick geometry (p. 125), click in the Geometry field, then click Apply.
Definition Design Life: this property is only available for the Damage and Safety Factor
objects.

Type: this property is a read-only indication of fatigue object name.

Identifier

Suppressed: Suppress the object as desired.


Integration Average Across Bodies: This property enables you to average results across
Point Res- separate bodies. The default setting is No.
ults
Results Minimum: available for Life, Safety Factor, Biaxiality Indication, Equivalent
(read-only Alternating Stress.
indications
of min/max) Minimum Occurs On: available for Life, Safety Factor, Biaxiality Indication,
Equivalent Alternating Stress.

Release 2020 R1 - © ANSYS, Inc.


1695
Objects Reference

Maximum: available for Damage, Biaxiality Indication, Equivalent Alternating


Stress.

Maximum Occurs On: available for Damage, Biaxiality Indication, Equivalent


Alternating Stress.
Information - Reported Frequency
only available for
Harmonic
Response
analyses.

Properties for the Graph Results Menu Options


The properties for the Graph Results menu options (Rainflow Matrix, Damage Matrix, Fatigue
Sensitivity, and Hysteresis) include:

Category Properties/Description
Scope Geometry: Use selection filters (p. 126) to pick geometry (p. 125), click in the
Geometry field, then click Apply.
Definition Sensitivity For: only available for the Fatigue Sensitivity object.

Design Life: only available for the Damage Matrix object and the Fatigue
Sensitivity object if the Sensitivity For property is set to Damage or Safety
Factor.

Suppressed
General Stress Strain Type: if this property is set to Shear Stress, the General, Options,
and Results categories are replaced by a Definition category that includes a
Type setting.
Options Lower Variation: available only for Fatigue Sensitivity.

Upper Variation: available only for Fatigue Sensitivity.

Number of Fill Points: available only for Fatigue Sensitivity.

Chart Viewing Style: available only for Damage Matrix, Fatigue Sensitivity,
and Rainflow Matrix.

Points per Segment: available only for Hysteresis.


Results - The following are only available for Damage Matrix and Rainflow Matrix options:
available only for
Damage Matrix, • Minimum Range
Hysteresis, and
Rainflow Matrix. • Maximum Range
Read-only
• Minimum Mean
indication of the
following • Maximum Mean
quantities.
The following are only available for the Hysteresis option:

• Minimum Strain

Release 2020 R1 - © ANSYS, Inc.


1696
Figure

Category Properties/Description
• Maximum Strain

• Minimum Stress

• Maximum Stress

Figure
Captures any graphic displayed for a particular object in the Geometry window. A Figure object can
be further manipulated (rotated for example), unlike an Image (p. 1706) object, which is a static screen
shot of the current model view or an imported static figure. Popular uses of a Figure object are for
presenting specific views and settings for later inclusion in a report (p. 31).

Note

The Figure feature supports the Body Color option only for the Display Style property
when capturing figures on the Mesh (p. 1749) object.

Tree Dependencies:

• Valid Parent Tree Object: All objects except Alert (p. 1632), Commands (p. 1652),
Comment (p. 1654), Convergence (p. 1676), Image (p. 1706), Project (p. 1795), Result
Tracker (p. 1802), Solution Combination (p. 1820), Solution Information (p. 1820)

• Valid Child Tree Objects: None

Insertion Method: Click the New Figure or Image button on standard


toolbar (p. 69) and select Figure.

Additional Related Information:

• Inserting Comments, Images, and Figures (p. 166)

• Viewports (p. 150)

• Reports (p. 31)

• Standard Toolbar (p. 69)

Object Properties
Caption (p. 166) is the only property available for the Figure object. It provides an editable text field.

Release 2020 R1 - © ANSYS, Inc.


1697
Objects Reference

Fluid Surface
Fluid Surface objects allow you to identify faces that should be grouped together in support of a vir-
tual body for assembly meshing.

Note

Virtual Body and Fluid Surface objects are fluids concepts, and as such they are not sup-
ported by Mechanical solvers.

Tree Dependencies:

• Valid Parent Tree Objects: Virtual Body (p. 1841)

Insertion Options: Use any of these methods:

Highlight the Virtual Body (p. 1841) object, and then:

• In the Details view for the Virtual Body, set Used By


Fluid Surface to Yes.

• Click the right mouse button and select Insert> Fluid


Surface from the context menu.

Additional Related Information:

• Meshing Capabilities in Workbench

• Mesh Context Toolbar (p. 82)

• Assembly Meshing

• Defining Virtual Bodies

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Scope Faces To Group - Set of faces that should be members of the
group.
Master Virtual Body - Read-only name of the master Virtual
Body.
Priority - Determines which group will claim cells in cases
where groups overlap. The priority is initially based on the
rule: the smaller the volume, the higher the priority.
Definition Suppressed - Read-only setting inherited from the Virtual
Body.

Release 2020 R1 - © ANSYS, Inc.


1698
Fracture

Fracture
Represents all definitions of cracks within a model. Each definition is represented in a Semi-Elliptical
Crack (p. 1813), Arbitrary Crack (p. 1636), or Pre-Meshed Crack (p. 1791) object, where a Semi-Elliptical
Crack or an Arbitrary Crack is generated internally within the Mechanical application or Meshing ap-
plication, while a Pre-Meshed Crack comes from an external source. May contain any number of Semi-
Elliptical Crack (p. 1813), Arbitrary Crack (p. 1636), or Pre-Meshed Crack (p. 1791) objects.

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Semi-Elliptical


Crack (p. 1813), Arbitrary Crack (p. 1636), Pre-
Meshed Crack (p. 1791), Interface Delamina-
tion (p. 1741), and Contact Debonding (p. 1667)

Insertion Options: Click right mouse button


on Model (p. 1767) object and select Insert>
Fracture.

Note

• Only one Fracture object is valid


per Model (p. 1767).

• You need to regenerate the base


mesh for all bodies if you delete
a Fracture object that includes
cracks (Semi-Elliptical Crack or
an Arbitrary Crack) for which the
application internally generates
crack meshes.

Additional Related Information:

• Fracture Analysis (p. 841)

• Interface Delamination and Contact


Debonding (p. 865)

The following right mouse button context menu options are available for this object.

• Insert>Arbitrary Crack (p. 1636)

• Insert>Semi-Elliptical Crack (p. 1813)

• Insert>Pre-Meshed Crack (p. 1791)

• Insert>Interface Delamination (p. 1741)

• Insert>Contact Debonding (p. 1667)

Release 2020 R1 - © ANSYS, Inc.


1699
Objects Reference

• Generate All Crack Meshes

• Delete

• Rename

Fracture Tool (Group)


The Fracture Tool enables you to examine fracture results in Mechanical.

Tree Dependencies:

• Valid Parent Tree Objects:

– The Solution (p. 1817) object is the only valid parent object.

• Valid Child Tree Objects:

– There are a number of fracture-specific result objects associated with this


tool. See the Defining a Fracture Result (p. 1264) section of the Help for
information about these result objects.

– Commands (p. 1652)

Insertion Options:

• Select the Solution object and either:

– Select the Fracture Tool option from the Tools drop-down menu on the
Solution context toolbar (p. 84).

– Right-click the Solution object or in the Geometry window and select In-
sert>Fracture Tool.

Additional Related Information:

• Fracture Results (p. 1261)

• Adding a Fracture Tool (p. 1263)

• Defining a Fracture Result (p. 1264)

The following right mouse button context menu options are available for this object.

• Insert>Fracture results (p. 1261)

• Evaluate All Results (p. 1212): available for Fracture Tool and all child objects when the tool is inserted under
a Solution (p. 1817) object.

• Suppress/Unsuppress

• Duplicate

• Delete

Release 2020 R1 - © ANSYS, Inc.


1700
Geometry

• Rename

• Group (p. 100)

Object Properties
For information specific to this object's properties, see the Fracture Results (p. 1261) section of the Help.

Gasket Mesh Control


Available when Body (p. 1644) object's Stiffness Behavior is set to Gasket. The control applies a sweep
mesh in a chosen direction and drops midside nodes on gasket elements that are parallel to the sweep
direction.

Tree Dependencies:

• Valid Parent Tree Object: Body (p. 1644)

• Valid Child Tree Objects: None.

Insertion Options: Appears automatically when


a Body (p. 1644) object's Stiffness Behavior is
set to Gasket.

Additional Related Information:

• Gasket Bodies (p. 482)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Defini- Free Face Mesh Type
tion (p. 483) Mesh Method
Element Order
Scope (p. 483) Src/Trg Selection
Source
Target

Geometry
Represents attached geometry in the form of an assembly or multibody part (p. 477) from a CAD system
or from DesignModeler. Assembly parameters, if available, are viewable under the Geometry object.

Release 2020 R1 - © ANSYS, Inc.


1701
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706), Layered Section (p. 1745),
Part (p. 1781), Point Mass (p. 1789), Surface Coat-
ing (p. 507), or Thickness (p. 1834)

Insertion Options: Appears by default with a


Model (p. 1767) object.

Additional Related Information:

• Specifying Geometry in the Mechanical


Application (p. 477)

• Attach Geometry (p. 174)

The following right mouse button context menu options are available for this object.

• Search Faces with Multiple Thicknesses (p. 497)

• Export (p. 54). Options include:

– Geometry: exports the CAD geometry to a binary Part Manager Database (.pmdb) file. This option enables
you to export your entire geometry, individual parts, and/or multiple parts. This option does not support
export at the body level of the geometry - only the part that includes the body. This export option facilitates
future geometry import into SpaceClaim, DesignModeler, as well as re-importing the file back into
Mechanical.

– ANSYS Viewer File (AVZ): export result data as a ANSYS Viewer File (.avz)

– STL File: exports object information in Standard Tessellation Language (STL) file format (ASCII only). This
option is only available when the Export Format property of the Export preferences (p. 110) is set to ASCII.

• Update Geometry from Source (p. 176)

• Reset Body Colors (p. 486)

• Show Missing Tessellations

• Insert > Virtual Body

Note

Virtual Body and Fluid Surface objects are fluids concepts, and as such they are not sup-
ported by Mechanical solvers.

Object Properties
The Details view (p. 17) properties for this object include the following.

Release 2020 R1 - © ANSYS, Inc.


1702
Geometry

Category Properties
Definition Source: read-only indication of the path and file name associated with
the geometry.
Type: read-only indication of how the original geometry was created
(CAD product name or DesignModeler).
Length Unit: This property displays the length unit assigned to the
geometry. For most imported geometries, the field is read-only because
the unit is defined by the CAD system during import. An exception
includes ACIS geometries when length units are not specified. For ACIS
geometries without specified length units, the application sets the length
unit to the display units and enables you to change the units from the
given drop-down menu.
Element Control: Allows manual control of the underlying Mechanical
APDL element options (KEYOPTS) for individual Part or Body objects
beneath the Geometry object. To manually set Mechanical APDL element
options, set Element Control to Manual, then select the Part or Body
object. Any element options that are available for you to manually set
appear in the Details view of the Part or Body object. For example, the
Brick Integration Scheme (p. 484) setting for a Part or Body object
becomes available only when Element Control is set to Manual. When
Element Control is set to Program Controlled, all element options are
automatically controlled and no settings are displayed. The Mechanical
APDL application equivalent to this setting is the inclusion of the
ETCON,SET command in the input file, which automatically resets options
for current-technology elements to optimal settings. Refer to the
Mechanical APDL Element Reference in the Mechanical APDL Help for
more information about Mechanical APDL elements and element options.
Display Style (p. 486): The default is Body Color which assigns unique
colors to individual bodies in a part. Other choices include Part Color,
Assembly Color (Model assembly only), Shell Thickness (surface bodies
only), Material, Nonlinear Material Effects, Stiffness Behavior, and
By Cross Section (line bodies only).
2D Behavior: Appears only for a designated 2D simulation (p. 502).
Bounding Length X
Box (p. 181) Length Y
Length Z
Properties Volume: Read-only property.
Mass: Read-only property. Appears only in the Mechanical application.

Note

• The Volume and Mass properties display with "N/A" (Not


Applicable) in their field when thickness objects (Thickness,
Layered Thickness, Imported Layered Thickness) are present.
In addition, if displayed as NA and the properties are
parameterized, the parameter value is set to zero. This includes
parameter values defined in Workbench.

• 2D surface bodies are dependent upon the 2D Behavior setting


of the Geometry object. Any setting other than the Plane Stress

Release 2020 R1 - © ANSYS, Inc.


1703
Objects Reference

Category Properties

setting causes the above properties to display with the content


"N/A" in their field. However, when the 2D Behavior property
is set to By Body, you can change the setting of the Behavior
property for each surface body object individually. These
individual settings affect what is displayed in the fields of the
Volume and Mass properties.

• If the material density is temperature dependent, the Mass will


be computed at the body temperature, or at 22° C (default
temperature for an environment).

• Any suppressed (p. 13) Part or Body objects are not included
in the Volume and Mass property values that are displayed.

Surface Area (approx.): Read-only property. Displays the approximate


surface area of the geometry. This value changes when parts or bodies
are suppressed.
Scale Factor Value: The value applied to imported geometry for the
purpose of modifying the size of the model. The scale factor value of
newly imported geometry is 1.0. You can modify this value. Values
changes are expected to be preserved on updated models. Due to
tolerances, models that are scaled (especially larger) sometimes have
problems meshing. The scale factor limit is from 1e-3 to 1e3. Factors
entered beyond that range are ignored.

Note

• Beam sections and shell thicknesses are not affected by the


Scale Factor Value.

• Geometry scale factors should not be applied after virtual cells


have been added to the model. Doing so may result in mesh
failure.

Statistics: - Bodies
Read-only Active Bodies
indication of the Nodes
entities that Elements
comprise the Mesh Metric
geometry. Active
Bodies are those
that are
unsuppressed (p. 13)
compared to the
total number of
Bodies.

Release 2020 R1 - © ANSYS, Inc.


1704
Global Coordinate System

Category Properties
Basic Geometry Solid Bodies
Options Surface Bodies
Line Bodies
Parameters
Parameter Key
Attributes
Named Selections
Material Properties
Advanced Geo- Use Associativity
metry Options Coordinate Systems
Reader Mode Saves Updated File
Use Instances
Smart CAD Update
Compare Parts on Update
Attach File Via Temp File
Temporary Directory
Analysis Type
Mixed Import Resolution
Decompose Disjoint Geometry
Enclosure and Symmetry Processing

Global Coordinate System


Represents the default coordinate system. The origin is defined as 0,0,0 in the model coordinate system.
This location serves as the reference location for any local Coordinate System (p. 1677) objects inserted
under the Global Coordinate System object.

Tree Dependencies:

• Valid Parent Tree Object: Coordinate Systems (p. 1680)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Im-
age (p. 1706)

Insertion Options: Automatically inserted in the tree.

Additional Related Information:

• Coordinate Systems (p. 671)

• Creating Coordinate Systems (p. 671)

The following right mouse button context menu options are available for this object.

• Create Section Plane (p. 154)

• Create Construction Surface (p. 666)

Object Properties
The Details view (p. 17) properties for this object include the following.

Release 2020 R1 - © ANSYS, Inc.


1705
Objects Reference

The following are all read-only status indications of the global coordinate system:

Category Properties
Definition Type
Mechanical APDL System Number - assigns the coordinate system
reference number (the first argument of the Mechanical APDL LOCAL
command).
Origin Origin X
Origin Y
Origin Z
Directional Vec- X Axis Data
tors Y Axis Data
Z Axis Data

Image
Inserts a screen shot of the model in its current view or imports any image in .bmp, .jpg, or png format
under a parent object. Its use is similar to inserting a Comment (p. 1654) object. Inserted images appear
in the Report (p. 31). Image is a static picture of the current model view. It differs from the Figure (p. 1697)
object, which is also a picture of the current model view that can be further manipulated (rotated for
example).

Note

Duplicating an image in the tree will result in both the original object and the copied object
using the same image file on disk. Altering or deleting either the original or the copied object
will result in modification and/or deletion of the image file on disk. Both items in the tree
will be affected by the change to one of the objects.

Tree Dependencies:

• Valid Parent Tree Objects:

– For importing images: All objects

– For static image captures: Same parent tree objects as for Figure (p. 1697)

• Valid Child Tree Object: Comment (p. 1654)

Insertion Method: Click the New Figure or Image button on the standard
toolbar (p. 69) and select Image. For importing an image, choose Image
from File, then choose an image file from the browse window. Filters are
available for listing only image files in .bmp, .jpg, or.png formats.

Additional Related Information:

• Inserting Comments, Images, and Figures (p. 166)

• Reporting (p. 31)

Release 2020 R1 - © ANSYS, Inc.


1706
Imported: Constraint Equations or Coupling

Imported: Constraint Equations or Coupling


The Constraint Equations object provides access to an external system’s data that includes constraint
equations and couplings. The import process places this object under an Imported folder beneath the
Connections parent folder.

Tree Dependencies:

• Valid Parent Tree Objects: the generic Imported folder is automatically generated during the import
process.

• Valid Child Tree Object: no supported child objects.

Insertion Method: this is an automatically generated object of the External Model feature.

Additional Related Information:

• Importing Mesh-Based Databases (p. 522)

• Imported Constraint Equations (p. 530)

• External Model

The following right mouse button context menu options are available for this object:

• Export Text File (p. 54)

• Suppress

• Group (p. 100)

• Remove from Group (p. 100)

Release 2020 R1 - © ANSYS, Inc.


1707
Objects Reference

Object Properties
The Details view properties for this object include the following.

Category Property/Description
Definition Suppressed: Yes or No (default).
Graphics Constraint Equation: This property enables you to pick the graphics display color of the
Properties associated data.
Show Rows: The options include None, From Current Page (default), and From All Pages.
Transfer Source: read-only display of the name of the source system file.
Properties Read Only: Yes or No (default).

Worksheet Properties
The columns of the Worksheet display the following imported source data:

Property Description
ID This field displays the element ID contained in the source input file.
Equation This field displays the associated constraint equation.
Coupling This field displays the coupled degrees of freedom.
DOF

Imported: Contacts
For a source file that includes surface to surface contact, from either solid or shell bodies, the Contacts
object provides access to an external system’s data that includes contacts. The import process places
this object under an Imported folder beneath the Connections parent folder.

Tree Dependencies:

• Valid Parent Tree Objects: the generic Imported folder is automatically generated during the import
process.

• Valid Child Tree Object: no supported child objects.

Insertion Method: this is an automatically generated object of the External Model feature.

Additional Related Information:

Release 2020 R1 - © ANSYS, Inc.


1708
Imported: Contacts

• Importing Mesh-Based Databases (p. 522)

• Imported Contacts (p. 532)

• External Model

The following right mouse button context menu options are available for this object:

• Edit Items > Type > [Type Options (p. 701)]

• Edit Items > Behavior > [Behavior Options (p. 703)]

• Edit Items > Formulation > [Formulation Options (p. 707)]

• Filter Worksheet Based on State > Underdefined

• Filter Worksheet Based on State > Suppressed

• Suppress

• Group (p. 100)

• Remove from Group (p. 100)

Object Properties
The Details view properties for this object include the following.

Category Property/Description
Definition Suppressed: Yes or No (default).
Graphics Show Rows: The options include None, From Current Page (default), and From All Pages.
Properties
Transfer Source: read-only display of the name of the source system file.
Properties Read Only: Yes or No (default).

Worksheet Properties
The columns of the Worksheet display the imported source data listed below.

Note

The Worksheet view for the Imported Contacts only provides the basic options for controlling
contact behavior, and all the advanced options are treated as Program Controlled. For ad-
vanced control on Imported Contacts, use the Promote feature to create native Contact Region
objects (p. 1669) in the tree Outline and then edit the appropriate fields as desired.

Property Description
ID This field displays the element ID contained in the source input file.
Source This field displays the element set associated with the contact side of the pair.
Target This field displays the element set associated with the target side of the pair.

Release 2020 R1 - © ANSYS, Inc.


1709
Objects Reference

Property Description
Type This field displays the contact Type (p. 701) specified in the source file. You can change the
Type setting using the drop-down menu.
Behavi- This field displays the Behavior (p. 703) of the contact pair specified in the source file. You
or can change the Behavior setting using the drop-down menu.
Fric- This field displays the Friction Coefficient imported from the source file for frictional contact
tion applications. You can edit this field. It is displayed only for frictional contact applications.
Coeffi- It is applicable only for frictional contact applications. If multiple load steps are included
cient in the source file, only the Friction Coefficient from the first load step is imported.
Formu- This field displays the Formulation (p. 707) specified in the source file. You can change the
lation Formulation setting using the drop-down menu.
Thermal This field applies to thermal analyses or a structural analysis linked to a thermal analysis.
Con- You can edit this field and enter a positive (only) Thermal Conductance value. The Units
duct- for this value are based on the types of contact involved. For 3D element faces, the units
ance are HEAT/(TIME * TEMPERATURE* AREA).

Imported: Coordinate Systems


The Coordinate Systems object provides access to an external system’s data that includes coordinate
systems. The import process places this object under an Imported folder beneath the Connections (p. 1663)
parent folder.

Tree Dependencies:

• Valid Parent Tree Objects: the generic Imported folder is automatically generated during the import
process.

• Valid Child Tree Object: no supported child objects.

Insertion Method: this is an automatically generated object of the External Model feature.

Release 2020 R1 - © ANSYS, Inc.


1710
Imported: Element Orientations

Additional Related Information:

• Importing Mesh-Based Databases (p. 522)

• Imported Coordinate Systems (p. 533)

• External Model

The following right mouse button context menu options are available for this object:

• Export Text File (p. 54)

• Suppress

• Group (p. 100)

• Remove from Group (p. 100)

Object Properties
The Details view properties for this object include the following.

Category Property/Description
Definition Suppressed: Yes or No (default).
Graphics Show Rows: The options include None, From Current Page (default), and From All
Properties Pages.
Transfer Source: read-only display of the name of the source system file.
Properties Read Only: Yes or No (default).

Worksheet Properties
The columns of the Worksheet display the following imported source data:

Property Description
ID This field displays the element ID contained in the source input file.
Type This field displays the type of coordinate system (Cartesian or Cylindrical).
Origin This field displays the Location.
X Axis This field displays the position of the X coordinate.
Data
Y Axis This field displays the position of the Y coordinate.
Data
Z Axis This field displays the position of the Z coordinate.
Data

Imported: Element Orientations


The Element Orientations object provides access to an external system’s data that includes element
orientations. The import process places this object under an Imported folder beneath the Geometry
parent folder.

Release 2020 R1 - © ANSYS, Inc.


1711
Objects Reference

Tree Dependencies:

• Valid Parent Tree Objects: the generic Imported folder is automatically generated during the import
process.

• Valid Child Tree Object: no supported child objects.

Insertion Method: this is an automatically generated object of the External Model feature.

Additional Related Information:

• Importing Mesh-Based Databases (p. 522)

• Imported Element Orientations (p. 535)

• External Model

• Element Orientations (p. 570)

The following right mouse button context menu options are available for this object:

• Export Text File (p. 54)

• Suppress

• Group (p. 100)

• Remove from Group (p. 100)

Object Properties
The Details view properties for this object include the following.

Release 2020 R1 - © ANSYS, Inc.


1712
Imported: Flexible Remote Connectors

Category Property/Description
Definition Suppressed: Yes or No (default).
Graphics Show Rows: The options include None, From Current Page (default), and From All
Properties Pages.
Transfer Source: read-only display of the name of the source system file.
Properties Read Only: Yes or No (default).

Worksheet Properties
The columns of the Worksheet display the following imported source data:

Property Description
ID This field displays the element ID contained in the source input file.
Element Set This field displays the number of elements within the set.
Coordinate This field displays the coordinate of the element.
System

Imported: Flexible Remote Connectors


Based on the stiffness of the external data provided, the Flexible Remote Connectors object provides
access to an external system’s data that includes flexible remote connections. The import process places
these objects under an Imported folder beneath the Connections parent folder.

Tree Dependencies:

• Valid Parent Tree Objects: the generic Imported folder is automatically generated during the import
process.

• Valid Child Tree Object: no supported child objects.

Insertion Method: this is an automatically generated object of the External Model feature.

Release 2020 R1 - © ANSYS, Inc.


1713
Objects Reference

Additional Related Information:

• Importing Mesh-Based Databases (p. 522)

• Imported Flexible Remote Connections (p. 539)

• External Model

The following right mouse button context menu options are available for this object:

• Export Text File (p. 54)

• Suppress

• Group (p. 100)

• Remove from Group (p. 100)

Object Properties
The Details view properties for this object include the following.

Category Property/Description
Defini- Suppressed: Yes or No (default).
tion
Graphics Color: enables you to pick graphics display color.
Proper- Show Rows: The options include None, From Current Page (default), and From All Pages.
ties
Transfer Source: read-only display of the name of the source system file.
Proper- Read Only: Yes or No (default).
ties

Worksheet Properties
The columns of the Worksheet display the following imported source data:

Property Description
Type This column indicates the type of connection from the imported file. For CDB files,
the column displays Remote Point. For ABAQUS files, the column displays Distributed
Coupling. For NASTRAN files, the column displays RBE3.
ID This column displays the element Identifier from the source file.
Refer- This value is the ID of the node that is attached to the participating nodes. You can
ence edit this property to assign a custom name to the Reference Node Id. The
Node corresponding node is identified by the specified name in the solver file and can be
ID accessed using command snippets. See the Reference Node Naming (p. 526) topic for
additional information.
DOFs Degrees of Freedom (DOFs) for the connectors.
Parti- This is a listing of the number of nodes (or Node ID for a single node) that are
cipat- connected to the Reference Node through force-distributed constraint.
ing
Nodes

Release 2020 R1 - © ANSYS, Inc.


1714
Imported: Nodal Orientations

Property Description
Weight This entry determines the type of weight participation. This field provides a drop-down
Parti- list of options, however, based on the data contained in the source file, the application
cipat- makes a default selection. Options include:
ing
Factor • Uniform

• User Defined

• Program Controlled

The nodes can have Uniform participation or user-defined weights or Linear


participation (in case of Distributed Coupling). For example, Uniform weight
participation indicates that the force is distributed uniformly on to the participating
nodes.

Imported: Nodal Orientations


The Nodal Orientations object provides access to an external system’s data that includes nodal orient-
ations. The import process places this object under an Imported folder beneath the Geometry parent
folder.

Tree Dependencies:

• Valid Parent Tree Objects: the generic Imported folder is automatically generated during the import
process.

• Valid Child Tree Object: no supported child objects.

Insertion Method: this is an automatically generated object of the External Model feature.

Additional Related Information:

Release 2020 R1 - © ANSYS, Inc.


1715
Objects Reference

• Importing Mesh-Based Databases (p. 522)

• Imported Nodal Orientations (p. 541)

• External Model

• Specifying Named Selections in the Mechanical Application (p. 583)

The following right mouse button context menu options are available for this object:

• Export Text File (p. 54)

• Suppress

• Group (p. 100)

• Remove from Group (p. 100)

Object Properties
The Details view properties for this object include the following.

Category Property/Description
Definition Suppressed: Yes or No (default).
Graphics Show Rows: The options include None, From Current Page (default), and From All
Properties Pages.
Transfer Source: read-only display of the name of the source system file.
Properties Read Only: Yes or No (default).

Worksheet Properties
The columns of the Worksheet display the following imported source data:

Property Description
ID This field displays the node ID contained in the source input file.
Location This field indicates the X, Y, Z coordinates of the source node relative to the Global
Coordinate system.
Orienta- This field indicates the Euler angles of the source node relative to the Global
tion Coordinate system.

Imported: Point Masses


The Point Masses object provides access to an external system’s data that includes point masses. The
import process places this object under an Imported folder beneath the Geometry parent folder.

Release 2020 R1 - © ANSYS, Inc.


1716
Imported: Point Masses

Important

If your Imported Point Mass is connected to a body through an imported connection, i.e.
Remote Connection, Constraint Equation, or Spring, Mechanical does not include the Imported
Point Mass in any Rotational Velocity or Rotational Acceleration scoping.

Tree Dependencies:

• Valid Parent Tree Objects: the generic Imported folder is automatically generated during the import
process.

• Valid Child Tree Object: no supported child objects.

Insertion Method: this is an automatically generated object of the External Model feature.

Additional Related Information:

• Importing Mesh-Based Databases (p. 522)

• Imported: Point Mass (p. 541)

• External Model

• Point Mass (p. 505)

The following right mouse button context menu options are available for this object:

• Export Text File (p. 54)

• Suppress

• Group (p. 100)

• Remove from Group (p. 100)

Release 2020 R1 - © ANSYS, Inc.


1717
Objects Reference

Object Properties
The Details view properties for this object include the following.

Category Property/Description
Definition Suppressed: Yes or No (default).
Graphics Color: enables you to pick graphics display color.
Properties Show Rows: The options include None, From Current Page (default), and From All Pages.
Transfer Source: read-only display of the name of the source system file.
Properties Read Only: Yes or No (default).

Worksheet Properties
The columns of the Worksheet display the following imported source data:

Property Description
ID This field displays the command identifier from the source input file.
Reference This field displays the node ID contained in the Nastran or Abaqus source file.
Node Id The corresponding node is identified by the specified name in the solver file and
can be accessed using command snippets. See the Reference Node Naming (p. 526)
topic for additional information.
Location This field displays the location of the point mass.
Mass Total mass of the point mass.
Mass Mo- This field displays the mass moment of inertia in the X/Y/Z direction measure
ment of In- with respect to the nodal coordinate system.
ertia X/Y/Z
Mass Mo- This field displays the mass moment of inertia with respect to the XY plane in
ment of In- the nodal coordinate system.
ertia XY
Mass Mo- This field displays the mass moment of inertia with respect to the XZ plane in
ment of In- the nodal coordinate system.
ertia XZ
Mass Mo- This field displays the mass moment of inertia with respect to the YZ plane in
ment of In- the nodal coordinate system.
ertia YZ
Offset The distance between the nodal location and the center of mass in the X/Y/Z
X/Y/Z direction. Any non-zero value is invalid. You can change the value in this field.

Imported: Rigid Remote Connectors


Based on the stiffness of the external data provided, the Rigid Remote Connectors object provides
access to an external system’s data that includes rigid remote connections. The import process places
these objects under an Imported folder beneath the Connections parent folder.

Release 2020 R1 - © ANSYS, Inc.


1718
Imported: Rigid Remote Connectors

Tree Dependencies:

• Valid Parent Tree Objects: the generic Imported folder is automatically generated during the import
process.

• Valid Child Tree Object: no supported child objects.

Insertion Method: this is an automatically generated object of the External Model feature.

Additional Related Information:

• Importing Mesh-Based Databases (p. 522)

• Imported Rigid Remote Connections (p. 543)

• External Model

The following right mouse button context menu options are available for this object:

• Export Text File (p. 54)

• Suppress

• Group (p. 100)

• Remove from Group (p. 100)

Object Properties
The Details view properties for this object include the following.

Category Property/Description
Definition Suppressed: Yes or No (default).
Graphics Color: enables you to pick graphics display color.
Properties

Release 2020 R1 - © ANSYS, Inc.


1719
Objects Reference

Category Property/Description
Show Rows: The options include None, From Current Page (default), and From All Pages.
Transfer Source: read-only display of the name of the source system file.
Properties Read Only: Yes or No (default).

Worksheet Properties
The columns of the Worksheet display the following imported source data:

Property Description
Type This column indicates the type of connection from the imported file. For CDB files,
the column displays Remote Point. For ABAQUS files, the column displays Kinematic
Coupling. For NASTRAN files, the column displays RBE2.
ID This column displays element identifier from the source file for NASTRAN or ABAQUS.
For CDB, it is the real constant ID.
Refer- This value is the ID of the node that is attached to the participating nodes. You can
ence edit this property to assign a custom name to the Reference Node Id. The
Node corresponding node is identified by the specified name in the solver file and can be
ID accessed using command snippets. See the Assigning Custom Names to Reference
Nodes and Accessing them in Solver File (p. 526) topic for additional information.
DOFs Degrees of Freedom (DOFs) for the connectors.
Parti- This is a listing of the number of nodes (or Node ID for a single node) that are
cipat- constrained to the Reference node for translation and rotation.
ing
Nodes

Imported: Shell Thicknesses


The Shell Thicknesses object provides access to an external system’s data that includes shell thicknesses.
The import process places this object under an Imported folder beneath the Geometry parent folder.

Tree Dependencies:

Release 2020 R1 - © ANSYS, Inc.


1720
Imported: Spring Connectors

• Valid Parent Tree Objects: the generic Imported folder is automatically generated during the import
process.

• Valid Child Tree Object: no supported child objects.

Insertion Method: this is an automatically generated object of the External Model feature.

Additional Related Information:

• Importing Mesh-Based Databases (p. 522)

• Imported Shell Thickness (p. 544)

• External Model

The following right mouse button context menu options are available for this object:

• Suppress

• Group (p. 100)

• Remove from Group (p. 100)

Object Properties
The Details view properties for this object include the following.

Category Property/Description
Definition Suppressed: Yes or No (default).
Graphics Show Rows: The options include None, From Current Page (default), and From All
Properties Pages.
Transfer Prop- Source: read-only display of the name of the source system file.
erties Read Only: Yes or No (default).

Worksheet Properties
The columns of the Worksheet display the following imported source data:

Property Description
ID This column displays the element Identifier from the source input file.
Element Set The number of elements within the set.
Sheet Thick- The thickness of the sheet specified in the source file.
ness
Offset Type Drop-down menu of offset options (p. 489), including Top, Bottom, Middle, and
User Defined.
Sheet Offset You use this property when the Offset Type is User Defined.

Imported: Spring Connectors


The Spring Connectors object provides access to an external system’s data that includes springs. The
import process places this object under an Imported folder beneath the Connections parent folder.

Release 2020 R1 - © ANSYS, Inc.


1721
Objects Reference

Tree Dependencies:

• Valid Parent Tree Objects: the generic Imported folder is automatically generated during the import
process.

• Valid Child Tree Object: no supported child objects.

Insertion Method: this is an automatically generated object of the External Model feature.

Additional Related Information:

• Importing Mesh-Based Databases (p. 522)

• Imported Springs (p. 1721)

• External Model

The following right mouse button context menu options are available for this object:

• Suppress

• Group (p. 100)

• Remove from Group (p. 100)

Object Properties
The Details view properties for this object include the following.

Category Property/Description
Definition Suppressed: Yes or No (default).
Graphics Color: enables you to pick graphics display color of grounded as well as non-grounded
Properties springs.

Release 2020 R1 - © ANSYS, Inc.


1722
Imported Plies

Category Property/Description
Show Rows: The options include None, From Current Page (default), and From All Pages.
Transfer Source: read-only display of the name of the source system file.
Properties Read Only: Yes or No (default).

Worksheet Properties
The columns of the Worksheet display the following imported source data:

Property Description
Type This column indicates the type of connection from the imported source file. Options
include:

• Single dof: This option indicates that the spring is being applied in the local nodal
coordinate system in a single degree of Freedom (DOF) direction (ux or uy or uz or
rotx or roty or rotz)

• Multi dof: This option indicates that the spring is being applied in more than one
DOF.

ID This column displays the node Identifier from the source input file.
Nodes This column indicates the nodes included with the spring. The nodes are contained
in braces ("{}") and the element ID associated with the displayed nodes precedes the
braces. For example, as shown in the image above, "nodes23{2, 104}" indicates element
ID 23 includes nodes 2 and 104. You can double-click this field and edit the application
assigned name.
Groun- If a field of this column indicates None, then the participating nodes are constrained.
ded If a field displays one of the node IDs, then that node ID is constrained in all DOFs.
node This column provides a drop-down list with the option None as well as a listing of
the node IDs.
Stiff- This column displays the stiffness constants in all DOFs or one DOF depending on the
ness Type of spring connector.
Damp- This column displays the structural damping coefficient applied in all DOFs or one
ing DOF depending on the Type of spring connector.

Imported Plies
The Imported Plies object provides ply/layer data that has been made available from an external system
upstream of the analysis system.

Release 2020 R1 - © ANSYS, Inc.


1723
Objects Reference

Tree Dependencies:

• Valid Parent Tree Objects: Model (p. 1767)

• Valid Child Tree Object: Com-


ment (p. 1654), Image (p. 1706)

Insertion Method:

• Appears automatically when


importing ply/layer data from an
external system.

Additional Related Information:

• Specifying Surface Body Layered


Sections (p. 494)

• Composite Analysis (p. 466)

• Composite Analysis Result Scoping (p. 1214)

• Composite Failure Tool (p. 1265)

• Analysis Ply (p. 1633)

The following right mouse button context menu options are available for child objects of an Imported
Plies object.

• Insert for Environment (p. 1214)

• Reset to ACP Ply Grouping: restore the original ply structure provided by ACP.

• Create Ply Named Selection: this option creates Worksheet-based Named Selections (p. 587) for all of
the child objects of the ply group.

• Suppress

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Definition Type: appears as Imported Plies and is a read-only field.

Release 2020 R1 - © ANSYS, Inc.


1724
Imported Load (Group)

Suppressed (p. 13): select Yes to suppress this object.

Note

The Suppression option is only available when the external


system shares the model with the downstream analysis
system.

Material Nonlinear Effects (p. 180): select Yes to include the nonlinear effects
from the material properties. The reference temperature specified for
the body on which a ply is defined is used as the reference temperature
for the plies.

Thermal Strain Effects (p. 180): select Yes to send the coefficient of
thermal expansion to the solver.

Note

These fields are not supported for an Explicit Dynamics


analysis.

Graphic Properties Layer to Display: defines which layer to display on the model. For
information on setting the Layer to Display see Viewing Individual
Layers (p. 495). Note that the layer number will correspond to the layer
number used by the Mechanical APDL solver, which may not match the
layer number of the system providing the layered data.

Note

This property is only available when the external system


shares the model with the downstream analysis system.

Imported Load (Group)


The Imported Load group includes the loads that you have imported from an earlier analysis and want
to apply in the present analysis. You can add valid loads under the Imported Load object folder.

Applies to: Imported Load folder object and all imported load child objects under the folder.

Release 2020 R1 - © ANSYS, Inc.


1725
Objects Reference

Tree Dependencies:

• Valid Parent Tree Objects: Any Environ-


ment (p. 1690) object.

• Valid Child Tree Object: Comment (p. 1654),


Image (p. 1706), imported load objects

Insertion Method: Appears by default


for specific analyses with data
transfer (p. 1133).

Additional Related Information:

• Imported Loads (p. 1133)

The following right mouse button context menu options are available for this object.

• Insert>[Imported Load Type (p. 1134) based on analysis]

• Suppress/Unsuppress

• Clear Generated Data (p. 1199)

• Delete

• Rename

• Group/Ungroup (p. 100)

• Group Similar Objects (p. 100)

• Refresh Imported Load (analysis type specific)

Object Properties
The Details view properties for the Imported Load folder object include the following.

Category Properties
Definition Type: read-only indication.

Interpolation Type: read-only indication.

Suppressed (p. 13)

Source: displays the name of the Source system.

Release 2020 R1 - © ANSYS, Inc.


1726
Imported Material Fields (Group)

Imported Material Fields (Group)


The Imported Material Fields group folder contains all of the Imported Material Field objects used
to import user-defined Field Variable values, created in the Engineering Data workspace, External Data.

Tree Dependencies:

• Valid Parent Tree Objects: Geometry


object.

• Valid Child Tree Object: Com-


ment (p. 1654), Figure (p. 1697), Im-
age (p. 1706), Imported Material
Field (p. 1728) objects.

Insertion Method: This object appears


automatically when you have a
properly specified External Data system
linked to the Mechanical Model cell on
the Workbench Project page.

Additional Related Information:

• Importing Material Fields (p. 569)

• External Data

• Imported Material Field (p. 1728) object

The following right mouse button context menu options are available for this object.

• Insert>Material Field

• Suppress/Unsuppress

• Clear Generated Data (p. 1199)

• Delete

• Rename

• Group/Ungroup (p. 100)

Object Properties
The Details view properties for the Imported Material Fields object folder include the following.

Category Properties
Defini- Type
tion A read-only description of the object type: Imported Data.

Interpolation Type
A read-only description of the Interpolation Type property.

Release 2020 R1 - © ANSYS, Inc.


1727
Objects Reference

Category Properties
Suppressed
Include or exclude the object in your analysis (Yes or No).

Imported Material Field


The Imported Material Field object enables you to import user-defined Field Variable values, created
in the Engineering Data workspace, from External Data.

Tree Dependencies:

• Valid Parent Tree Objects: Imported


Material Fields group

• Valid Child Tree Object: Com-


ment (p. 1654), Figure (p. 1697), Im-
age (p. 1706), Imported Material
Field (p. 1728) objects.

Insertion Method: This object appears


automatically as a child object of the
Imported Material Fields folder when
you have a properly specified External
Data system linked to the Mechanical
Model cell on the Workbench Project
page. To add additional Imported
Material Field objects:

• Select the Imported Material Field


option on the Geometry toolbar.

• Right-click on the Imported Material


Fields folder, or on an existing Impor-
ted Material Field object, or in the
Geometry window, and then select
Insert>Material Field.

Additional Related Information:

• Importing Material Fields (p. 569)

• External Data

• Imported Material Fields


Group (p. 1727) object

The following right mouse button context menu options are available for this object.

• Export (p. 54)>Export Text File

• Suppress/Unsuppress

Release 2020 R1 - © ANSYS, Inc.


1728
Imported Material Field

• Clear Generated Data (p. 1199)

• Delete

• Rename

• Group/Ungroup (p. 100)

Object Properties
The Details view (p. 17) properties for this object include but are not limited to the following. See
Appendix B. Data Transfer Mesh Mapping (p. 1879) for additional information about other categories and
settings for the Imported Material Field object.

Category Properties
Scope Scoping Method
Specify as Geometry Selection (default) or Named Selection.

Geometry
Displayed when the Scoping Method is set to Geometry Selection (default). Displays
the type of geometry and the number of bodies to which the object has been applied
using the selection tools. Use the selection filter to pick geometry, click in the Geo-
metry field, then click Apply.

Named Selection
Displays when the Scoping Method is set to Named Selection. This field provides a
drop-down list of available user-defined Named Selections.

Defini- Type
tion A read-only property that describes the object: Imported Material Field.

Apply To
This property enables you to specify whether the external values are mapped to the
elements or corner nodes of your model. The options for this property include: Elements
(default) and Corner Nodes.

Suppressed
Suppress the object as desired.

Graphics Display Material Field


Controls When you have more than one material field variable specified in the worksheet, this
option enables you to select the variable you wish to display.

Display Source Points


Toggle display of source point data. Options include Off (default) and On.

Display Source Point Ids


Toggle display of source point data identifiers. Options include Off (default) and On.

Display Interior Source Point


Toggle display of internal source point data. Options include Off (default) and On.

Release 2020 R1 - © ANSYS, Inc.


1729
Objects Reference

Category Properties
Settings Mapping Control
Options include Program Controlled (default) and Manual.

Mapping
A read-only property that describes the setting: Profile Preserving.

Weighting
A read-only property that describes the setting: Triangulation.

Transfer Type
A read-only property that describes the setting: Volumetric.

Legend Legend Range


Controls Options include Program Controlled (default) and Manual.

Minimum
This property displays when the Legend Range property is set to Manual. The default
setting is Program Controlled. Select the field to make a manual entry.

Maximum
This property displays when the Legend Range property is set to Manual. The default
setting is Program Controlled. Select the field to make a manual entry.

Minimum Source
A read-only property that describes the setting: Program Controlled.

Maximum Source
A read-only property that describes the setting: Program Controlled.

Named The following properties enable you to create Named Selections for Mapped, Unmapped,
Selection and Outside elements identified during the mapping process.
Creation
Unmapped Nodes
Options include Off (default) and On. Selecting the On option displays the Name
property. Rename the default as desired.

Mapped Nodes
Options include Off (default) and On. Selecting the On option displays the Name
property. Rename the default as desired.

Outside Nodes
Options include Off (default) and On. Selecting the On option displays the Name
property. Rename the default as desired.

Imported Remote Loads


The Imported Remote Loads object includes the Force and Moment boundary conditions provided
by an upstream Maxwell analysis to perform a coupled simulation. These loading conditions are used
during a Harmonic Response analysis.

Release 2020 R1 - © ANSYS, Inc.


1730
Imported Remote Loads

Tree Dependencies:

• Valid Parent Tree Objects: Environment


(Group) (p. 1690)

• Valid Child Tree Object: the


automatically generated groups of remote
forces and moments.

Insertion Method: Appears by default


for specific analyses with data
transfer. (p. 1133)

Additional Related Information:

• Importing Data into a Harmonic


Analysis (p. 406)

• Electromagnetics (EM) - Mechanical Data


Transfer (p. 402)

Note

As illustrated, an Imported Remote Loads object is automatically generated and it contains


Remote Point objects that are automatically named and associated with an appropriate
group for the Force and Moment loading objects.

Object Properties
The Details view properties for the Imported Remote Loads object folder include the following.

Category Properties
Scope Scoping Method: options include:

• Geometry Selection: this is the default setting, indicating that the boundary
condition is applied to a geometry or geometries, which are chosen using
graphical selection tools.

Geometry: visible when the Scoping Method is set to Geometry Selec-


tion. Displays the type of geometry (Body, Face, etc.) and the number of

Release 2020 R1 - © ANSYS, Inc.


1731
Objects Reference

Category Properties
geometric entities (for example: 1 Body, 2 Edges) to which the boundary
has been applied using the selection tools.

• Named Selection: indicates that the geometry selection is defined by a Named


Selection.

Named Selection - Visible when the Scoping Method is set to Named


Selection. This field provides a drop-down list of available user-defined
Named Selections.

Definition Ansoft Solution: this property provides a drop-down list of the available
solutions that were generated in the upstream application. When multiple
solutions are available, your selection defines which solution data is applied
to the imported load.

Remote Points: this property provides the options Internal and Globally
Available.

On Data Refresh: this option is available only when the Remote Points
property is set to Globally Available. Its options include:

• Reuse Remote Points: this is the default setting. This option reuses the previously
added remote points and only updates the scoping and location, if necessary.

• Regenerate Remote Points: this option deletes the remote points that were
created during the previous import and adds new remote points when the data
is imported.

Import Status: this read-only property displays the status of the import.
Status conditions include the following:

• Data Unavailable: no data is available to perform the import.

• Obsolete: the data is available to be imported, but no data has been imported
or the data is obsolete and should be re-imported.

• Update: all data has been imported.

• Import Failed: an error occurred during the import process and no data was
imported

Suppressed (p. 13): the default value is No.

Imported Thickness
Use the Imported Thickness object to import thickness data generated in a previous analysis for ap-
plication in a current analysis. Imported Thickness objects are created in Mechanical by linking an
External Data system to an analysis’ Model cell in the Project Schematic by right-clicking
Setup>Transfer Data To New and selecting an analysis type for the External Data system in the Project
Schematic. You can also right-click the Model cell of your project on the Project Schematic and select
Transfer Data From New>External Data.

Solver Notes:

Release 2020 R1 - © ANSYS, Inc.


1732
Imported Thickness

• For the Mechanical APDL solver, thickness on 3D shells is represented at the nodal level via the SEC-
FUNCTION command. For 2D plane stress, thicknesses are calculated as an average value from the
element's nodal thickness values and it is input as a real constant for the element.

• For the Explicit Dynamics solver the element's nodal thicknesses are converted to an average element
thickness.

• For the LS-DYNA solver, thicknesses are applied to the nodes. This is also true for 2D analyses.

Applies to: Imported Thickness object folder and all thickness child objects under the folder.

Tree Dependencies:

• Valid Parent Tree Objects: Imported


Thickness Group

• Valid Child Tree Object: Comment (p. 1654),


Image (p. 1706)

Insertion Method:

• Appears by default for specific analyses


with data transfer (p. 1133)

• Click right mouse button on the Impor-


ted Thickness Group object (p. 1734)

• Click on Thickness (p. 81) in the Geo-


metry toolbar.

Additional Related Information:

• External Data Import (p. 412)

• Specifying Surface Body Thickness (p. 491)

• Polyflow to Mechanical Data Transfer (p. 428)

The following right mouse button context menu options are available for this object.

• Search Faces with Multiple Thicknesses (p. 497)

Object Properties
The Details view (p. 17) properties for this object include but are not limited to the following. See
Appendix B. Data Transfer Mesh Mapping (p. 1879) for additional information about other categories and
settings for Imported Thicknesses.

Category Properties
Scope Scoping Method - Select the method of choosing objects to which
the thickness is applied: Geometry Selection or Named Selection.

Release 2020 R1 - © ANSYS, Inc.


1733
Objects Reference

Geometry – appears if Scoping Method is set to Geometry Selec-


tion. In this case, use selection filters (p. 126) to pick geometry (p. 125),
click in the Geometry field, then click Apply.

Named Selection – appears if Scoping Method is set to Named


Selection.
Definition Type - appears as Imported Thickness and is a read-only field.
Suppressed (p. 13) - Select Yes to suppress Imported Thickness.
External Data Identifier - Choose the appropriate data identifier
which represents the thickness data from the file.
Scale - The amount by which the imported thickness values are
scaled before being used for display or solution.
Offset - An offset that is added to the imported thickness values
before being used for display or solution.
Shell Offset (p. 489) - Set the desired shell offset.
Advanced Unmapped Data Value - You can specify a thickness value for
the unmapped target nodes using the Unmapped Data Value
property. By default, a zero thickness value is assigned to the
unmapped nodes. For the ANSYS solver, the thickness value at
each node must be greater than zero. See External Data Import
in the ANSYS Mechanical User's Guide for details.

Imported Thickness (Group)


The External Thickness group includes the thicknesses that you have imported from an earlier analysis
and want to apply in the present analysis. You can add valid thicknesses under the Geometry > Imported
Thickness object folder by right-clicking the Imported Thickness or the Thickness objects.

For a 3D analysis, imported data is specified as a shell thickness but for a 2D analysis, it is defined as a
plane element thickness. Plane element thicknesses are calculated as an average value from nodal
thickness values and it is input as a real constant for the element.

Applies to: Imported Thickness object folder and all external thickness child objects under the folder.

Release 2020 R1 - © ANSYS, Inc.


1734
Imported Thickness (Group)

Tree Dependencies:

• Valid Parent Tree Objects: Geometry object.

• Valid Child Tree Object: Comment (p. 1654),


Image (p. 1706), imported thickness objects

Insertion Method:

• Appears by default when a Mechanical


Model cell is connected to an External
Data system.

• Create a link to an upstream Polyflow


system.

Additional Related Information:

• External Data Import (p. 412)

• Polyflow to Mechanical Data Transfer (p. 428)

The following right mouse button context menu options are available for this object.

• Insert>Thickness

• Suppress/Unsuppress

• Clear Generated Data (p. 1199)

• Delete

• Rename

• Group/Ungroup (p. 100)

Object Properties
The Details view properties for the Imported Thickness object folder include the following.

Category Properties
Defini- Type
tion A read-only description of the Imported Thickness property.

Interpolation Type
A read-only description of the Interpolation Type property.

Suppressed
Enables you to control whether the Imported Thickness characteristics are considered in
the solving of the simulation.

Release 2020 R1 - © ANSYS, Inc.


1735
Objects Reference

Imported Trace (Group)


The Imported Trace group includes the metal traces that you have imported from a Printed Circuit
Boards (PCBs) 3D Layout design, using the External Data system, to model the effects of metal traces
in PCBs. You can add valid traces under the Geometry>Imported Trace object folder by right-clicking
the Imported Trace objects.

Tree Dependencies:

• Valid Parent Tree Objects: Geometry


object.

• Valid Child Tree Object:

• Valid Child Tree Object: Comment (p. 1654),


Figure (p. 1697), Image (p. 1706), and Imported
Trace objects.

Insertion Method: appears by default


when a Mechanical Model cell is
connected to an External Data system.

Additional Related Information: see the


External Data Import (p. 412) section.

The following right mouse button context menu options are available for this object.

• Insert>Trace (p. 469)

• Suppress/Unsuppress

• Import Trace (p. 469)

• Clear Generated Data (p. 1199)

• Delete

• Rename

Release 2020 R1 - © ANSYS, Inc.


1736
Imported Trace

• Group/Ungroup (p. 100)

Object Properties
The Details view properties for the Imported Trace group object include the following.

Category Properties
Defini- Type
tion A read-only property that describes the object - Imported Data.

Interpolation Type
A read-only description of the Interpolation Type property.

Suppressed
Suppress the object as desired.

Source
The source system.

Imported Trace
The Imported Trace object enables you to model Printed Circuit Boards (PCBs) in a fast and efficient
manner which would otherwise require an inordinate amount of time to process the geometry and
mesh, due to the complexities in such models.

Tree Dependencies:

• Valid Parent Tree Objects: Imported Trace


folder object.

• Valid Child Tree Object:

• Valid Child Tree Object: Comment (p. 1654),


Figure (p. 1697), and Image (p. 1706), objects.

Insertion Method:

• Appears by default when a Mechanical


Model cell is connected to an External
Data system.

• Right-click the Imported Trace group


object and select Insert>Trace.

• Select the Imported Trace button on


the Geometry (p. 81) toolbar.

Additional Related Information:

• ECAD Analysis using Trace Mapping (p. 466)

• Imported Trace Folder (p. 1736)

Release 2020 R1 - © ANSYS, Inc.


1737
Objects Reference

The following right mouse button context menu options are available for this object.

• Insert>Validation

• Export>Export Text File

• Suppress

• Duplicate

• Clear Generated Data

• Group (p. 100)

Object Properties
The Details view properties for the Imported Trace object include the following.

Category Properties
Scope Scoping Method
Specify as Geometry Selection (default) or Named Selection.

Geometry
Displayed when the Scoping Method is set to Geometry Selection (default). Displays
the type of geometry and the number of bodies to which the object has been applied
using the selection tools. Use the selection filter to pick geometry, click in the Geometry
field, then click Apply.

Named Selection
Displays when the Scoping Method is set to Named Selection. This field provides a
drop-down list of available user-defined Named Selections.

Defini- Type
tion A read-only property that describes the object - Imported Trace.

Suppressed
Suppress the object as desired.

External Data Identifier


This property provides a drop-down list of available ECAD files from the list of files specified
in the External Data system.

Shell Offset (Shells Only)


Set the desired shell offset (p. 489).

Graphics Component
Controls Options include Average (default), X Component, Z Component, and Z Component.

Display Source Points


Toggle display of source point data. Options include Off (default) and On.

Settings Mapping Control


Options include Program Controlled (default) and Manual.

Release 2020 R1 - © ANSYS, Inc.


1738
Imported Trace

Category Properties
Mapping
A read-only property that describes the setting - Profile Preserving

Weighting
A read-only property that describes the setting - Shape Function

Transfer Type
A read-only property that describes the setting - Volumetric

Legend Legend Range


Controls Options include Program Controlled (default) and Manual.

Minimum
This property displays when the Legend Range property is set to Manual. The default
setting is Program Controlled. Select the field to make a manual entry.

Maximum
This property displays when the Legend Range property is set to Manual. The default
setting is Program Controlled. Select the field to make a manual entry.

Named The following properties enable you to create Named Selections for Mapped, Unmapped,
Selection and Outside elements identified during the mapping process.
Creation
Unmapped Elements
Options include Off (default) and On. Selecting the On option displays the Name
property. Rename the default as desired.

Mapped Elements
Options include Off (default) and On. Selecting the On option displays the Name
property. Rename the default as desired.

Outside Elements
Options include Off (default) and On. Selecting the On option displays the Name
property. Rename the default as desired.

Material Modeling
Options include Average (default) and Black/White. Black/White material modeling
assigns the Trace material to elements with Average Metal Fraction > 0.5 and Dielectric
Material to elements with Average Metal Fraction <= 0.5, whereas the Average option
calculates material properties as a function of Metal Fraction. See the Trace
Analysis (p. 466) section for additional details.

Discretiz- Use these properties to you specify the grid density count to create the trace metal
ation distribution of the board. The grid density count is 200 x 200 by default. Depending
on the trace resolution and the computational costs desired, you can change the values
for the rows and columns to receive optimum results.

• X-Discretization

• Y-Discretization

Release 2020 R1 - © ANSYS, Inc.


1739
Objects Reference

Initial Conditions
Houses initial condition objects for use in a Transient Structural analysis (p. 384) (Velocity (p. 1840) only)
or an explicit dynamics analysis (Velocity (p. 1840) and Angular Velocity and Drop Height (p. 1686)) (p. 1635).

Tree Dependencies:

• Valid Parent Tree Object: Transient Structural


[for Velocity only], or Explicit Dynamics
environment (p. 1690) object [for either Velocity
or Angular Velocity].

• Valid Child Tree Objects: Angular Velo-


city (p. 1635) (Explicit Dynamics object only),
Comment (p. 1654), Drop Height (p. 1686) (Explicit
Dynamics object only), Figure (p. 1697), Im-
age (p. 1706), Pre-Stress (p. 1792) (Explicit
Dynamics object only), Velocity (p. 1840)

Insertion Options: Appears by default for a


Transient Structural analysis or an explicit
dynamics analysis.

Additional Related Information:

• Define Initial Conditions (p. 186)

• Transient Structural Analysis (p. 384)

• Explicit Dynamics Analysis Guide

Initial Temperature
Defines an initial temperature or an initial temperature distribution for use in a steady-state
thermal (p. 344) or transient thermal (p. 397) analysis.

Release 2020 R1 - © ANSYS, Inc.


1740
Interface Delamination

Tree Dependencies:

• Valid Parent Tree Object: Steady-State Thermal


or Transient Thermal analysis
environment (p. 1690).

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Appears by default for a


steady-state thermal analysis or a transient
thermal analysis.

Additional Related Information:

• Define Initial Conditions (p. 186)

• Steady-State Thermal Analysis (p. 344)

• Transient Thermal Analysis (p. 397)

Object Properties
The Details view properties for this object include the following.

Category Properties
Definition Initial Temperature (p. 186)

Initial Temperature Value (p. 186)

Interface Delamination
The Interface Delamination object allows you to simulate the separation of two materials across an
interface.

Release 2020 R1 - © ANSYS, Inc.


1741
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Fracture (p. 1699)

Insertion Options: Use any of the following


methods after highlighting Fracture object:

• Click the Interface Delamination button on the


Fracture context toolbar (p. 81).

• Click right mouse button on the Fracture (p. 1699)


object, Interface Delamination object, or Con-
tact Debonding (p. 1667) object and select
Insert>Interface Delamination.

Additional Related Information:

• Interface Delamination and Contact


Debonding (p. 865)

• Fracture Analysis (p. 841)

• Crack (p. 851)

• Pre-Meshed Crack (p. 863)

The following right mouse button context menu options are available for this object.

• Insert>Interface Delamination (p. 866)

• Insert>Contact Debonding (p. 868)

• Suppress

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Definition Type - read-only field that describes the object - Interface Delamination.

Method - this property specifies the formulation used to introduce the


fracture mechanism, either Virtual Crack Closure Technique (VCCT - default)
or Cohesive Zone Material (CZM).

Failure Criteria Option - options include:

• Energy-Release rate - this property displays when VCCT is the specified


as Method. It requires you to specify a Critical Rate value. This value
determines the energy release rate in one direction.

• Material Data Table - - this property displays when VCCT is the specified
as Method. This property defines the energy release rate in all three

Release 2020 R1 - © ANSYS, Inc.


1742
Interface Delamination

Category Properties
fracture modes. It provides a fly-out menu for Material selection or
specification. Material definitions are created in Engineering Data.

Material - this property displays when CZM is the specified as Method. It


provides a fly-out menu for Material selection or specification. Material
definitions are created in Engineering Data.

Suppressed - this property allows you to exclude the object in the analysis.
Scope Generation Method - specify as either Matched Meshing or Node
Matching. If interface layers imported from ANSYS Composite PrepPost
(ACP) application are available, a third option, Pre-Generated Interface is
also available. This property is automatically set to Pre-Generated Interface
for Interface Delamination objects automatically generated during the
import process for the interface layers.

Scoping Method - displayed when Node Matching is specified as the


Generation Method. Options include Geometry Selection (default) and
Named Selection. Specifies that the Source and Target properties are
defined using the graphical selection tools or that the geometry is defined
by from a drop-down list of available user–defined Named Selections (p. 583).
This option assumes that the existing mesh is already matched.

Source - displayed when Node Matching is specified as the Generation


Method. Specify the face on the model that will be the source.

Target - displayed when Node Matching is specified as the Generation


Method. Specify the face on the model that will be the target.

Match Control - displayed when Matched Meshing is specified as the


Generation Method. The Match Control property references a pre-defined
Mesh Match Control. The pre-defined Match Control requires two
independent parts that have the same (brick) element/node pattern.

Initial Crack - this property displays when VCCT is specified as Method.


Select a user-defined Pre-Meshed Crack (p. 1791).

Interface (ACP Only) - This property is only available when you create your
composite geometry in the ACP application. Select the appropriate Interface
Layer from the provided drop-down menu.
Step Controls for This category displays when VCCT is specified as Method. It provides the
Crack Growth following properties. If Auto Time Stepping is set to Manual the time
step properties can be modified, otherwise they are read-only.

Auto Time Stepping - options include Program Controlled (default)


or Manual.
Initial Time Step - initial time step when crack growth initiates.
Minimum Time Step - minimum time step for subsequent crack growth.
Maximum Time Step - maximum time step for subsequent crack
growth.
Node Matching This category displays when Node Matching is specified as Generation
Tolerance Method. It provides the following properties.

Release 2020 R1 - © ANSYS, Inc.


1743
Objects Reference

Category Properties
Tolerance Type - options include Program Controlled (default) or
Manual.
Distance Tolerance - this property may be modified when the Toler-
ance Type is set to Manual, otherwise it is read-only - that is, the value
is defined by the application. Node matching requires that each node
has a corresponding mate (Source and Target). This tolerance value
defines the search radius for determining the matching between Source
and Target nodes.

Joint
Defines conditions for reference and mobile pairs that make up a joint (p. 750). Several Joint objects
can appear as child objects under a Connection Group (p. 1664) object. The Connection Group object
name automatically changes to Joints.

Tree Dependencies:

• Valid Parent Tree Object: Connection Group (p. 1664)

• Valid Child Tree Objects: Comment (p. 1654), Coordinate System (p. 1677),
Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Connections (p. 1663) object:

• Inserted automatically if joints are defined in the CAD model and you choose
Create Automatic Connections through a right mouse button click the
Connections (or Joints) object.

• Click Body-Ground> {type of joint} or Body-Body> {type of joint} on


Connections context toolbar (p. 80).

• Click right mouse button on Connections (p. 1663) (or Joints ) object in the
Geometry window> Insert> Joint.

Additional Related Information:

• Joints (p. 746)

• Joint Load (p. 985)

• Connections Context Toolbar (p. 80)

The following right mouse button context menu options are available for this object.

• Enable/Disable Transparency (p. 815)

• Hide All Other Bodies (p. 815)

• Flip Reference/Mobile (p. 816)

• Search Connections for Duplicate Pairs (p. 691)

Release 2020 R1 - © ANSYS, Inc.


1744
Layered Section

• Go To Connections for Duplicate Pairs (p. 691) - available if connection object shares the same geometries
with other connection objects.

• Promote to Remote Point (p. 618) (Remote Attachment Only)

• Promote to Named Selection (p. 597)

• Rename Based on Definition (p. 814)

Object Properties
For more information on this object's properties, see the Joint Properties (p. 761) section for specific
details.

Layered Section
Allows you to define layered section properties on selected surface bodies or on selected faces of surface
bodies.

Tree Dependencies:

• Valid Parent Tree Object: Geometry (p. 1701)

• Valid Child Tree Objects: Comment (p. 1654),


Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting Geometry (p. 1701)
object:

• Click Layered Section button on Geometry


context toolbar (p. 81).

• Click right mouse button on Geometry (p. 1701)


object > Insert> Layered Section.

Additional Related Information:

• Specifying Surface Body Layered Sections (p. 494)

• Geometry Context Toolbar (p. 81)

The following right mouse button context menu options are available for this object.

• Search Faces with Multiple Thicknesses (p. 497)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Scope Scoping Method

Release 2020 R1 - © ANSYS, Inc.


1745
Objects Reference

Geometry - appears if Scoping Method is set to Geometry Selec-


tion. In this case, use selection filters (p. 126) to pick geometry (p. 125),
click in the Geometry field, then click Apply.

Named Selection - appears if Scoping Method is set to Named


Selection.
Definition Coordinate System
Offset Type (p. 489) (this field is not supported for an Explicit
Dynamics analysis)
Membrane Offset - appears if Offset Type is set to User Defined.
Layers - click here to open the worksheet to enter the layer data.
Suppressed (p. 13)
Material Nonlinear Effects (p. 180) - select yes to include the nonlinear
effects from the material properties. The reference temperature
specified for the body on which a layered section is defined is
used as the reference temperature for the layers.
Thermal Strain Effects (p. 180) - select yes to send the coefficient
of thermal expansion to the solver.

Note

These fields are not supported for an Explicit Dynamics


analysis.

Graphic Properties Layer to Display - defines which layer to display on the model.
Properties Total Thickness - total thickness of all of the layers in the Layered
Section.
Total Mass - total mass of all of the layers in the Layered Section.

Loads, Supports, and Conditions (Group)


Defines the individual loads (p. 938), supports (p. 1077), and conditions (p. 1105) used as boundary conditions
in the environment for a model.

Applies to the following objects: Absorption Element (p. 1062), Absorption Surface (p. 1058), Accelera-
tion (p. 923), Bearing Load (p. 963), Bolt Pretension (p. 967), Compression Only Support (p. 1095), Con-
ductor (p. 1017), Constraint Equation (p. 1107), Convection (p. 992), Coupling (p. 1105), Current (p. 1012),
Cylindrical Support (p. 1098), Detonation Point, Diffuse Sound Field (p. 1040), Displacement (p. 1080),
Elastic Support (p. 1103), Far-field Radiation Surface (p. 1073), Nodal Displacement (p. 1126), Nodal Rota-
tion (p. 1128), Free Surface (p. 1064), Fixed Rotation (p. 1101), Fixed Support (p. 1078), Fluid Solid Inter-
face (p. 1027), Force (p. 953), Frictionless Support (p. 1093), Generalized Plane Strain (p. 976), Heat
Flow (p. 1001), Heat Flux (p. 1003), Hydrostatic Pressure (p. 949), Impedance Boundary, Impedance
Boundary (Acoustic) (p. 1055), Impedance Sheet (p. 1049), Incident Wave Source (p. 1042), Internal Heat
Generation (p. 1005), Mass Flow Rate (p. 1008), Joint Load (p. 985), Line Pressure (p. 979), Magnetic Flux
Parallel (p. 1015), Mass Source (p. 1035), Moment (p. 972), Nodal Orientation (p. 1120), Nodal Force (p. 1121),
Nodal Pressure (p. 1123), Nonlinear Adaptive Region (p. 1112), Perfectly Insulated (p. 1001), Pipe Idealiz-
ation (p. 1109), Pipe Pressure (p. 945), Pipe Temperature (p. 947), Port (p. 1071), Pressure (p. 939), Pressure
(Acoustic) (p. 1053), Port In Duct (p. 1045), PSD Base Excitation (p. 982), Radiation (p. 997), Radiation
Boundary (p. 1060), Remote Displacement (p. 1086), Remote Force (p. 957), Rigid Wall (p. 1067), Rotating
Force (p. 1030), Rotational Acceleration (p. 934), Rotational Velocity (p. 931), RS Base Excitation (p. 983),

Release 2020 R1 - © ANSYS, Inc.


1746
Loads, Supports, and Conditions (Group)

Simply Supported (p. 1099), Standard Earth Gravity (p. 929), Static Pressure (p. 1051), Surface Velo-
city (p. 1037), Symmetry Plane (p. 1069), Temperature (Acoustic) (p. 1047), Temperature (p. 989), Thermal
Condition (p. 987), Thermo-Viscous BLI Boundary (p. 1066), Transfer Admittance Matrix (p. 1076), Velo-
city (p. 1091), Voltage (p. 1010)

Tree Dependencies:

• Valid Parent Tree Object:

– For Magnetostatic Analysis only: Source Conductor (p. 1017) when specifying
a Current (p. 1020) or Voltage (p. 1019)

– For all other objects: an analysis environment (p. 1690) object.

• Valid Child Tree Objects:

– For Magnetostatic Analysis Source Conductor (p. 1017): Comment (p. 1654),
Current (p. 1020), Figure (p. 1697), Image (p. 1706), Voltage (p. 1019) (Solid Source
Conductor only)

– For all other objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options:

• For Current (p. 1020) or Voltage (p. 1019), scope (p. 919) to a body, then use any
of the following methods:

– Choose Conductor or Current on Environment context toolbar (p. 83),


then choose Current or Voltage from the toolbar.

– Click right mouse button on Magnetostatic object, or in the Geometry


window> Insert> Conductor then > Insert> Current or Voltage

• For all other objects, use any of the following methods after highlighting
Environment (p. 1690) object:

– Choose Inertial, or Load, or Supports, or Conditions> {load, support, or


condition name} on Environment context toolbar (p. 83).

– Click right mouse button on Environment (p. 1690) object, any load, support,
or condition object, or in the Geometry window> Insert> {load, support,
or condition name}

Additional Related Information:

• Create Analysis System (p. 173)

• Apply Loads and Supports (p. 190)

The following right mouse button context menu options are available for this object.

• Promote to Named Selection (p. 597) - available for most boundary condition objects.

• Group (p. 100)

Release 2020 R1 - © ANSYS, Inc.


1747
Objects Reference

• Group Similar Objects (p. 100)

The right mouse button context menu option Promote to Named Selection (p. 597) is available for
most boundary condition objects.

Object Properties
See the Applying Boundary Conditions (p. 919) section for more information about Loads, Supports, and
Conditions.

Manufacturing Constraint
The Manufacturing Constraint object is an optional object for a Topology Optimization (p. 352) analysis.
The analysis supports only one Manufacturing Constraint object in the tree. See the Manufacturing
Constraint (p. 359) section for additional information.

Tree Dependencies:

• Valid Parent Tree Object: Topology


Optimization Environment (p. 1690).

• Valid Child Tree Objects: No supported child


objects.

Insertion Options: To add a Manufactur-


ing Constraint object, highlight the
Topology Optimization environment and
either:

• Select Manufacturing Con-


straint>Member Size from the
Environment (p. 83) context toolbar.

• Right-click and select Insert>Member


Size.

Additional Related Information: See


Topology Optimization (p. 352).

The following right mouse button context menu options are available for this object.

• Insert > Objective (p. 1778)

• Insert > Mass Constraint (p. 1799)

• Insert > Volume Constraint (p. 1799)

• Insert > Global Von-Mises Stress Constraint (p. 1799) (Static Structural Analysis)

• Insert > Local Von-Mises Stress Constraint (p. 1799) (Static Structural Analysis)

Release 2020 R1 - © ANSYS, Inc.


1748
Mesh

• Insert > Displacement Constraint (p. 1799) (Static Structural Analysis)

• Insert > Reaction Force Constraint (p. 1799) (Static Structural Analysis)

• Insert > Natural Frequency Constraint (p. 1799) (Modal Analysis)

• Insert > Member Size (p. 1748)

• Insert > Pull out Direction (p. 1748)

• Insert > Extrusion (p. 1748)

• Insert > Symmetry (p. 1748)

• Insert > Cyclic (p. 1748)

• Grouping/Ungrouping (p. 100) options

• Commands Objects (p. 1475)

Object Properties
The Details view (p. 17) properties for this object are examined in the Manufacturing Constraint (p. 359)
section.

Mesh
Manages all meshing functions and tools for a model; includes global controls that govern the entire
mesh.

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: all mesh control tool


objects (p. 1759), Comment (p. 1654), Figure (p. 1697),
Image (p. 1706)

Insertion Options: Appears by default when


geometry is attached (p. 477).

Additional Related Information:

• Meshing Capabilities in Workbench

• Mesh Context Toolbar (p. 82)

The following right mouse button context menu options are available for this object.

• Insert > Mesh Connection Group (p. 1754)

• Insert > Manual Mesh Connection (p. 1757)

• Insert > Contact Match Group (p. 1754)

Release 2020 R1 - © ANSYS, Inc.


1749
Objects Reference

• Insert > Contact Match (p. 1757)

• Insert > Node Merge Group (p. 1772)

• Insert > Node Merge (p. 1774)

• Insert > Node Move (p. 1776)

• Update

• Generate Mesh

• Preview> Surface Mesh

• Preview> Inflation

• Show> Removable Loops

• Show> Sweepable Bodies

• Show> Mappable Faces

• Show> Geometry in Overlapping Named Selections

• Show> Program Controlled Inflation Surfaces

• Create Pinch Controls

• Export (p. 54)>STL File (Binary (p. 110) is the default format setting).

• Export (p. 54)>ANSYS Viewer File (AVZ): export mesh data as a ANSYS Viewer File (.avz)

• Clear Generated Data

• Start Recording

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Display Display Style: This property enables you to change the display of the
mesh in the graphical display window based on different criteria. The
Display Style options include the following:

• Body Color (application default colors)

• Mesh Metric information, which includes:

Shell Thickness (visible for surface/shell bodies only)


Element Quality
Aspect Ratio, based on either Triangle elements or
Quadrilateral elements
Jacobian Ratio (MAPDL, Corner Nodes, or Gauss Points)
Warping Factor

Release 2020 R1 - © ANSYS, Inc.


1750
Mesh

Category Fields
Parallel Deviation
Maximum Corner Angle
Skewness
Orthogonal Quality
Characteristic Length

Note

The use of Display Style to color mesh according to quality


and the use of Mesh Metrics to view quality statistics are
mutually exclusive. For example, when you are viewing Mesh
Metrics, you cannot also view the mesh quality by color.

Defaults Physics Preference

Solver Preference (appears if Physics Preference is CFD)

Relevance

Export Format (appears if Physics Preference is CFD and Solver


Preference is Fluent)

Export Unit (appears if Physics Preference is CFD and Solver Prefer-


ence is Polyflow)

Note

Solver Preference also appears in the Mechanical application


if the Physics Preference is Mechanical in a Transient
Structural or Rigid Dynamics system during the initial
geometry attach. See Solver Preference for more
information.

Element Order
Sizing Size Function

Relevance Center

Element Size

Initial Size Seed

Transition

Span Angle Center

Curvature Normal Angle

Num Cells Across Gap

Proximity Size Function Sources

Release 2020 R1 - © ANSYS, Inc.


1751
Objects Reference

Category Fields
Min Size

Proximity Min Size

Use Fixed Size Function for Sheets

Max Face Size

Max Tet Size

Growth Rate

Enable Washers

Defeature Size

Bounding Box Diagonal

Minimum Edge Length


Quality Check Mesh Quality

Error Limits

Target Quality

Target Skewness

Target Jacobian Ratio (Corner Nodes)

Smoothing

Mesh Metric
Inflation Use Automatic Inflation

Inflation Option

Transition Ratio

Maximum Layers

Growth Rate

Number of Layers

Maximum Thickness

First Layer Height

First Aspect Ratio

Aspect Ratio (Base/Height)

Inflation Algorithm

Release 2020 R1 - © ANSYS, Inc.


1752
Mesh

Category Fields
View Advanced Options

Collision Avoidance

Fix First Layer

Maximum Height over Base

Gap Factor

Growth Rate Type

Maximum Angle

Fillet Ratio

Use Post Smoothing

Smoothing Iterations
Assembly Meshing Method

Feature Capture

Tessellation Refinement

Intersection Feature Creation

Morphing Frequency (available for CutCell meshes with inflation)

Keep Solid Mesh


Advanced Number of CPUs for Parallel Part Meshing

Straight Sided Element - appears if the model includes an enclosure


from DesignModeler.

Number of Retries

Rigid Body Behavior

Mesh Morphing

Triangle Surface Mesher

Topology Checking

Use Sheet Thickness for Pinch

Pinch Tolerance

Generate Pinch on Refresh

Sheet Loop Removal

Loop Removal Tolerance

Release 2020 R1 - © ANSYS, Inc.


1753
Objects Reference

Category Fields
Statistics Nodes - Read-only indication.

Elements - Read-only indication.


Model Assembly Read Only: Yes (default) or No. This category and property are only
visible when you are Assembling External Models and Mechanical
Models (p. 554).

Mesh Connection Group/Contact Match Group


Defines mesh connections/contact matches between selected topologies. Includes global settings in
Details view that apply to all Mesh Connection or Contact Match child objects.

Note

See the object reference pages for Mesh Edit (p. 1761) and Node Merge Group (p. 1772) for
information about other objects related to Mesh Connections, Contact Matches, and Mesh
Editing.

Tree Dependencies:

• Valid Parent Tree Object: Mesh Edit (p. 1761)

• Valid Child Tree Objects: Mesh Connection


or Contact Match, Comment (p. 1654), Fig-
ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting the Mesh Edit
object or another Mesh Connection Group
or Contact Match Group object:

• Click Mesh Connection Group or Contact


Match Group on Model context toolbar (p. 78).

• Click right mouse button on Mesh Edit object


or on another Mesh Connection
Group/Contact Match Group object or in the
Geometry window; then Insert > Mesh
Connection Group or Insert > Contact Match
Group.

Additional Related Information:

• Mesh Editing

• Mesh Connection

• Contact Match

• Mesh Edit (p. 1761)

Release 2020 R1 - © ANSYS, Inc.


1754
Mesh Connection Group/Contact Match Group

• Mesh Connection/Contact Match object


(p. 1757)

The following right mouse button context menu options are available for this object.

• Insert > Mesh Connection Group (p. 1754)

• Insert > Manual Mesh Connection (p. 1757)

• Insert > Contact Match Group (p. 1754)

• Insert > Contact Match (p. 1757)

• Detect Connections

• Generate

• Suppress/Unsuppress

• Enable/Disable Transparency

• Search Connections for Duplicate Pairs

• Create Named Selection

• Delete

• Delete Children

• Rename (F2)

• Rename Based on Definition (p. 726)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields/Conditions
Scope Scoping Method: Geometry Selection (default) or Named Selection.

Geometry: Visible when the Scoping Method is set to Geometry Selection.

Named Selection: Visible when the Scoping Method is set to Named


Selection.
Auto Detection Tolerance Type: options include Slider, Value, and Use Sheet Thickness.
Bodies in an assembly that were created in a CAD system may not have
been placed precisely, resulting in small overlaps or gaps along the
connections between bodies. You can account for any imprecision by
specifying detection tolerance. This tolerance can be specified by a value
when this property is set to Slider or Value, or sheet thickness of surface
bodies when the type is set to Use Sheet Thickness.

Release 2020 R1 - © ANSYS, Inc.


1755
Objects Reference

Category Fields/Conditions
Tolerance Slider: this property appears when the Tolerance Type property
is set to Slider. To tighten the mesh connection or contact match detection,
move the slider bar closer to +100 and to loosen the detection, move the
slider bar closer to -100. A tighter tolerance means that the bodies have
to be within a smaller region (of either gap or overlap) to be considered;
a looser tolerance will have the opposite effect. Be aware that as you adjust
the tolerance, the number of mesh connection pairs or contact matches
could increase or decrease.

Tolerance Value: this property appears when the Tolerance Type is set
to Slider or Value. It is a read-only property if the Tolerance Type is set
to Slider and displays the tolerance value based on the slider setting. When
the Tolerance Type is set to Value, you can enter an exact distance for
the detection tolerance.

Thickness Scale Factor: this property displays when the Tolerance Type
property is set to Use Sheet Thickness. The default value is 1. For
Edge/Edge pairing (see below), the largest thickness among the surface
bodies involved is used; however, if the pairing is Face/Edge, the thickness
of the surface body with the face geometry is used.

Use Range: appears if the Tolerance Type property is set to Slider or


Value. Options include Yes and No (default). If set to Yes, mesh connection
detection searches within a range from Tolerance Value to Min Distance
Value inclusive and the following additional properties display:

• Min Distance Percent: appears if Use Range is set to Yes. This is the
percentage of the Tolerance Value to determine the Min Distance Value.
The default is 10 percent. You can move the slider to adjust the percentage
between 0 and 100.

• Min Distance Value: appears if Use Range is set to Yes. This is a read-only
field that displays the value derived from: Min Distance Value = Min
Distance Percentage * Tolerance Value/100.

Group By: For mesh connections, options include None and Faces (default).
For contact matches, options include None, Bodies (default), Parts, and
Faces. This property allows you to group the automatically generated mesh
connection or contact match objects. For example, setting Group By to
Faces for a mesh connection group means that mesh connection faces
and edges that lie on the same parts will be included into a single mesh
connection object.

Search Across: This property enables automatic detection through the


following options:

• Bodies (default): Between bodies.

• Parts: Between bodies of different parts, that is, not between bodies within
the same multibody part.

Release 2020 R1 - © ANSYS, Inc.


1756
Mesh Connection/Contact Match

Category Fields/Conditions
• Anywhere: Detects any mesh connections/contact matches regardless
of where the geometry lies, including different parts. However, if a mesh
connection is within the same body, this option finds only Face/Face mesh
connections, even if the Face/Edge setting is turned On.

Face Angle Tolerance: for faces that will be excluded from the proximity
detection pair, this property defines the minimum angle between the
master face and slave edge entity above which the two face pairs will be
ignored from proximity detection. The default value is 70°.

Edge Overlap Tolerance: this tolerance value is the minimum percentage


that an edge may overlap the face and is included as a valid proximity
detection pair. The default value is 25%.
Statistics Connections: displays the number of connections associated with this
parent object.

Active Connections: displays the number of connections that are currently


active for this parent object (i.e., not Suppressed).

Mesh Connection/Contact Match


Defines mesh connection/contact match conditions for individual topology pairs. Multiple Mesh Con-
nection or Contact Match objects can appear as child objects under a Mesh Connection Group or
Contact Match Group object.

Note

See the object reference pages for Mesh Edit (p. 1761) and Node Merge Group (p. 1772) for
information about other objects related to Mesh Connections, Contact Matches, and Mesh
Editing.

Release 2020 R1 - © ANSYS, Inc.


1757
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Mesh Connection


Group (p. 1754) (for mesh connections) or Con-
tact Match Group (p. 1754) (for contact matches)

• Valid Child Tree Objects: Comment (p. 1654),


Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting the Mesh
Edit (p. 1761) object or a Mesh Connection
Group/Contact Match Group object:

• Assuming that you have accurately defined


the required properties, Mesh Connection and
Contact Match objects can be inserted
automatically if you select Detect Connections
from the right mouse click context menu via
the Mesh Edit object or a Mesh Connection
Group/Contact Match Group object.

• Click Manual Mesh Connection or Contact


Match on Mesh Edit context toolbar (p. 81).

• Click right mouse button on Mesh Edit object


or the Mesh Connection Group/Contact
Match Group object or in the Geometry
window; then Insert > Manual Mesh
Connection or Insert>Contact Match.

Additional Related Information:

• Mesh Connections

• Contact Matches

• Mesh Edit (p. 1761)

• Mesh Connection Group (p. 1754)

• Contact Match Group (p. 1754)

The following right mouse button context menu options are available for this object.

• Generate - update the mesh for the selected contact match or mesh connection

• Suppress/Unsuppress

• Enable/Disable Transparency

• Hide All Other Bodies (p. 726)

• Flip Master/Slave (valid for Edge-to-Edge Mesh Connection only)

Release 2020 R1 - © ANSYS, Inc.


1758
Mesh Control Tools (Group)

• Merge Selected Mesh Connections

• Search Connections for Duplicate Pairs

• Go To Connections for Duplicate Pairs (p. 691) - available if connection object shares the same geometries
with other connection objects.

• Create Named Selection

• Duplicate

• Copy

• Cut

• Delete

• Rename (F2)

• Rename Based on Definition (p. 726)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields/Conditions
Scope (p. 698) Scoping Method: Geometry Selection or Named Selection.
Master Geometry
Slave Geometry
Master Bodies: read-only indication.
Slave Bodies: read-only indication.
Definition (p. 698) Scope Mode: read-only indication of Manual or Automatic.
Tolerance Type
Tolerance Slider: appears if Tolerance Type = Tolerance Slider.
Tolerance Value: appears if Tolerance Type = Tolerance Slider
(read-only) or Tolerance Value.
Thickness Scale Factor: appears if Tolerance Type = Use Sheet
Thickness.
Suppressed (p. 13)
Snap to Boundary (valid for mesh connections only)
Snap Type (valid for mesh connections only): appears if Snap to
Boundary = Yes.
Snap Tolerance (valid for mesh connections only): appears if Snap
Type = Manual Tolerance.
Master Element Size Factor (valid for mesh connections only): appears
if Snap Type = Element Size Factor.

Mesh Control Tools (Group)


Objects available for fine tuning the mesh.

Applies to the following objects: Method, Mesh Grouping, Sizing, Contact Sizing, Refinement, Face
Meshing, Match Control, Pinch, Inflation, Sharp Angle

Release 2020 R1 - © ANSYS, Inc.


1759
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Mesh

• Valid Child Tree Objects: Comment (p. 1654),


Figure (p. 1697), Image (p. 1706)

Insertion Options:

Use any of the following methods after


highlighting Mesh object:

• Choose Mesh Control> {Mesh control tool


name} on Mesh context toolbar (p. 82).

• Click right mouse button on Mesh object, any


mesh control tool object, or in the Geometry
window> Insert> {Mesh control tool name}.

Additional Related Information:

• Meshing Capabilities in Workbench

• Mesh Context Toolbar (p. 82)

• Convergence (p. 1411) - applicable to Refinement

• Error (Structural) (p. 1232) - applicable to Refine-


ment

The following right mouse button context menu options are available. Availability is dependent on the
selected object.

• Inflate This Method - available only for Method control where Method is set to anything other than Hex
Dominant, MultiZone Quad/Tri, or Sweep (unless a source has been specified).

• Update

• Generate Mesh

• Preview> Surface Mesh

• Preview> Source and Target Mesh

• Preview> Inflation

• Show> Sweepable Bodies

• Show> Mappable Faces

• Suppress/Unsuppress

• Rename Based on Definition

• Start Recording

Release 2020 R1 - © ANSYS, Inc.


1760
Mesh Edit

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping Method (p. 605) - specify either Geometry Selection or
Named Selection. Not applicable to Contact Sizing, Pinch, or Match
Control.
Geometry - appears if Scoping Method is set to Geometry Selec-
tion. In this case, use selection filters (p. 126) to pick geometry (p. 125),
click in the Geometry field, then click Apply. Not applicable to
Contact Sizing, Pinch, or Match Control.
Named Selection (p. 605) - appears if Scoping Method is set to
Named Selection. Not applicable to Contact Sizing, Pinch, or Match
Control.
Contact Region - applicable only to Contact Sizing.
Definition Suppressed (p. 13)

Note

Additional Definition settings may be available, depending


on the specific mesh control tool.

Mesh Edit
The Mesh Edit feature allows you to create Mesh Connections and Contact Matches as well as merge
and/or move individual nodes on the mesh (once generated). Mesh Connections define conditions for
joining meshes of topologically disconnected surface bodies. This object includes global settings in
Details view that apply to all Mesh Connection Group, Contact Match Group, Node Merge group,
Mesh Connection, Contact Match, Node Merge, and Node Move child objects.

Release 2020 R1 - © ANSYS, Inc.


1761
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Mesh Connec-


tion Group (p. 1754), Contact Match
Group (p. 1754) Node Merge Group (p. 1772),
Node Move (p. 1776), Comment (p. 1654),
Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the


following methods after highlighting
Model object:

• Click the Mesh Edit button on Model


context toolbar (p. 78).

• Click right mouse button on the Model


object or in the Geometry window; then
select Insert > Mesh Edit.

Additional Related Information:

• Mesh Editing

• Mesh Connections

• Mesh Connection Group (p. 1754)

• Mesh Connection (p. 1757)

• Contact Matches

• Contact Match Group (p. 1754)

• Contact Match (p. 1757)

• Node Move

• Node Merge Group

• Node Merge

The following right mouse button context menu options are available for this object.

• Insert > Mesh Connection Group

• Insert > Manual Mesh Connection

• Insert > Contact Match Group

• Insert > Contact Match

• Insert > Node Merge Group

Release 2020 R1 - © ANSYS, Inc.


1762
Mesh Group (Group)

• Insert > Node Merge

• Insert > Node Move

• Generate

• Clear Generated Data (This option is not available if the object has only Node Move objects as children.)

• Enable/Disable Transparency

• Search Connections for Duplicate Pairs

• Create Named Selection for Shared Nodes

• Rename (F2)

• Rename Based on Definition (p. 726)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields/Conditions
Auto Detection Generate Automatic Mesh Connections On Refresh: Yes or No.
Transparency Enabled: Yes or No.

Mesh Group (Group)


Mesh Group objects allow you to identify bodies that should be grouped together for assembly
meshing.

Also see the description of the Fluid Surface (p. 1698) object (applicable to assembly meshing algorithms
only).

Note

Virtual Body and Fluid Surface objects are fluids concepts, and as such they are not sup-
ported by Mechanical solvers.

Release 2020 R1 - © ANSYS, Inc.


1763
Objects Reference

Tree Dependencies:

• Valid Parent Tree Objects: Mesh Group-


ing (p. 1765)

Insertion Options: Highlight the Mesh (p. 1749)


object (or its Mesh Grouping (p. 1765) or Mesh
Group (p. 1763) child object if any exist), and
then:

• Select Mesh Control> Mesh Group on the Mesh


Context Toolbar (p. 82).

• Click the right mouse button on the object you


highlighted and select Insert> Mesh Group from
the context menu.

These methods insert a Mesh Group object


beneath the Mesh Grouping object. The
Mesh Grouping object is inserted
automatically when the first Mesh Group
object is inserted.

Additional Related Information:

• Meshing Capabilities in Workbench

• Mesh Context Toolbar (p. 82)

• Defining Mesh Groups

• Assembly Meshing

The following right mouse button context menu options are available.

• Insert> Mesh Group

• Suppress/Unsuppress

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Bodies To Group - Set of bodies that should be members of
the group. All bodies within a group, including the Master
Body, should be of the same type (i.e., Fluid or Solid, as
defined by the Fluid/Solid material property). Otherwise,
unexpected results may occur. Surface bodies cannot be
selected for grouping.
Master Body - Body that should act as the master of the
group. The master body is the body to which all mesh of the

Release 2020 R1 - © ANSYS, Inc.


1764
Mesh Numbering

Category Fields
group members will be associated. By default, the first body
that is selected for Bodies To Group is the Master Body.
Priority - Determines which group will claim cells in cases
where groups overlap. The priority is initially based on the
rule: the smaller the volume, the higher the priority.
Definition Suppressed - Toggles suppression of the selected group. The
default is No. If set to Yes, the group will be suppressed.

Mesh Grouping
Represents all definitions of mesh groups within a model. Each definition is represented in a Mesh
Group (p. 1763) object. May contain any number of Mesh Group objects, which are used for assembly
meshing.

Tree Dependencies:

• Valid Parent Tree Object: Mesh (p. 1749)

• Valid Child Tree Object: Mesh Group (p. 1763)

Insertion Options: Automatically inserted in


the tree when the first Mesh Group (p. 1763)
object is inserted.

Additional Related Information:

• Meshing Capabilities in Workbench

• Mesh Context Toolbar (p. 82)

• Defining Mesh Groups

• Assembly Meshing

Mesh Numbering
Folder object that includes any number of Numbering Control (p. 1776) objects, used for mesh number-
ing (p. 657), which allows you to renumber the node and element numbers of a generated meshed
model consisting of flexible parts.

Release 2020 R1 - © ANSYS, Inc.


1765
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after selecting Model object:

• Click Mesh Numbering button on Model context


toolbar.

• Click right mouse button on Model object or in


the Geometry window> Insert>Mesh
Numbering.

Additional Related Information:

• Mesh Numbering (p. 657)

• Model Context Toolbar (p. 78)

The following right mouse button context menu options are available for this object.

• Renumber Mesh (p. 657)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Definition (p. 657) Node Offset
Element Offset
Suppressed (p. 13): suppressing this object returns the mesh
numbering to their original values.
Compress Numbers

Modal
Defines the modal analysis whose mode shapes are to be used in a random vibration (p. 235), response
spectrum (p. 242), or harmonic (MSUP) linked (p. 225) analysis (not shown below).

Release 2020 R1 - © ANSYS, Inc.


1766
Model

Tree Dependencies:

• Valid Parent Tree Object: Random Vibration,


Response Spectrum, or Harmonic Response
(linked) environment (p. 1690) object.

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Appears by default for a


random vibration analysis, response spectrum
analysis, or harmonic (MSUP) linked analysis.

Additional Related Information:

• Random Vibration Analysis (p. 235)

• Response Spectrum Analysis (p. 242)

• Harmonic Response Analysis Using Linked


Modal Analysis System (p. 225)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Definition Modal Environment (p. 186)

Model
Defines the geometry for the particular branch of the tree. The sub-levels provide additional information
about the Model object, including loads, supports and results, but do not replace the geometry.

Release 2020 R1 - © ANSYS, Inc.


1767
Objects Reference

Graphic settings applied to the Model object apply to lower level objects in the tree. The Model object
groups geometry, material assignments, connections, and mesh settings. The Geometry (p. 1701), Con-
nections (p. 1663) and Mesh (p. 1749) objects are not created until geometry is successfully attached.

Tree Dependencies:

• Valid Parent Tree Object: Project (p. 1795)

• Valid Child Tree Objects: Chart (p. 1652), Com-


ment (p. 1654), Connections (p. 1663), Coordinate
Systems (p. 1680), environments (p. 1690), Fig-
ure (p. 1697), Geometry (p. 1701), Image (p. 1706),
Mesh, Mesh Edit (p. 1761) (p. 1749), Named Selec-
tion (p. 1768), Solution Combination (p. 1820),
Symmetry (p. 1830), Virtual Topology (p. 1847)

Insertion Options: Appears by default for


attached geometry.

Additional Related Information:

• Attaching Geometry (p. 174)

• Model Context Toolbar (p. 78)

The following right mouse button context menu options are available for this object.

• Solve (p. 1373)

• Disable Filter/Auto Filter (p. 104)

• Clear Generated Data (p. 1199)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Model Assembly Alignment
Filter Options (p. 104) Control
Lighting (p. 166) Ambient Light

Diffuse Light

Specular Light

Light Color

Named Selections
Named Selections (p. 583) is a folder object that includes any number of individual user-defined Selection
objects.

Release 2020 R1 - © ANSYS, Inc.


1768
Named Selections

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Individual named


selection objects, Comment (p. 1654), Figure (p. 1697),
Image (p. 1706)

Note

Comment (p. 1654), Figure, and


Image (p. 1706) (p. 1697) are also
child objects of individual named
selection objects.

Insertion Options: Use any of the following


methods:

• Click Named Selection button on the Model


Context Toolbar (p. 78).

• Select geometry items for grouping in the Geo-


metry window, or select Body (p. 1644) objects in
the tree, then choose Create Named Selection
(left button on the Named Selection
Toolbar (p. 94) or right-click context menu choice).

• Import named selections (p. 94) from a CAD


system or from DesignModeler.

• Automatically inserted in the event of a mesher


failure so that problem surface bodies can be
identified.

Additional Related Information:

• Specifying Named Selections (p. 583)

• Named Selection Toolbar (p. 94)

• Repairing Geometry in Overlapping Named


Selections

• Geometry Preferences

• Named Selection (DesignModeler Help)

• Enclosure (DesignModeler Help)

The following right mouse button context menu options are available for the Named Selections folder
object.

Release 2020 R1 - © ANSYS, Inc.


1769
Objects Reference

• Insert>Named Selection

• Generate Named Selections: this option updates all named selection child objects that were specified
using the Worksheet (p. 587). It is a substitute for the Worksheet Generate button to ensure that all
worksheet-based named selection updates are captured.

• Repair Overlapping Named Selections: this option corrects overlap conditions in order to property
export Named Selections.

• Import Selections from CDB File: this option, available from the Named Selections folder as well as
the Geometry window when the folder is selected, enables you to import element- and node-based
named selections from a Mechanical APDL common database (.cdb) file.

Upon import, the application automatically removes any spaces or special characters from the
file name and replaces them with an underscore.

• Export Selections to CDB File: this option, available from the Named Selections folder as well as the
Geometry window when the folder is selected, enables you to export all of the Named Selections in
the folder in .cdb file format. Note that the application ignores geometry-based Named Selections.

The following right mouse button context menu options are available for the specified Named Selections
objects.

• Insert>Named Selection

• Export Selections to CDB File: export Named Selections in .cdb file format.

You can export multiple Named Selections objects but the application supports only element-
and/or node-based named selections in .cdb file format. The application ignores geometry-
based Named Selections.

• Select Items in Group (p. 603)

• Add to Current Selection (p. 603)

• Remove from Current Selection (p. 603)

• Create Nodal Named Selection (p. 603)

• Merge Selected Named Selections: this option is available when you select more than one Named
Selections in the tree. It creates a new Worksheet-based Named Selection (p. 587) for the selected Named
Selections objects. The Worksheet displays automatically below the Geometry window when you use
this option (as well as when you select the merge-based Named Selection during subsequent operations).

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

The following applies only to the Named Selections object folder:

Category Fields/Descriptions
Display Show Annotation

Release 2020 R1 - © ANSYS, Inc.


1770
Named Selections

Category Fields/Descriptions
Worksheet Based Named Generate on Refresh: Updates Named Selection criteria
Selections automatically following a geometry update.

Generate on Remesh: Updates the Node ids and locations


based on the new mesh.

The following applies only to the child objects of a Named Selections object folder:

Category Fields/Descriptions
Scope Scoping Method: Options include:

• Geometry Selection (p. 586)

• Worksheet (p. 587)

Definition Send to Solver: This property controls whether the named


selection is passed to the solver. Also see Passing Named
Selections to the Solver in the Meshing User's Guide.

Note

The solvers (p. 191) supported by Mechanical


are the only solvers that recognize node- and
element-based Named Selections. Therefore,
the Send to Solver feature supports
Mechanical solvers only for node- and
element-based Named Selections.

Send As (Element Face-based Named Selections only): Options


include Nodes (default) and Mesh200. If your Named
Selection is scoped to element faces, the Mesh200 option
converts the scoped element faces to MESH200 elements and
sends those elements as components to the solver.

Visible (p. 598): For a named selection that you have selected
in the tree, this property displays the geometry, elements, or
nodes defining the name selection in the Geometry window.
The default setting is Yes. Setting this property to No removes
the associated geometry from view in the Geometry window.

Program Controlled Inflation: (Include/Exclude) determines


whether faces in the named selection are selected to be
inflation boundaries for Program Controlled inflation (p. 606).
Also see Program Controlled inflation in the Meshing help.
Statistics Type: Manual if named selection was created in the
Mechanical application or generated due to a meshing failure;
Read-only status Imported if named selection was imported.
indications
Total Selection

Release 2020 R1 - © ANSYS, Inc.


1771
Objects Reference

Category Fields/Descriptions
Surface Area: this property is available for Face-based Named
Selection only and displays the surface area of the specified
face(s).

Length: this property is available for Edge-based Named


Selection only and displays the length of the specified edge(s).

Suppressed

Used by Mesh Worksheet: Yes if named selection is being


used by the Mesh worksheet. Also see the description of the
Mesh worksheet in the Meshing help.
Tolerance Tolerance Type:

(Worksheet-based Named • Program Controlled: Assigns default values.


Selections only)
• Manual: Makes Zero Tolerance and Relative Tolerance available.

Zero Tolerance

Relative Tolerance: Multiplying factor applied to the values


in the entire Worksheet.
Transfer Properties Source: this read-only property displays the source system
for the imported Named Selection.
(displays for Named
Selections imported
through the External Model
Component only)

Node Merge Group


This object defines nodes that have been merged on a generated mesh. Multiple Node Merge Group
options can be added as child objects to a Mesh Edit object. Requires mesh generation.

Tree Dependencies:

• Valid Parent Tree Object: Mesh (p. 1749), Mesh


Edit (p. 1761)

• Valid Child Tree Objects: Node Merge (p. 1774),


Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting the Node Merge
Group object:

• Click Node Merge Group or Node Merge on Mesh


Edit context toolbar.

• Click right mouse button on Mesh Edit object and


select Insert>Node Merge Group or Insert>Node
Merge.

Release 2020 R1 - © ANSYS, Inc.


1772
Node Merge Group

Additional Related Information:

• Mesh Editing

• Mesh Edit Context Toolbar (p. 81)

• Node Merge

The following right mouse button context menu options are available for this object.

• Insert>Node Merge Group

• Insert>Node Merge

• Generate

• Suppress/Unsuppress

• Enable/Disable Transparency

• Search Connections for Duplicate Pairs

• Delete

• Delete Children

• Rename

• Rename Based on Definition (p. 726)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Definition Method: Automatic Node Merge or Manual Node Merge
Scope Scoping Method

Geometry: appears if Scoping Method is set to Geometry Selection. In this case,


use selection filters (p. 126) to pick geometry (p. 125), click in the Geometry field, then
click Apply.

Named Selection: appears if Scoping Method is set to Named Selection.

Source Assembly: appears if Scoping Method is set to Source Assembly (Only


applicable for Assembled External and Mechanical Models (p. 554)).
Auto Detec- Tolerance Type (p. 687)
tion (p. 691)
Tolerance Slider (p. 687)

Tolerance Value (p. 687)

Use Range (p. 687)

Release 2020 R1 - © ANSYS, Inc.


1773
Objects Reference

Category Fields
Min Distance Percentage (p. 687)

Min Distance Value (p. 687)

Face/Face (p. 688)

Face/Edge (p. 688)

Edge/Edge (p. 688)

Group By (p. 690): None, Parts, Bodies, and Faces.

Search Across (p. 690)

Face Angle Tolerance: available only when Face/Edge is set to Yes. For faces that
will be excluded from the proximity detection pair, this property defines the minimum
angle between the faces above which the two face pairs will be ignored from proximity
detection. The default value is 70°.

Edge Overlap Tolerance: available only when Face/Edge is set to Yes. This tolerance
value is the minimum percentage that an edge may overlap the face and is included
as a valid proximity detection pair. The default value is 25%.

Suppressed: Toggles suppression of the selected group. The default is No. If set to
Yes, the group will be suppressed.
Statistics Connections: displays the number of connections associated with this parent object.

Active Connections: displays the number of connections that are currently active for
this parent object (i.e., not Suppressed).

Node Merge
The Node Merge feature enables you to merge pairs of nodes on the mesh. You can choose to merge
nodes automatically or manually. This feature requires mesh generation.

Tree Dependencies:

• Valid Parent Tree Object: Mesh (p. 1749),Mesh


Edit (p. 1761)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods:

• Click Node Merge on Mesh Edit context toolbar.

• Click right mouse button on Mesh Edit object and


select Insert>Node Merge.

• Click right mouse button on Node Merge object


and select Insert>Node Merge.

Release 2020 R1 - © ANSYS, Inc.


1774
Node Merge

Additional Related Information:

• Mesh Editing

• Node Merge

The following right mouse button context menu options are available for this object.

• Insert>Node Merge

• Generate

• Suppress/Unsuppress

• Enable/Disable Transparency

• Hide All Other Bodies

• Flip Master/Slave

• Search Connections for Duplicate Pairs

• Duplicate

• Copy

• Cut

• Delete

• Rename

• Rename Based on Definition (p. 726)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping Method
Master Geometry– is enabled if Scoping Method is set to Geometry Selection.
In this case, use selection filters (p. 126) to pick geometry (p. 125), click in the
Master Geometry field, then click Apply.
Slave Geometry– is enabled if Scoping Method is set to Geometry Selection.
In this case, use selection filters (p. 126) to pick geometry (p. 125), click in the Slave
Geometry field, then click Apply.
Master Bodies – is enabled if Scoping Method is set to Geometry Selection.
Slave Bodies – is enabled if Scoping Method is set to Geometry Selection.
Definition Scope Mode: read-only indication of Manual or Automatic.
Tolerance Type
Tolerance Slider: appears if Tolerance Type = Tolerance Slider.
Tolerance Value: appears if Tolerance Type = Tolerance Slider (read-only) or
Tolerance Value.

Release 2020 R1 - © ANSYS, Inc.


1775
Objects Reference

Category Fields
Thickness Scale Factor: appears if Tolerance Type = Use Sheet Thickness.
Suppressed (p. 13)

Node Move
The Node Move feature enables you to select and move individual nodes on the mesh. Requires mesh
generation.

Tree Dependencies:

• Valid Parent Tree Object: Mesh (p. 1749), Mesh


Edit (p. 1761)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after selecting the Mesh Edit object:

• Click Node Move button on Mesh Edit context


toolbar (p. 81).

• Click right mouse button on Mesh Edit object or


in the Geometry window and select Insert>Move
Node.

Additional Related Information:

• Mesh Editing

• Model Context Toolbar (p. 78)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Definition Number of Moves

Number of Nodes

Numbering Control
Represents a part, vertex, or Remote Point whose nodes/elements can be renumbered (p. 657). Any
number of these objects can exist within a Mesh Numbering (p. 1765) folder.

Release 2020 R1 - © ANSYS, Inc.


1776
Numbering Control

Tree Dependencies:

• Valid Parent Tree Object: Mesh Number-


ing (p. 1765)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after selecting Mesh Numbering
object:

• Click Numbering Control button on Mesh Num-


bering context toolbar.

• Click right mouse button on Mesh Numbering


object or in the Geometry window and select
Insert> Numbering Control.

Additional Related Information:

• Mesh Numbering (p. 657)

• Model Context Toolbar (p. 78)

The following right mouse button context menu options are available for this object.

• Renumber Mesh (p. 657)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping Method - specify either Geometry Selection or Remote
Point.
Geometry - appears if Scoping Method is set to Geometry Selec-
tion.
Remote Points - appears if Scoping Method is set to Remote Point.
Definition Begin Node Number (p. 657) - appears if Geometry is set to a part.
End Node Number (p. 657) - appears if Geometry is set to a part.
Begin Element Number (p. 657) - appears if Geometry is set to a
part.
End Element Number (p. 657) - appears if Geometry is set to a part.
Node Number (p. 657) - appears if Geometry is set to a vertex or if
Remote Points is set to a specific Remote Point.
Suppressed (p. 13)

Release 2020 R1 - © ANSYS, Inc.


1777
Objects Reference

Objective
The Objective object specifies the topology optimization goal. A Topology Optimization (p. 352) analysis
can have only one Objective object in the tree. The application inserts this object automatically when
you create a Topology Optimization analysis. See the Objective (p. 365) section for additional information.

Tree Dependencies:

• Valid Parent Tree Object: Topology


Optimization Environment (p. 1690).

• Valid Child Tree Objects: no supported child


objects.

Insertion Options: The application


automatically inserts this object. To add
additional Objective objects, highlight the
Topology Optimization environment and:

• Select Objective from the


Environment (p. 83) context toolbar.

• Right-click and select Insert>Objective.

Additional Related Information: Topology


Optimization (p. 352).

The following right mouse button context menu options are available for this object.

• Insert>Objective

• Insert>Mass Constraint (p. 1799)

• Insert>Volume Constraint (p. 1799)

• Insert>Global Von-Mises Stress Constraint (p. 1799) (Static Structural Analysis)

• Insert>Local Von-Mises Stress Constraint (p. 1799) (Static Structural Analysis)

• Insert > Displacement Constraint (p. 1799) (Static Structural Analysis)

• Insert > Reaction Force Constraint (p. 1799) (Static Structural Analysis)

• Insert > Natural Frequency Constraint (p. 1799) (Modal Analysis)

• Insert>Member Size (p. 1748)

• Insert > Pull out Direction (p. 1748)

• Insert > Extrusion (p. 1748)

Release 2020 R1 - © ANSYS, Inc.


1778
Optimization Region

• Insert > Symmetry (p. 1748)

• Insert > Cyclic (p. 1748)

• Grouping/Ungrouping (p. 100) options

• Commands Objects (p. 1475)

Object Properties
The Details view (p. 17) properties for this object are examined in the Objective (p. 365) section.

Optimization Region
The Optimization Region object specifies the geometric entity on a model that will be optimized using
a Topology Optimization (p. 352) analysis. The application inserts this object automatically when you
create a Topology Optimization analysis. See the Optimization Region (p. 357) section for additional in-
formation.

Exclusion Region

The Exclusion Region object is an insertable child object of the Optimization Region object. The Ex-
clusion Region object enables you to specify additional geometric entities (body, face, edge, and ele-
ments) and/or geometry- or element-based Named Selections to the scoping of the Exclusion Region
of the Optimization Region object.

Release 2020 R1 - © ANSYS, Inc.


1779
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Topology


Optimization Environment (p. 1690).

• Valid Child Tree Objects: Exclusion Region.

Insertion Options: The application


automatically inserts this object. Only one
Optimization Region is supported for a
Topology Optimization analysis.

Additional Related Information: See


Topology Optimization (p. 352).

The following right mouse button context menu options are available for this object.

• Insert>Exclusion Region

• Insert > Objective (p. 1778)

• Insert>Mass Constraint (p. 1799)

• Insert>Volume Constraint (p. 1799)

• Insert>Global Von-Mises Stress Constraint (p. 1799) (Static Structural Analysis)

• Insert>Local Von-Mises Stress Constraint (p. 1799) (Static Structural Analysis)

• Insert > Displacement Constraint (p. 1799) (Static Structural Analysis)

• Insert > Reaction Force Constraint (p. 1799) (Static Structural Analysis)

• Insert > Natural Frequency Constraint (p. 1799) (Modal Analysis)

• Insert>Member Size (p. 1748)

• Insert > Pull out Direction (p. 1748)

• Insert > Extrusion (p. 1748)

Release 2020 R1 - © ANSYS, Inc.


1780
Part

• Insert > Symmetry (p. 1748)

• Insert > Cyclic (p. 1748)

• Grouping/Ungrouping (p. 100) options

• Commands Objects (p. 1475)

Object Properties
The Details view (p. 17) properties for this object are examined in the Optimization Region (p. 357)
section.

Part
Defines a component of the attached geometry included under a Geometry (p. 1701) object. The Part
object is assumed to be a multibody part (p. 477) with Body objects beneath it as depicted in the figure
below. The Part object label in your Project tree inherits the name from the CAD application you use
to create the part and may differ based on the CAD application. Refer to the Body (p. 1644) objects refer-
ence page if the Geometry object does not include a multibody part, but instead only includes indi-
vidual bodies.

Also see the description of the Virtual Body Group (p. 1843) object (applicable to assembly meshing al-
gorithms only).

Tree Dependencies:

• Valid Parent Tree Object: Geometry (p. 1701)

• Valid Child Tree Objects: Body (p. 1644), Comment (p. 1654), Figure (p. 1697),
Image (p. 1706)

Insertion Options: Appears by default when geometry is attached (p. 174)


that includes a multibody part.

Additional Related Information:

• Attaching Geometry (p. 174)

The following right mouse button context menu options are available for this object.

• Search Faces with Multiple Thicknesses (p. 497)

• Create Selection Group (p. 94)

• Generate Mesh

• Preview> Surface Mesh - appears only for a solid body.

• Preview> Inflation

• Group (p. 100)

Release 2020 R1 - © ANSYS, Inc.


1781
Objects Reference

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Graphics Properties The following properties enable you to change the graphical display
of a part.

Visible: toggles the display of the part On or Off in the Geometry


window.
Transparency
Color
Definition Suppressed (p. 13)
Assignment
Brick Integration Scheme (p. 484): appears only if Element
Control is set to Manual in the Details view of the Geo-
metry (p. 1701) object.
Coordinate System (p. 1677): assign a local coordinate system to
specify the alignment of the elements of the part if previously
defined using one or more Coordinate System (p. 1677) objects;
not available if Stiffness Behavior is set to Rigid.
Bounding Length X
Box (p. 181) Length Y
Length Z
Properties - Volume
Read-only Mass: appears only in the Mechanical application.
indication of the
properties originally Note
assigned to the
part. • If the material density is temperature dependent, the Mass
is computed at the body temperature, or at 22° C (default
temperature for an environment).

Centroid X
Centroid Y
Centroid Z
Moment of Inertia Ip1
Moment of Inertia Ip2
Moment of Inertia Ip3
Surface Area (approx.): appears only for a surface body.
Statistics - Nodes
Read-only Elements
indication of the Mesh Metric
entities that
comprise the part.

Release 2020 R1 - © ANSYS, Inc.


1782
Path

Path
Represents a spatial curve to which you can scope results. The results are evaluated at discrete points
along this curve.

Tree Dependencies:

• Valid Parent Tree Object: Construction Geometry (p. 1667)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706).

Insertion Options: Use any of the following methods after selecting


Construction Geometry object:

• Click Path button on Construction Geometry context toolbar.

• Click right mouse button on Construction Geometry (p. 1663) object or in the
Geometry window> Insert>Path.

Additional Related Information:

• Specifying a Path (p. 661)

• Specifying Construction Geometry (p. 661)

• Construction Geometry Object Reference (p. 1667)

• Surface Object Reference (p. 1828)

• Solid Object Reference (p. 1816)

The following right mouse button context menu options are available for this object.

• Snap to mesh nodes (p. 664)

• Flip Path Orientation

• Export (p. 661)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Defini- Path Type: the display of the various other Details view properties change based
tion (p. 661) on the selection for this property. The options include: Two Points (default), Edge,
and X Axis Intersection.

Path Coordinate System

Number of Sampling Points

Suppressed

Release 2020 R1 - © ANSYS, Inc.


1783
Objects Reference

Category Fields
Start (p. 661) Coordinate System

Start X Coordinate

Start Y Coordinate

Start Z Coordinate

Location
End (p. 661) Coordinate System

End X Coordinate

End Y Coordinate

End Z Coordinate

Location
Scope Scoping Method. The options for this property include:
(Path
Type = • Geometry Selection (default): this option indicates that design region is applied
Edge to a geometry or geometries, which are chosen using a graphical selection tools.
Only)
When you specify Geometry Selection for the Scoping Method, the Geo-
metry property also displays.

• Named Selection: Indicates that the geometry selection is defined by a Named


Selection.

When you specify Named Selection for the Scoping Method, the Named
Selection property also displays. This property provides a drop-down list of
available user-defined Named Selections (p. 583).

Periodic/Cyclic Region/Pre-Meshed Cyclic Region


The Periodic Region, Cyclic Region, and Pre-Meshed Cyclic Region objects enable you to define in-
dividual planes for periodic conditions, anti-periodic conditions, cyclic conditions, or pre-meshed cyclic
conditions (p. 628). The Periodic Region/Cyclic Region/Pre-Meshed Cyclic Region objects are child
objects of the Symmetry (p. 1830) object.

Release 2020 R1 - © ANSYS, Inc.


1784
Periodic/Cyclic Region/Pre-Meshed Cyclic Region

Tree Dependencies:

• Valid Parent Tree Object: Symmetry (p. 1830)

• Valid Child Tree Objects: Comment (p. 1654),


Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the


following methods after highlighting the
Symmetry (p. 1830) object:

• Select Periodic Region/Cyclic


Region/Pre-Meshed Cyclic Region on
Symmetry context toolbar (p. 80).

• Right-click on the Symmetry (p. 1830) object,


or on an existing Periodic Region/Cyclic
Region or Symmetry Region object, or in
the Geometry window and select
Insert>Periodic Region/Cyclic
Region/Pre-Meshed Cyclic Region.

Additional Related Information:

• Symmetry

• Symmetry in the Mechanical


Application (p. 649)

• Symmetry Context Toolbar (p. 80)

Release 2020 R1 - © ANSYS, Inc.


1785
Objects Reference

The following right mouse button context menu option is available for this object.

• Insert>Symmetry Region

• Insert>Linear Periodic

• Insert>Cyclic Region

• Flip High/Low

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties/Descriptions
Scope Scoping Method

Low Boundary: appears if Scoping Method is set to Geometry Se-


lection.

High Boundary: appears if Scoping Method is set to Geometry


Selection.

Low Selection: appears if Scoping Method is set to Named Selec-


tion.

High Selection: appears if Scoping Method is set to Named Selec-


tion.
Definition Scope Mode

Type: not supported for Cyclic Region.

Release 2020 R1 - © ANSYS, Inc.


1786
Physics Region

Number of Sectors (Pre-Meshed Cyclic Region only): The entry


range is any real number greater than 2.

Coordinate System

Suppressed (p. 13)

Boundary DOF Orientation (Pre-Meshed Cyclic Region only):


Options include Chosen by Solver (default) and Manual. The Chosen
by Solver option instructs the solver to automatically assign nodal
DOFs at the sector boundary and the Manual option requires you
to specify the orientations using Nodal Orientations (p. 1120). See the
direct FE example (p. 632) in the Pre-Meshed Cyclic Symmetry (p. 630)
section for a discussion on the solver's DOF requirements and how
to apply them in Mechanical APDL Solver with Nodal Orientation
objects.
Tolerance - Pre- Relative Distance Tolerance: The default setting is Program
Meshed Cyclic Re- Controlled and this setting uses a value of -0.0001.
gion only.

Physics Region
You use the Physics Region object in an acoustic analysis to specify the geometry bodies that belong
to Structural or Acoustics physics type. All of the bodies must have a physics type associated via Physics
Region objects.

For more information on acoustic domain definition and FSI definition properties, please refer to Elements
for Acoustic Analysis section in the Mechanical APDL Element Reference.

Tree Dependencies:

• Valid Parent Tree Objects: The


Environment (p. 1690) object is the only valid parent
object.

• Valid Child Tree Objects: No current child objects


are supported for this object.

Insertion Options: Select the analysis's


environment object, and:

• Right-mouse click and select Insert>Physics


Region.

Or...

• Select the Physics Region button on the


Environment toolbar (p. 83).

The following right mouse button context menu options are available for this object:

• Insert>Physics Region

Release 2020 R1 - © ANSYS, Inc.


1787
Objects Reference

• Insert>Acoustics > [see Load Type Boundary Conditions (p. 938)]

• Insert>Structural > [see Load Type Boundary Conditions (p. 938)]

• Insert>Commands (p. 1652)

• Suppress (p. 13)/Unsuppress

• Rename Based On Definition: Renames the selected physics region based on the physics type definitions
on the Physics Region object.

• Group (p. 100)

• Group Similar Objects (p. 100)

Note

See the Harmonic Acoustics Analysis (p. 247) and Modal Acoustics Analysis (p. 253) for the
supported loads for each analysis type.

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties/Options
Scope Scoping method: Specify as Geometry Selection (default) or Named Selection.

Geometry (Body selection only): Visible when the Scoping Method property is set
to Geometry Selection. You use this property to specify the body or bodies belonging
to structural or acoustic physics (using the properties below). Use the Body selection
filter (p. 126) to pick your geometry (p. 125), click in the Geometry field, and then click
the Apply button that displays. After you select the geometry, this property displays
the geometric entities (1 Body, 3 Bodies, etc.).
Named Selection: Visible when the Scoping Method property is set to Named Se-
lection. This field provides a drop-down list of available user–defined (and body-based)
Named Selections.
Defin- Structural: Specify the selected geometry or geometries as Structural. The default setting
i- is No.
tion
Acoustics: Specify the selected geometry or geometries (solid bodies only) as Acoustic.
The default setting is No.

Suppressed (p. 13): Toggles suppression of the object. The default setting is No.
Acous- Artificially Matched Layers: Options include Off (default) and PML. When you select
tic PML, a new PML Options category displays in the details view that enable you to define
Do- the PML options, as described below.
main
Defin- For additional information, see the Artificially Matched Layers section in the Mechanical
i- APDL Acoustic Analysis Guide.
tion
(Visible
for

Release 2020 R1 - © ANSYS, Inc.


1788
Point Mass

Acoustic
Definition
Only)
PML PML Element Coordinate System: The Global Coordinate System is the default setting.
Op-
tions PML Options: Options for this property include 3D PML (default) and 1D PML.
(Visible
for Reflection Coefficients: Options for this property include Program Controlled (default)
Acoustic and Manual. When this property is set to Manual, the following additional properties
Definition display based upon the setting of the PML Options property, either:
Only)
3D PML Setting 1D PML
Setting
--Value in -X -- Value
Direction
--Value in +X
Direction
-- Value in -Y
Direction
-- Value in +Y
Direction
-- Value in -Z
Direction
-- Value in +Z
Direction

Evanescent Wave Attenuation: Options include No (default) and Yes.

For additional information, see the Perfectly Matched Layers (PML) section in the
Mechanical APDL Acoustic Analysis Guide.
Ad- Reference Pressure: Enter a Reference Pressure value. The default value is 2e-5 Pa.
vanced
(Visible Reference Static Pressure: Enter a Reference Static Pressure value. The default value is
for 101325 Pa.
Acoustic
Definition Fluid Behavior: Specify the compressibility of the fluid. Available options are Compressible
Only) (default) or Incompressible.

Note

For more detailed information about setting the Acoustic Domain Definition and Acoustic
FSI Definition, see the Elements for Acoustic Analysis section of the Mechanical APDL Element
Reference.

Point Mass
Represents the inertial effects from a body.

Release 2020 R1 - © ANSYS, Inc.


1789
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Geometry (p. 1701)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Geometry (p. 1701) object or Body (p. 1644) object:

• Click Point Mass button on Geometry context toolbar (p. 81).

• Click right mouse button on Geometry (p. 1701) object, Body object, or in the
Geometry window> Insert> Point Mass.

Additional Related Information:

• Point Mass (p. 505) Application

• Coordinate Systems (p. 671)

• Geometry Context Toolbar (p. 81)

The following right mouse button context menu options are available
for this object.

• Promote Remote Point (p. 618) (Remote Attachment Only)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping method: Specify as Geometry Selection (default) or
Named Selection or Remote Point (only available when a
user-defined Remote Point exists in the tree).
Geometry: Visible when the Scoping Method is set to Geometry
Selection. Displays the type of geometry (Body, Face, etc.) and
the number of geometric entities (for example: 1 Body, 2 Edges)
to which the boundary has been applied using the selection
tools. Use selection filters (p. 126) to pick geometry (p. 125), click
in the Geometry field, then click Apply. The Remote Attachment
option is the required Applied By property (see below) setting
if the geometry scoping is to a single face or multiple faces, a
single edge or multiple edges, or multiple vertices.
Named Selection: Visible when the Scoping Method is set to
Named Selection. This field provides a drop-down list of available
user–defined Named Selections.
Remote Points: Visible when the Scoping Method is set to Re-
mote Point. This field provides a drop-down list of available
user–defined Remote Point.
Applied By: Specify as Remote Attachment (default) or Direct
Attachment.

Release 2020 R1 - © ANSYS, Inc.


1790
Pre-Meshed Crack

Coordinate System: Aligns the inertial axes of the Point Mass


with a local coordinate system. The local system must have been
previously defined by one or more Coordinate System objects.
For the Rigid Dynamics solver, the Mass Moment of Inertia axes
also align to this coordinate system. For the Mechanical APDL
Solver, the Mass Moment of Inertia axes align to the Global
Coordinate System.
X Coordinate: Define X coordinate location; can be designated
as a parameter (p. 26).
Y Coordinate: Define Y coordinate location; can be designated
as a parameter (p. 26).
Z Coordinate: Define Z coordinate location; can be designated
as a parameter (p. 26).
Location: Change location of the load. Pick new location, click
in the Location field, then click Apply.
Definition Mass: Define mass; can be designated as a parameter (p. 26).
Mass Moment of Inertia X: Available for 3D models only.
Mass Moment of Inertia Y: Available for 3D models only.
Mass Moment of Inertia Z: Available for 2D and 3D models.
Suppressed (p. 13)
Behavior (p. 614)
Material: This property is available when the Behavior property
is set to Beam. Select a material to define material properties for
the beams used in the connection. Density is excluded from the
material definition.
Radius: This property is available when the Behavior property
is set to Beam. Specify a radius to define the cross section
dimension of the circular beam used for the connection.
Pinball Region (p. 715)

Pre-Meshed Crack
Defines a crack that is based on a previously generated mesh and used to analyze crack fronts based
on a Named Selection.

Tree Dependencies:

• Valid Parent Tree Object: Fracture (p. 1699)

Insertion Options: Right-click the Frac-


ture (p. 1699) object, the Arbitrary Crack object,
the Semi-Elliptical Crack object, or the Pre-
Meshed Crack object and select Insert>
Pre-Meshed Crack.

Additional Related Information:

• Defining a Pre-Meshed Crack (p. 863)

The following right mouse button context menu options are available for this object.

• Insert> Arbitrary Crack

Release 2020 R1 - © ANSYS, Inc.


1791
Objects Reference

• Insert> Semi-Elliptical Crack

• Insert>Pre-Meshed Crack

• Generate All Crack Meshes

• Suppress

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Source: Read-only field indicating the type of crack definition.
Scoping Method: Read-only and always set to Named Selection when
defining pre-meshed cracks.
Crack Tip (Named Selection): Assign the scoping of the Pre-Meshed
Crack to a valid Named Selection. Click in the Named Selection field
and select a node-based named selection. This option is only applicable
to 2D analysis.
Crack Front (Named Selection): Assign the scoping of the Pre-Meshed
Crack to a valid Named Selection. Click in the Named Selection field
and select a named selection consisting of nodes. This option is only
applicable to 3D analysis.
Definition Coordinate System: Specifies the coordinate system that defines the
position and orientation of the crack. The Y axis of the specified
coordinate system defines the crack surface normal. The origin of the
coordinate system represents the open side of the crack. You can select
the default coordinate system or a local coordinate system that you
have defined. The default is the Global Coordinate System. The valid
coordinate system must be of type Cartesian.
Solution Contours: Specifies the number of contours for which you
want to compute the fracture result parameters.
Symmetry: Specifies the crack symmetry about a line (in 2D analysis)
or about a plane (in 3D analysis). The default is No.
Suppressed: Toggles suppression of the Pre-Meshed Crack object. The
default is No. The Pre-Meshed Crack object is suppressed automatically
if the scoped named selection is suppressed.

Pre-Stress
Defines the structural analysis whose stress results are to be used in a Harmonic Response Analysis (p. 211)
or Modal Analysis (p. 227), or whose stress-stiffening effects are to be used in a Eigenvalue Buckling
Analysis (p. 203), or whose stresses, strains, and/or displacements, or velocities are to be used in an Ex-
plicit Dynamics Analysis.

Tree Dependencies:

• Valid Parent Tree Object: Harmonic Response, Modal, or Eigenvalue Buckling , or Explicit Dynamics
environment (p. 1690) object.

• Valid Child Tree Objects: Commands (p. 1652), Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Release 2020 R1 - © ANSYS, Inc.


1792
Pre-Stress

Insertion Options:

Appears by default for a Harmonic Response, Modal, Eigenvalue Buckling, or an Explicit Dynamics ana-
lysis.

Additional Related Information:

• Harmonic Response (p. 211)

• Modal Analysis (p. 227)

• Eigenvalue Buckling Analysis (p. 203)

• Explicit Dynamics Analysis Guide

• Define Initial Conditions (p. 186)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Definition (p. 186) Pre-Stress Environment

Harmonic Response, Modal, or Eigenvalue Buckling environments


only:

Pre-Stress Define By (p. 189) - Specify this property as Pro-


gram Controlled (default), Load Step, or Time.

Release 2020 R1 - © ANSYS, Inc.


1793
Objects Reference

Pre-Stress Loadstep (p. 189) - Displays when Pre-Stress


Define By is specified as Load Step. Enter the load step of
Static Structural analysis that you’ll use as the starting point
to begin your Harmonic Response, Modal, or Eigenvalue
Buckling analysis. The default value is Last.
Pre-Stress Time (p. 189) - Displays when Pre-Stress Define
By is specified as Time. Enter the time from the Static
Structural analysis that you want to use as the starting point
to begin your Harmonic Response, Modal, or Eigenvalue
Buckling analysis. The default value is End Time.
Reported Loadstep (p. 189) - Read-only field.
Reported Substep (p. 189) - Read-only field.
Reported Time (p. 189) - Read-only field.
Contact Status (p. 189) - Options include Use True Status,
Force Sticking, Force Bonded.
Newton-Raphson Option - Read-only field for Pre-Stressed
Modal Analyses. Indicates whether the property was selected
in the prestressed environment. Options include Program
Controlled, Full, Modified, Unsymmetric.

Explicit Dynamics environments only:

Mode - Specify this property as Displacement or Material


State.
Time Step Factor - Displays when Mode is specified as
Displacement.
Pressure Initialization - Displays when Mode is specified as
Material State. Specify this property as From Deformed State
(default) or From Stress Trace.
Time - The time at which results are extracted from the
implicit analysis.

Probe
Determines results at a point on a model or finds minimum or maximum results on a body, face, vertex,
or edge.

Tree Dependencies:

• Valid Parent Tree Object: Solution (p. 1817)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options:

• Use any of the following methods after highlighting Solution (p. 1817) object
or an existing Probe object:

– Choose Probe> {specific probe} on Solution context toolbar (p. 84).

– Click right mouse button on Solution (p. 1817) object or in the Geometry
window> Insert> Probe> {specific probe}.

Release 2020 R1 - © ANSYS, Inc.


1794
Project

Additional Related Information:

• Probes (p. 1175)

The following right mouse button context menu options are available for this object:

• Evaluate All Results (p. 1212)

• Rename Based on Definition (p. 1366)

Object Properties
See the Probe Details View (p. 1179) section.

Project
Includes all objects in the Mechanical application and represents the highest level in the object tree.
Only one Project can exist per Mechanical session.

Tree Dependencies:

• Valid Parent Tree Object: None - highest level in the


tree.

• Valid Child Tree Objects: Comment (p. 1654), Mod-


el (p. 1767)

Insertion Options:

Appears by default in every Mechanical session.

The following right mouse button context menu options are available for this object.

• Solve (p. 1373)

• Clear Generated Data (p. 1199)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Title Page - You Author
can enter the Subject
following Prepared for
information that
will appear on the
title page of the
report (p. 31).
Information - The First Saved
Mechanical application Last Saved
provides the following Product Version

Release 2020 R1 - © ANSYS, Inc.


1795
Objects Reference

information that will


appear on the title page
of the report (p. 31).
Project data Manage- Save Project Before Solution- Saves the entire project immediately
ment before solving (after any required meshing). If the project had never
been previously saved, you can now select a location to save a new
file.

Save Project After Solution- Saves the project immediately after


solving but before postprocessing. If the project had never been
previously saved, nothing will be saved.

Note

• The default values can be specified in Tools>Options under


the Miscellaneous (p. 115) section.

• The Save Options defaults are applicable only to new projects.


These settings will not be changed for existing projects.

• These properties are not supported if you are using the


Workbench System Coupling component system in
combination with your Mechanical analysis.

Remote Point
Allows scoping of remote boundary conditions (p. 1132).

Tree Dependencies:

• Valid Parent Tree Object: Remote Points (p. 1798).

• Valid Child Tree Objects: Commands (p. 1652),


Comment (p. 1654), Figure (p. 1697)

Insertion Options: Use any of the following


methods after highlighting Model or Remote
Points object:

• Choose Remote Point on Model or Remote


Points context toolbar.

• Click right mouse button on the Model (p. 78) or


Remote Points object or in the Geometry window
and select Insert> Remote Point.

Additional Related Information:

• Remote Point (p. 609)

• Remote Boundary Conditions (p. 1132)

Release 2020 R1 - © ANSYS, Inc.


1796
Remote Point

The right mouse button context menu option Promote to Named Selection (p. 597) is available for
Remote Point objects.

The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping Method: Specify as Geometry Selection (default), Named Selection,
or Free Standing. Free Standing Remote Points can be used to model
structures such as Tuned Mass Dampers by directly connecting pieces of your
model together.

Note

When you specify Free Standing, the Geometry, Pinball Re-


gion, Behavior, and DOF Selection properties do not appear
in the Details view.

Geometry: Appears if Scoping Method is set to Geometry Selection. Choose


geometry entity then click Apply.

Named Selection: Appears if Scoping Method is set to Named Selection.


Choose a Named Selection from the drop-down menu. Named selections can
be geometry or node-based.

Coordinate System: The Coordinate System based on the original location


of the remote point. This property does not change if you modify the remote
point’s position with the Location property.

X Coordinate: The distance from the coordinate system origin on the x axis.

Y Coordinate: The distance from the coordinate system origin on the y axis.

Z Coordinate: The distance from the coordinate system origin on the z axis.

Location:

When selected, this property displays the remote point's location.


The property allows you to manually modify the remote point’s
original position. Changing the Location does not establish a new
coordinate system (reflected by the above Coordinate System
property) and re-plots the x, y, and z coordinate locations.

For a Free Standing remote point, use this property to define the
remote point's position in space.

Important

When you first scope a Remote Point and you do not also
define the Location property, the application sets the position
of the remote point to the centroid of the scoped geometry
selection(s).

Release 2020 R1 - © ANSYS, Inc.


1797
Objects Reference

Category Fields

Any subsequent scoping changes will not change this position.


You must update the Remote Point’s location as needed.

Definition Suppressed (p. 13)

Behavior (p. 614)

Pinball Region (p. 715)

DOF Selection: Specify as Program Controlled (default) or Manual. This


property provides control of which DOF’s will activate for corresponding
constraint equations. If the Manual setting is selected, the following additional
properties display.

• X Component

• Y Component

• Z Component

• Rotation X

• Rotation Y

• Rotation Z

Pilot Node APDL Name: This optional property enables you to create a
Mechanical APDL parameter (in the input file) and assign its value to the pilot
node number of the Remote Point. This facilitates easy programmatic
identification of the Remote Point’s pilot node for later use/reference in a
Command object (p. 1475).
Advanced Material: This property is available when the Behavior property is set to
Beam. Select a material to define material properties for the beams used in
Visible for Beha- the connection. Density is excluded from the material definition.
vior set to
Beam only. Radius: This property is available when the Behavior property is set to Beam.
Specify a radius to define the cross section dimension of the circular beam
used for the connection.

Remote Points
Houses all Remote Point (p. 1796) objects.

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Comment (p. 1654) Re-


mote Point (p. 1796)

Release 2020 R1 - © ANSYS, Inc.


1798
Response Constraint

Insertion Options: Use any of the following


methods after highlighting Model object:

• Choose Remote Point on Model (p. 78) context


toolbar.

• Click right mouse button on the Model object or


in the Geometry window, select Insert> Remote
Point.

Additional Related Information:

• Remote Point (p. 609)

• Remote Boundary Conditions (p. 1132)

Object Property
The Details view (p. 17) property for this object includes the following.

Category Fields
Graphics Show Connection Lines (p. 617)

Response Constraint
A Response Constraint (p. 362) is defined as either a Mass Constraint, Volume Constraint, Global Von-
Mises Stress Constraint (Structural), or Natural Frequency Constraint (Modal) object.

This constraint is required for a Topology Optimization (p. 352) analysis. The application inserts this object
automatically when you create a Topology Optimization (p. 352) analysis. The default response constraint
is a Mass Constraint object.

Release 2020 R1 - © ANSYS, Inc.


1799
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Topology


Optimization Environment (p. 1690).

• Valid Child Tree Objects: No supported child


objects.

Insertion Options: The application


automatically inserts this object as a Mass
Constraint. To add additional constraint
objects, highlight the Topology
Optimization environment and either:

• Select the desired constraint from the


Response Constraint drop-down menu
on the Environment (p. 83) context
toolbar.

• Right-click the environment object or


within the Geometry window and select
Insert>[desired constraint].

Additional Related Information: See


Topology Optimization (p. 352).

The following right mouse button context menu options are available for this object.

• Insert>Objective (p. 1778)

• Insert>Mass Constraint (p. 1799)

• Insert>Volume Constraint (p. 1799)

• Insert>Global Von-Mises Stress Constraint (p. 1799) (Static Structural Analysis)

• Insert>Local Von-Mises Stress Constraint (p. 1799) (Static Structural Analysis)

• Insert>Displacement Constraint (p. 1799) (Static Structural Analysis)

• Insert > Reaction Force Constraint (p. 1799) (Static Structural Analysis)

• Insert > Natural Frequency Constraint (p. 1799) (Modal Analysis)

• Insert > Member Size (p. 1748)

• Insert > Pull out Direction (p. 1748)

• Insert > Extrusion (p. 1748)

• Insert > Symmetry (p. 1748)

• Insert > Cyclic (p. 1748)

• Grouping/Ungrouping (p. 100) options

Release 2020 R1 - © ANSYS, Inc.


1800
Response PSD Tool (Group)

• Commands Objects (p. 1475)

Object Properties
The Details view (p. 17) properties for this object are examined in the Response Constraint (p. 362)
section.

Response PSD Tool (Group)


For Random Vibration (p. 235) analyses, the Response PSD Tool enables you to control the sampling
points of Response PSD probes (p. 1300).

Tree Dependencies:

• Valid Parent Tree Object: The Solution (p. 1817) object is the only valid
parent object.

• Valid Child Tree Objects: The Response PSD probe (p. 1300) is the only
valid child object.

Insertion Options:

• Use any of the following methods after highlighting Solution (p. 1817)
object:

– Display the Tools drop-down menu on the Solution context


toolbar (p. 84) and select Response PSD Tool.

– Right-click the Solution (p. 1817) object or in the Geometry window and
select Insert>Response PSD Tool>Response PSD Tool.

Additional Related Information:

• Response PSD Tool (p. 1303)

• Response PSD Probe (p. 1300)

• Random Vibration Analysis (p. 235)

The following right mouse button context menu options are available for this object.

• Evaluate All Results (p. 1212): available for Response PSD Tool and all child objects when the Response
PSD Tool is inserted under a Solution (p. 1817) object.

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Options Include All Excitation Frequencies: Options include Yes (default) and No. Selecting
Yes includes all excitation frequencies in the sampling. The No option includes

Release 2020 R1 - © ANSYS, Inc.


1801
Objects Reference

minimum and maximum excitation frequencies in addition to the frequency


samplings for natural frequencies.

Include User Defined Frequencies: Options include Yes and No (default). Selecting
Yes enables you to manually enter frequencies in the Tabular Data table (User
Defined Frequency Steps).

Clustering Frequency Points: The default value is 20. This property enables you
to define the number of frequencies generated for both sides of the natural
frequencies for response PSD result evaluations. If your response PSD curve contains
a number of spikes, you can add more frequency points to obtain a more accurate
RMS result, however; this increases evaluation time.

Result Tracker
Provides results graphs of various quantities (for example, deformation, contact, temperature, kinetic
energy, stiffness energy) vs. time.

Tree Dependencies:

• Valid Parent Tree Object: Solution Informa-


tion (p. 1820)

• Valid Child Tree Objects: Comment (p. 1654), Im-


age (p. 1706)

Insertion Options: Use any of the following


methods after highlighting Solution Informa-
tion (p. 1820) object:

• Choose Result Tracker> {name of Result Tracker}


on Solution Information context toolbar (p. 84).

Note

For a solution in a solved state,


the application allows you to add
and evaluate Contact Results
Trackers. For all other Result
Tracker types, you must first clear
the solution.

• Click right mouse button on Solution Informa-


tion (p. 1820) object or in the Geometry window>
Insert> {name of Result Tracker}.

Additional Related Information:

• Result Tracker Objects (p. 1405)

• Solution Context Toolbar (p. 84)

Release 2020 R1 - © ANSYS, Inc.


1802
Result Tracker

The following right mouse button context menu options are available for this object.

• Export (p. 1407) - available after solution is obtained.

• Rename Based on Definition (p. 1366)

• Evaluate All Results (Only visible for Contact result trackers (p. 1408) with the Enhanced Tracking property
set to Yes.)

• Evaluate All Contact Trackers: evaluates all contact trackers (Only visible for Contact result trackers (p. 1408)
with the Enhanced Tracking property set to Yes.)

• Evaluate Contact Tracker: evaluates selected contact tracker (Only visible for Contact result trackers (p. 1408)
with the Enhanced Tracking property set to Yes.)

Object Properties
The Details view (p. 17) properties for this object include the following.

Note

Properties may differ for Result Trackers in Explicit Dynamics systems. See Result Trackers
for more information.

Category Fields
Scope Scoping Method (p. 1405) - appears for a Temperature result
tracker object.
Geometry (p. 1405) - appears for a Deformation result tracker
object, or for a Temperature object if Scoping Method is set to
Geometry Selection. Use selection filters (p. 126) to pick
geometry (p. 125), click in the Geometry field, then click Apply.
Contact Region - appears for a Contact result tracker (p. 1408)
object.
Enhanced Tracking - appears for a Contact result tracker (p. 1408)
object.
Definition Type (p. 1405) - Read-only indication of result tracker type for De-
formation and Temperature objects. For Contact object, specify
contact output.
Orientation (p. 1405) - appears for a Deformation result tracker
object.
Suppression – Prior to solving, you can include or exclude the
result from the analysis. The default is value is No.
Results Minimum - Read-only indication of the minimum value of the
result tracker type.
Maximum - Read-only indication of the maximum value of the
result tracker type.
Filter - displayed only for Type
Explicit Dynamics Cut Frequency - appears if Type = Butterworth.
systems. Minimum filtered value - appears if Type = Butterworth.
Maximum filtered value - appears if Type = Butterworth.

Release 2020 R1 - © ANSYS, Inc.


1803
Objects Reference

Results and Result Tools (Group)


Defines the engineering output for displaying and analyzing the results from a solution.

Applies to the following objects:

Category Object
Structural Bending Stress (p. 1236), Bolt Tool (p. 1274), Campbell Diagram (p. 1305), Directional Accelera-
tion (p. 1226), Damage Status (p. 1239), Directional Deformation (p. 1226), Directional Velo-
city (p. 1226), Elastic Strain Intensity (p. 1231), Energy Dissipated Per Unit Volume (p. 1239),
Equivalent Creep Strain (p. 1235), Equivalent Plastic Strain (p. 1234), Equivalent Stress (p. 1230),
Equivalent Total Strain (p. 1235), Fiber Compressive Damage Variable (p. 1239), Fiber Compress-
ive Failure Criterion (p. 1239), Fiber Tensile Damage Variable (p. 1239), Fiber Tensile Failure
Criterion (p. 1239), Frequency Response (p. 1246), Linearized Stresses (p. 1238), Max Failure Cri-
teria (p. 1239), Matrix Compressive Damage Variable (p. 1239), Matrix Compressive Failure
Criterion (p. 1239), Matrix Tensile Damage Variable (p. 1239), Matrix Tensile Failure Cri-
terion (p. 1239), Maximum Principal Elastic Strain (p. 1231), Maximum Principal Stress (p. 1231),
Maximum Shear Elastic Strain (p. 1231), Maximum Shear Stress (p. 1256), Membrane
Stress (p. 1235), Middle Principal Elastic Strain (p. 1231), Middle Principal Stress (p. 1231), Minimum
Principal Elastic Strain (p. 1231), Minimum Principal Stress (p. 1231), Mullins Damage Vari-
able (p. 1239), Mullins Max Previous Strain Energy (p. 1239), Normal Elastic Strain (p. 1875),
Normal Gasket Pressure (p. 1304), Normal Gasket Total Closure (p. 1304), Normal Stress (p. 1231),
Phase Response (p. 1246), Sheer Damage Variable (p. 1239), Shear Elastic Strain (p. 1231), Shear
Gasket Pressure (p. 1304), Shear Gasket Total Closure (p. 1304), Shear Stress (p. 1229), Strain
Energy (p. 1238), Stress Intensity (p. 1231), Structural Error (p. 1232), Thermal Strain (p. 1234), Total
Acceleration (p. 1226), Total Deformation (p. 1226), Total Velocity (p. 1226), Vector Principal
Elastic Strain (p. 1232), Vector Principal Stress (p. 1232)
Structural Axial Force (p. 1276), Beam Tool (p. 1275), Bending Moment (p. 1276), Direct Stress (p. 1275), Max-
Beams imum Bending Stress (p. 1275), Maximum Combined Stress (p. 1275), Minimum Bending
Stress (p. 1275), Minimum Combined Stress (p. 1275), Shear Force (p. 1276), Shear-Moment Dia-
gram (p. 1277), Torsional Moment (p. 1276)
Thermal Directional Heat Flux (p. 1312), Temperature (p. 1311), Thermal Error (p. 1313), Total Heat
Flux (p. 1312), Fluid Flow Rate (p. 1313), Fluid Heat Conduction Rate (p. 1313)
Magnetostatic
Current Density (p. 1317), Directional Field Intensity (p. 1317), Directional Flux Density (p. 1317),
Directional Force (p. 1317), Electric Potential (p. 1317), Flux Linkage (p. 1318), Inductance (p. 1317),
Magnetic Error (p. 1319), Total Field Intensity (p. 1317), Total Flux Density (p. 1317), Total
Force (p. 1317)
Electric Directional Current Density (p. 1321), Directional Electric Field Intensity (p. 1321), Electric
Voltage (p. 1321), Joule Heat (p. 1321), Total Current Density (p. 1321), Total Electric Field Intens-
ity (p. 1321)
General Coordinate Systems Results (group) (p. 1165), User Defined Result (p. 1340)
Optimization
Topology Density (p. 371), Topology Elemental Density (p. 373)
Acoustics Acoustics (p. 1308)
and
Acoustics Pressure, Total Velocity, Directional Velocity, Kinetic Energy, Potential Energy, Sound
Far Pressure, A-Weighted Sound Pressure Level, Frequency Band SPL, A-Weighted Frequency
Field Band SPL

Acoustics Far Field (p. 1309)

Release 2020 R1 - © ANSYS, Inc.


1804
Results and Result Tools (Group)

Category Object
Far Field SPL, Far Field A-Weighted SPL, Far Field Maximum Pressure, Far Field Phase, Far
Field Directivity, Far Field Maximum Scattered Pressure, Far Field Target Strength, Far Field
Sound Power Level

Tree Dependencies:

• Valid Parent Tree Object:

– For Direct Stress (p. 1275), Maximum Bending Stress (p. 1275), Maximum
Combined Stress (p. 1275), Minimum Bending Stress (p. 1275), Minimum
Combined Stress (p. 1275): Beam Tool (p. 1275)

– For Directional Deformation (p. 1226), Total Deformation (p. 1226): Beam
Tool (p. 1275), Solution (p. 1817)

– For all other result objects: Solution (p. 1817)

• Valid Child Tree Objects:

– For Beam Tool (p. 1275): Comment (p. 1654), Direct Stress (p. 1275), Directional
Deformation (p. 1226), Figure (p. 1697), Image (p. 1706), Maximum Bending
Stress (p. 1275), Maximum Combined Stress (p. 1275), Minimum Bending
Stress (p. 1275), Minimum Combined Stress (p. 1275), Total Deformation (p. 1226)

– For all other objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Note

Alert (p. 1632) and Convergence (p. 1676) may also apply.

Insertion Options:

• For results and result tools that are direct child objects of a Solution (p. 1817)
object, use any of the following methods after highlighting the Solution object:

– Open one of the toolbar drop-down menus or result category on the Solution
context toolbar (p. 84).

– Right-click the Solution (p. 1817) object or in the Geometry window, select
Insert, and then select desired result or result category.

• For results that are direct child objects of a specific result tool, use any of the
following methods after highlighting the specific result tool object:

– Choose result on the context toolbar related to the result tool.

– Right-click a specific result tool object, select Insert, and then select the
desired result or result category from the menu.

Additional Related Information:

• Using Results (p. 1161)

Release 2020 R1 - © ANSYS, Inc.


1805
Objects Reference

• Solution Context Toolbar (p. 84)

• Surface Body Results (including Layered Shell Results) (p. 1210)

• Automatic Result Creation for All Result Sets (p. 1356)

• Tabular Data (p. 51): You can use the Tabular Data window to make display
changes to your results as well as to create new results.

The following right mouse button context menu options may be available based on the Result object.

• Export>Export Text File (p. 54): export result data as a text file.

• Export (p. 54)>STL File: export result data in Standard Tessellation Language (STL) file format (Binary (p. 110)
is the default format setting).

• Export (p. 54)>ANSYS Viewer File (AVZ): export result data as a ANSYS Viewer File (.avz)

• Create Results At All Sets (p. 1356)

• Evaluate All Results (p. 1212)

• Convert To Path Result (p. 663) (for Results scoped to Edges Only)

• Promote to Named Selection (p. 597)

• Rename Based on Definition (p. 1366)

• Group (p. 100)

• Group Similar Objects (p. 100)

Object Properties
The Details view (p. 17) properties for this object may include the following.

The following applies to many result objects whose direct parent object is Solution (p. 1817). Many exceptions
are noted. For more complete information check individual descriptions for all results and result tools.

Category Properties
Scope Scoping Method: property options include Geometry Selection, Named
Selection (p. 1214), Path (p. 1168), Surface (p. 1173), Result File Item (p. 1218), or Surface
Coating (p. 1223).

The application displays one of the following associated properties based on your
Scoping Method selection:

Geometry
This property displays if the Scoping Method property is set to Geometry. Use
selection filters (p. 126) to pick geometry (p. 125), click in the Geometry field, then
click Apply.

Release 2020 R1 - © ANSYS, Inc.


1806
Results and Result Tools (Group)

Named Selection
This property displays if the Scoping Method property is set to Named Selection.
Specify named selection.

Path
This property displays if the Scoping Method property is set to Path. Select a
defined path (p. 661) from the drop-down list.

Surface
This property displays if the Scoping Method property is set to Surface. Select
a defined surface (p. 666) from the drop-down list.

Item Type
This property displays if the Scoping Method property is set to Result File Item.
The options include:

• Material IDs

• Element Name IDs

• Element Type IDs

• Component Name
The values associated with the above options are generated and displayed in
the Worksheet. Refer to the Result File Item (p. 1218) section for additional
information.

Solver Component IDs


This property displays if the Item Type property is set to Materials IDs,
Element Name IDs, or Element Type IDs. The default value is All. For the
Materials IDs and Element Name IDs options, you enter a number or a
number range (i.e., 1, 2, 3, or 2-5). For Element Name IDs, you enter an
element name, such as BEAM188, or, you can simply enter a group label,
such as "beam", to include all beam element types. See the Result File
Item (p. 1218) section of the Help.

Component Name
This property displays if the Item Type property is set to Component Name.
Specify a Component Name as listed in the Solver Component Names table of
the Worksheet. See the Result File Item (p. 1218) section of the Help.

Surface Coating
This property displays if the Scoping Method property is set to Surface Coating.
This property provides a drop-down menu of available surface coatings (p. 507).
The default setting for this property is All.

Sub Scope By: Options include:

• Layer: specifies the layer to calculate Shell result values. If selected, a Layer
property also displays that requires you to specify a Layer number.

• Ply: If selected, a Ply property also displays that requires you to select a target ply
from the Modeling Ply object in the tree. The result calculation uses the intersection

Release 2020 R1 - © ANSYS, Inc.


1807
Objects Reference

of the specified Ply and the Geometry property scoping. This option is not
supported for Design Assessment results.

Position (p. 1210) - appears only for stress and strain results (p. 1229) scoped to surface
bodies or to a layer (which may include a layer or ply of a solid body). Options
include: Top/Bottom, Top, Middle, and Bottom.
Definition Type: result type indication, can be changed within the same result category.
Read-only indication for:

Current Density (p. 1317), Electric Potential (p. 1317), Equivalent Plastic
Strain (p. 1234), Force Reaction (p. 1248), Magnetic Error (p. 1319), Strain En-
ergy (p. 1238), Structural Error (p. 1232), Temperature (p. 1311), Thermal Er-
ror (p. 1313), User Defined Result (p. 1340), Vector Principal Elastic
Strain (p. 1232), Vector Principal Stress (p. 1232)
For Fracture results (p. 1261): SIFS, J-Integral, VCCT, Material Force, T-
Stress, and C*-Integral.

Subtype: this property only displays for the Fracture Results (p. 1261) SIFS, VCCT,
and Material Force.

Response Type: appears for Random Vibration and Response Spectrum analyses
only and is only available for User Defined results. Options include Displacement
(default), Velocity, Acceleration, and Other Result.

Location Method: The Location Method property is available for the Force
Reaction (p. 1248) option (which is the same as the Force Reaction probe (p. 1290)) of
Frequency Response results (p. 1246). This property is used to specify the method
you want to extract use to frequency response results. Options include Boundary
Condition (default), Contact Region, Remote Points, Spring, and Beam. Based
upon your selection, one of the following corresponding properties display.

Boundary Condition: provides a drop-down list of available boundary


conditions that you use to scope the result to.
Contact Region: provides a drop-down list of available contact regions.
Remote Points: provides a drop-down list of available remote points.
Spring: provides a drop-down list of available body-ground springs.
Beam: provides a drop-down list of available body-ground beams.

Extraction: Only displayed for a Frequency Response (Force Reaction) result


when the Location Method is set to Contact Region. Options include: Contact
(Underlying Element) and Target (Underlying Element).

Orientation: appears only for: Axial Force (p. 1276), Directional Deformation (p. 1226),
Directional Field Intensity (p. 1317), Directional Flux Density (p. 1317), Directional
Force (p. 1317), Directional Heat Flux (p. 1312), Normal Elastic Strain (p. 1875), Normal
Stress (p. 1231), Shear Elastic Strain (p. 1231), Shear Stress (p. 1229), Torsional Mo-
ment (p. 1276), Shell Membrane Stress (p. 1235), Shell Bending Stress (p. 1236).

For Frequency Response results, this property is used to specify the


Orientation in which results are to be extracted. Options include X Axis
(default), Y Axis, and Z Axis.

Expression: appears only for User Defined Result (p. 1340).

Release 2020 R1 - © ANSYS, Inc.


1808
Results and Result Tools (Group)

Input Unit System: appears only for User Defined Result (p. 1340).

Output Unit: appears only for User Defined Result (p. 1340).

Identifier: appears only for User Defined Result (p. 1340).

Coordinate System (p. 1196): this property displays for results that change with
respect to a coordinate system, such as Normal Stress. For these result types, you
accept the default setting, Global Coordinate System, or you can select a local
coordinate system that you have defined, or select Solution Coordinate
System (p. 1196). When the Sub Scope By property is set to Ply, this property defaults
to the Fiber Coordinate System option.

Note

• The Fiber Coordinate System setting, when a result is scoped to a ply,


supports the Mechanical APDL Solver only. In addition, this setting
executes the same coordinate system commands as the Solution
Coordinate System (p. 1196) setting.

• If a result changes with respect to coordinate systems, then Mechanical


rotates this result in an identical fashion to Mechanical APDL. For an
explanation of rotating results to a different coordinate system, see the
Additional POST1 Postprocessing section in the Mechanical APDL Basic
Analysis Guide.

By: This property enables you to specify a value (time, frequency, maximum value)
for an independent variable for which you would like a contour result. The options
vary based on the type of analysis. See the Multiple Result Sets (p. 1209) section for
more information.

Note

This property is not available for the Far Field Sound Power Level,
Frequency Band SPL, and A-Weighted Frequency Band SPL
results.

Display Time: appears if By is set to Time. (See Note below.)

Frequency: appears if By is set to Frequency. (See Note below.)

Set Number: appears if By is set to Result Set.

Mode: appears for Modal analyses.

Calculate Time History: appears if By is set to Time or Set.

Sphere Radius: appears for all Far-field Results (p. 1309) in Harmonic Acoustic
analyses, except for the Far-Field Sound Power Level result.

Release 2020 R1 - © ANSYS, Inc.


1809
Objects Reference

Reference RMS Sound Pressure: appears for all Far-field Results (p. 1309) in Harmonic
Acoustic analyses, except for the Far-Field Sound Power Level result. The default
value is 2e-5 Pa.

Reference Sound Power Level: appears for Far-Field Sound Power Level (p. 1309)
result. Defaults to 1e-12 Pa.

Amplitude: appears for contour results in a Harmonic Response Analysis (p. 211)
only. Options include Yes or No (default). When the Amplitude property is set to
Yes, the amplitude contour result is displayed with respect to the Solution
Coordinate System (p. 1196).

Sweeping Phase:

• For a Harmonic Response Analysis (p. 211), this property appears only for contour
results when the Amplitude property is set to No and the By property is set to
Frequency, Set, Maximum Over Frequency, or Frequency of Maximum.

• For Damped Modal analysis, this property always appears for contour results and
for probe results when the By property is set to Mode, Maximum Over Modes,
or Mode of Maximum.

Phase Increment: appears if the By property is set to Maximum Over Phase or


Phase of Maximum. The entry can be between 1° and 10°. The default value is
10°.

Scale Factor: appears only for Random Vibration Analysis (p. 235). Options include
1 Sigma (default), 2 Sigma, 3 Sigma, and User Input.

Scale Factor Value: appears when you set the Scale Factor property to User Input.
The default value is 1.

Probability: read-only property that appears only for Random Vibration Analys-
is (p. 235). Presents a probability value corresponding to each sigma value.

Identifier: This property is available for all result types. It enables you to specify a
unique name/symbol/character that you can then use in the Expression property
of a User Defined result (p. 1348).

Suppressed: suppresses the object if set to Yes.

Contour Start: appears only for Fracture Results (p. 1261).

Contour End: appears only for Fracture Results (p. 1261).

Active Contour: appears only for Fracture Results (p. 1261).

Note

If you specify a Display Time or Frequency value which exceeds


the final time or frequency in the result file, then Mechanical will
not allow the result to be evaluated.
If you specify a Display Time or Frequency value for which no
results are available, then Mechanical performs a linear interpolation

Release 2020 R1 - © ANSYS, Inc.


1810
Results and Result Tools (Group)

to calculate the results at that specified time. The two times or


frequencies in the result file that are the closest to the specified
time/frequency are used in the interpolation. Note that the
application does not perform the interpolation for a display time
before the first result set.
No interpolation is performed for the Fracture Tool (p. 1263) results.
That is, for Fracture Results with a Display Time between the two
solution time points, only the data set associated with the lower of
the solution time points is used.

Options The Options category is only present for the Frequency Response and Phase
Response (p. 1246) result types.

Frequency Response
For the Frequency Response result type the properties include the following:

• Frequency Range: options include Use Parent (default) or Specified.

• Minimum Frequency: you can enter a value for this property when the Frequency
Range property is set to Specified, otherwise, it is read-only.

• Maximum Frequency: you can enter a value for this property when the Frequency
Range property is set to Specified, otherwise, it is read-only.

• Display: options include:

– Real

– Imaginary

– Real and Imaginary

– Amplitude

– Phase Angle

– Bode (default setting - plots both Amplitude and Phase Angle)

• Chart Viewing Style: select from the following options to select a scale to plot
results:

– Linear: this option plots the result values linearly.

– Log X: this option plots the X-Axis logarithmically. If negative axis values or a
zero value exists, this option is not supported and the graph plots linearly.

– Log Y (default when graph has Amplitude): this option plots the Y-Axis is plotted
logarithmically. If negative axis values or a zero value exists, this option is not
supported and the graph plots linearly.

– Log-Log: this option plots the X-Axis and Y-Axis logarithmically. If negative axis
values or a zero value exists, this option is not supported and the graph plots
linearly.

Release 2020 R1 - © ANSYS, Inc.


1811
Objects Reference

Phase Response
For the Phase Response result type, the properties include the following:

• Frequency: input frequency at which Phase Response is requested.

• Duration: phase period over which response is requested. The default setting is
720°.

Integration Display Option: appears only for result items that can display unaveraged contour
Point Results results (p. 1200).

Average Across Bodies: When you select Averaged as the Display Option, this
property displays. Setting this property to Yes (the default value is No) averages
results across separate bodies.
Results - Minimum: not available for Vector Principal Stress (p. 1232).
Read-only
status Maximum: not available for Vector Principal Stress (p. 1232).
indication of
result object. Minimum Occurs On: not available for: Current Density (p. 1317), Electric Poten-
tial (p. 1317), Strain Energy (p. 1238), Vector Principal Stress (p. 1232).

Maximum Occurs On: not available for: Current Density (p. 1317), Electric Poten-
tial (p. 1317), Strain Energy (p. 1238), Vector Principal Stress (p. 1232).

The following read-only properties display for Frequency Response results:

• Maximum Amplitude: reports maximum amplitude from all the result sets.

• Frequency: reports frequency at which maximum amplitude occurs.

• Phase Angle: reports phase angle at which maximum amplitude occurs.

• Real: reports real value at which maximum amplitude occurs.

• Imaginary: reports imaginary value at which maximum amplitude occurs.

Maximum This category provides read-only properties that display maximum values of the
Value Over results you select over time. These properties are only applicable for static, transient,
Time explicit, and design assessment analyses.
Minimum This category provides read-only properties that display minimum values of the
Value Over results you select over time. These properties are only applicable for static, transient,
Time explicit, and design assessment analyses.
Information - Time
Read-only
status Load Step
indication of
time Substep
stepping (p. 915).
Iteration Number

Acoustics

Category Properties

Release 2020 R1 - © ANSYS, Inc.


1812
Semi-Elliptical Crack

Phi Start: Starting Angle Phi. Appears for all Far-field Results (p. 1309) in Harmonic
Acoustic analyses except Far-Field Sound Power Level. Defaults to 0.0°.

End: Ending Angle Phi. Appears for all Far-field Results (p. 1309) in Harmonic Acoustic
analyses except Far-Field Sound Power Level. Defaults to 0.0°.

No. of Divisions: Number of Divisions in Phi direction. Appears for all Far-field
Results (p. 1309) in Harmonic Acoustic analyses except Far-Field Sound Power Level.
Defaults to 1.
Theta Start: Starting Angle Theta. Appears for all Far-field Results (p. 1309) in Harmonic
Acoustic analyses except Far-Field Sound Power Level. Defaults to 0.0°.

End: Ending Angle Theta. Appears for all Far-field Results (p. 1309) in Harmonic
Acoustic analyses except Far-Field Sound Power Level. Defaults to 0.0°.

No. of Divisions: Number of Divisions in Theta direction. Appears for all Far-field
Results (p. 1309) in Harmonic Acoustic analyses except Far-Field Sound Power Level.
Defaults to 1.
Ad- Model Type: appears for all Far-field Results (p. 1309) in Harmonic Acoustic analyses.
vanced Options include 3D (default), 2.5D Z-Direction Extrusion, and 2.5D Y-Axis Rotation
Extrusion.

Model Thickness in Z-Direction: appears when Model Type is set to 2.5D


Z-Direction Extrusion for a Far-field Result (p. 1309). Defaults to 0.0.

Y Axis Extrusion Angle: appears when Model Type is set to 2.5D Y-Axis Rotation
Extrusion for a Far-field Result (p. 1309). Defaults to 0.0 degrees.

Spatial Radiation Angle: appears for Far Field Directivity (p. 1309) and Far Field
Sound Power (p. 1309) results in Harmonic Acoustic analyses. Options include Full
(default) and Partial.

Starting Radiation Angle Phi: appears when Spatial Radiation Angle is set to
Partial for a Far-field Result (p. 1309). Defaults to 0.0 degrees.

Ending Radiation Angle Phi: appears when Spatial Radiation Angle is set to
Partial for a Far-field Result (p. 1309). Defaults to 0.0 degrees.

Starting Radiation Angle Theta: appears when Spatial Radiation Angle is set to
Partial for a Far-field Result (p. 1309). Defaults to 0.0 degrees.

Ending Radiation Angle Theta: appears when Spatial Radiation Angle is set to
Partial for a Far-field Result (p. 1309). Defaults to 0.0 degrees.

Semi-Elliptical Crack
Defines a semi-elliptical crack based on an internally generated mesh to analyze crack fronts by use of
geometric parameters.

Release 2020 R1 - © ANSYS, Inc.


1813
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Fracture (p. 1699)

Insertion Options: Right-click the Frac-


ture (p. 1699) object, the Arbitrary Crack object,
the Semi-Elliptical Crack object, or the Pre-
Meshed Crack (p. 1791) object and select
Insert>Semi-Elliptical Crack.

Additional Related Information:

• Defining a Semi-Elliptical Crack (p. 853)

• Fracture Analysis (p. 841)

• Fracture Meshing (p. 845)

The following right mouse button context menu options are available for this object.

• Insert>Arbitrary Crack

• Insert>Semi-Elliptical Crack

• Insert>Pre-Meshed Crack

• Generate All Crack Meshes

• Suppress

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties
Scope Source: Read-only and always set to Analytical Crack for Semi-Elliptical
Cracks.
Scoping Method: Read-only and always set to Geometry Selection
when defining cracks.
Geometry: Use the Body selection filter to pick a solid body, click in
the Geometry field, then click Apply.
Definition Coordinate System: Specifies the user-defined coordinate system that
defines the position and orientation of the crack.
Align with Face Normal: Defines the Crack Coordinate System (p. 855)
orientation. Options include Yes (default) and No.
Project to Nearest Surface: Defines the Crack Coordinate Sys-
tem (p. 855) origin. Options include Yes (default) and No.
Crack Shape: Read-only and always set to Semi-Elliptical.

Release 2020 R1 - © ANSYS, Inc.


1814
Semi-Elliptical Crack

Category Properties
Major Radius: Specifies the major radius, which defines the size of the
crack shape along the Z axis (that is, the width of the crack). The
specified value must be greater than 0.
Minor Radius: Specifies the minor radius, which defines the size of the
crack shape along the X axis (that is, the depth of the crack). The
specified value must be greater than 0.
Mesh Method: This property enables you to select the mesh method
to be used to mesh the semi-elliptical crack. Options include Hex
Dominant (default) and Tetrahedrons.
Largest Contour Radius: Specifies the largest contour radius for the
crack shape. Enter a value greater than 0.
Growth Rate (Mesh Method set to Tetrahedrons only): Specifies the
factor with which the mesh layers will grow along the radius of the
crack. Specify a value greater than 1. The default value is 1.2. The
recommended value is equal to or greater than 1.1.
Crack Front Divisions (Mesh Method set to Hex Dominant only):
Specifies the number of divisions for the crack front. The value must
be equal to or greater than 3. The default is 15. The Geometry window
can display only a maximum of 999 crack front divisions, but you can
specify a higher value and fracture meshing will respect it.
Front Element Size (Mesh Method set to Tetrahedrons only): Specifies
the element size for the crack front. Default value is computed from
crack's ellipse perimeter, which is crack ellipse perimeter/100. Specify
a value greater than 0.
Fracture Affected Zone(Mesh Method set to Hex Dominant only):
The fracture affected zone is the region that contains a crack. The
Fracture Affected Zone control determines how the fracture affected
zone height is defined. When set to Program Controlled, the software
calculates the height, and Fracture Affected Zone Height is read-only.
This is the default. When set to Manual, you enter the height in the
Fracture Affected Zone Height field.
Fracture Affected Zone Height(Mesh Method set to Hex Dominant
only): This value specifies two things: 1) the height of the Fracture
Affected Zone, which is in the Y direction of the crack coordinate
system; and 2) the distance in totality by which the Fracture Affected
Zone is extended in the positive and negative Z direction of the crack
coordinate system from the crack front extremities.
Circumferential Divisions (Mesh Method set to Hex Dominant only):
Specifies the number of circumferential divisions for the crack shape.
The default is 8. Your entry must be a multiple of 8 and it must be
equal to or greater than 8. The Geometry window can display only a
maximum of 360 circumferential divisions, but you can specify a higher
value and fracture meshing will respect it.
Mesh Contours: Specifies the number of mesh contours for the crack
shape. Your entry must be equal to or greater than 1. The default is 6.
The Geometry window can display only a maximum of 100 mesh
contours, but you can specify a higher value and fracture meshing will
respect it.
Solution Contours: Specifies the number of mesh contours for which
you want to compute the fracture result parameters. The value must
be less than or equal to the value of Mesh Contours, and cannot be

Release 2020 R1 - © ANSYS, Inc.


1815
Objects Reference

Category Properties
greater than 99. By default, the value is Match Mesh Contours,
indicating the number of Solution Contours is equal to the number
of Mesh Contours. Entering 0 resets the value to Match Mesh Con-
tours.
Suppressed: Toggles suppression of the Crack object. The default is
No. The Crack object is suppressed automatically if the scoped body
is suppressed.
Buffer Zone Scale Buffer Zone Scale Factors
Factors
It controls the size of the buffer zone in the X, Y, and Z directions, relative
to the dimensions of the crack. For each scaling parameter, use the slider
to set a value from 2 to 50. The default is 2. The maximum dimension
among the three directions of the crack is multiplied by the corresponding
scale factors to create a buffer zone. When the mesh method is
Hex-Dominant, the crack dimensions also includes fracture affected zone.

• X Scale Factor

• Y Scale Factor

• Z Scale Factor

Named Selections Named Selections are created automatically when the fracture mesh is generated.
Creation These Named Selections are a special type of Named Selection. For details, refer
to the Performing a Fracture Analysis (p. 841) and the Special Handling of Named
Selections for Crack Objects (p. 863) sections for more information. For
information about Named Selections in general, refer to Specifying Named
Selections in the Mechanical Application (p. 583).

Solid
The Solid object enables you to create and add a solid part to the model you have imported into
Mechanical.

Tree Dependencies:

• Valid Parent Tree Object: Construction Geometry (p. 1667)

• Valid Child Tree Objects: no child objects are currently


supported.

Insertion Options: Use any of the following methods after


selecting Construction Geometry object:

• Select the Solid option on Construction Geometry context


toolbar (p. 79).

• Right-click the Construction Geometry (p. 1663) object (or an


existing Solid object) or in the Geometry window and select
Insert>Solid.

Additional Related Information:

Release 2020 R1 - © ANSYS, Inc.


1816
Solution

• Specifying a Solid (p. 668)

• Specifying Construction Geometry (p. 661)

• Path Object Reference (p. 1783)

• Surface Object Reference (p. 1828)

The following right mouse button context menu options are available for this object.

• Insert>Solid

• Add to Geometry: this options generates your new solid part.

• Update Geometry: you use this option to apply any changes that you have made to the solid part.

• Remove Geometry: this option removes the solid part from the Geometry folder.

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Definition Type: this property is a read-only field that describes the object - Box.

Coordinate System: you use this property to change the coordinate system. The
default is Global Coordinate System.

The following properties define the Solid object's dimensions. These properties
define a start and end point for each dimension of your three-dimensional solid
part.

X1
X2
Y1
Y2
Z1
Z2

Part Name: a read-only field that displays the application assigned name. You can
change the Part Name property by changing the name of your Solid object and
updating the geometry. Changing the name in this way will also update the name
of the Solid object under the Geometry folder.

Solution
Defines result types and formats for viewing a solution.

Release 2020 R1 - © ANSYS, Inc.


1817
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Any environment (p. 1690) object.

• Valid Child Tree Objects: All general Results and Result Tools (p. 1804), Com-
mands (p. 1652), Comment (p. 1654), Figure (p. 1697), Image (p. 1706), Solution Inform-
ation (p. 1820)

Insertion Options: Appears by default for any analysis.

Note

A Solution object cannot be deleted from the tree.

Additional Related Information:

• Understanding Solving (p. 1373)

• Solution Context Toolbar (p. 84)

• Adaptive Convergence (p. 1411)

The following right mouse button context menu options are available for this object.

• Insert: this option provides a menu to add additional result-based objects (p. 1804) to the Solution.

• Solve

• Evaluate All Results (p. 1212)

• Stop Solution (p. 1373): available only for RSM solutions.

• Interrupt Solution (p. 1373): available only for RSM solutions.

• Clear Generated Data (p. 1199)

• Group All Similar Children (p. 100)

• Open Solver Files Directory (p. 910): available for Windows OS only.

• Worksheet: Result Summary (p. 1185): available following the completion of the solution process. This option
displays the results content in a tabular format.

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Adaptive Mesh Refine- Max Refinement Loops
ment (p. 1411)
Refinement Depth
Refinement Controls - Element Selection (p. 1412)
appears only for

Release 2020 R1 - © ANSYS, Inc.


1818
Solution

magnetostatic analyses Energy Based (p. 1412): appears if Element Selection is set to
if a Convergence object Manual.
is inserted under a
result. Error Based (p. 1412): appears if Element Selection is set to Manual.
Information Status

If your analysis system is using the Mechanical APDL Solver, the


following additional properties display:

MAPDL Elapsed Time


MAPDL Memory Used
MAPDL Result File Size
Post Processing Beam Section Results: This property enables you to select whether
or not beam strains and stresses are calculated given that your model
includes beam-based line bodies (p. 498). The default setting is No.

During a Topology Optimization Analysis (p. 352), the application


displays the following additional properties in the Post Processing
category:

Export Topology (STL file)


You can further analyze your optimized model, through continued
simulation or by performing a design validation by exporting your
results and making them available to a new downstream system.

The Export Topology (STL file) property enables you to


automatically export (p. 54) your results in Standard
Tessellation Language (STL) and in Part Manager Database
(PMDB) file format, archive the files in zip file format, and
then place the zipped file in the Solver Files Directory. This
option is set to Yes by default.

In order to make the optimized results available to a


downstream system, you need to create the new system on
the Workbench Project Schematic and link the Results cell
of your Topology Optimization analysis to the Geometry
cell of a new downstream system, either a Geometry
component system or the Geometry cell of another analysis
system. Refer to the Design Validation (p. 378) section for
additional details about this process.

Topology Result
When the Export Topology (STL file) property is set to Yes, the
Topology Result property also displays. The No setting removes
this property form the Details view. The Topology Result property
provides a drop-down of available Topology Density results. For
the Topology Optimization Environment, the Topology Result
property includes a default selection.

Definition Environment Selection List: This read-only property points to the


(Topology upstream analysis system (system cell ID) being used for the solution
Optimization only)

Release 2020 R1 - © ANSYS, Inc.


1819
Objects Reference

in your Topology Optimization analysis. You may use the options


available in the property to select a different upstream system.

Solution Combination
Manages solutions that are derived from the results of one or more environments. See Design Assess-
ment (p. 1491) for additional Solution Combination capabilities.

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: all stress and strain result objects (p. 1229), Directional
Deformation (p. 1226), Total Deformation (p. 1226), Contact Tool (p. 1268) (only for
Frictional Stress, Penetration, Pressure, and Sliding Distance), Fatigue
Tool (p. 1337), Stress Tool (p. 1254), Comment (p. 1654), Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Model (p. 1767) object:

• Choose Solution Combination on Model context toolbar (p. 78).

• Click right mouse button on Model (p. 1767) object or in the Geometry window>
Insert> Solution Combination.

Additional Related Information:

• Solution Combinations (p. 1370)

• Underdefined Solution Combinations (Troubleshooting) (p. 1869)

The Evaluate All Results (p. 1212) right mouse button context menu option is available for this object.

Solution Information
Allows tracking, monitoring, or diagnosing of problems that arise during a nonlinear solution.

Also allows viewing certain finite element aspects of the engineering model.

Tree Dependencies:

• Valid Parent Tree Object: Connections (p. 1663), Solution (p. 1817)

• Valid Child Tree Objects: Comment (p. 1654), Image (p. 1706), Result Track-
er (p. 1802) (available only when Solution (p. 1817) is the parent)

Insertion Options:

• Automatically inserted under a Solution (p. 1817) object of a new environment


or of an environment included in a database from a previous release.

• Click right mouse button on Connections (p. 1663) object or in the Geometry
window> Insert> Solution Information.

Release 2020 R1 - © ANSYS, Inc.


1820
Spot Weld

Additional Related Information:

• Solution Information (p. 1395)

The option Evaluate All Contact Trackers is available on the right mouse button context menu for
this object.

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Solution In- Solution Output: not applicable to Connections object.
forma-
tion (p. 1395) Newton-Raphson Residuals: applicable only to Structural environments.

Identify Element Violations: applicable only to nonlinear Structural environments.

Update Interval: appears for synchronous (p. 1376) solutions only.

Display Points: not applicable to Connections object.

Display Filter During Solve: appears for Explicit Dynamics systems only.
FE Connection Activate Visibility
Visibil-
ity (p. 1401) Display

Draw Connections Attached To

Line Color

Color: appears if Line Color is set to Manual.

Visible on Results

Line Thickness

Display Type

Spot Weld
Defines conditions for individual contact and target pairs for a spot weld (p. 828), which is used to connect
individual surface body parts to form a surface body model assembly, just as a Contact Region (p. 1669)
object is used to form a solid model assembly. Several Spot Weld objects can appear as child objects
under a Connection Group (p. 1664) object. The Connection Group object name automatically changes
to Contacts.

Release 2020 R1 - © ANSYS, Inc.


1821
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Connections (p. 1663)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting Connec-
tions (p. 1663) object:

• Inserted automatically if spot welds are defined


in the CAD model and you choose Create
Automatic Connections by right-clicking the
Connections (or Contacts) object.

• Click Spot Weld button on Connections context


toolbar (p. 80).

• Click right mouse button on Connections (p. 1663)


(or Connection Group) object or in the Geometry
window > Insert> Spot Weld.

Additional Related Information:

• Spot Welds (p. 828)

• Connections Context Toolbar (p. 80)

The following right mouse button context menu options are available for this object.

• Enable/Disable Transparency (p. 725)

• Hide All Other Bodies (p. 726)

• Flip Contact/Target (p. 727)

• Merge Selected Contact Regions (p. 728) - appears if contact regions share the same geometry type.

• Save Contact Region Settings (p. 728)

• Load Contact Region Settings (p. 728)

• Reset to Default (p. 729)

• Rename Based on Definition (p. 726)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope (p. 681) Scoping Method (p. 698)
Contact (p. 698)

Release 2020 R1 - © ANSYS, Inc.


1822
Spring

Target (p. 699)


Contact Bodies (p. 699)
Target Bodies (p. 699)
Defini- Scope Mode (p. 703)
tion (p. 681) Suppressed (p. 706)

Spring
An elastic element that regains its undeformed shape after a compression or extension load is removed.

Tree Dependencies:

• Valid Parent Tree Object: Connections (p. 1663)

• Valid Child Tree Objects: Commands (p. 1652), Comment (p. 1654), Figure (p. 1697),
Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Connections (p. 1663) object:

• Click Body-Ground> Spring or Body-Body> Spring, as applicable on Connec-


tions context toolbar (p. 80).

• Click right mouse button on Connections (p. 1663) object or in the Geometry
window> Insert> Spring.

Additional Related Information:

• Connections Context Toolbar (p. 80)

• Springs (p. 818)

The following right mouse button context menu options are available for this object.

• Enable/Disable Transparency (p. 725) - similar behavior to feature in Contact Region.

• Rename Based on Definition (p. 726) - similar behavior to feature in Contact Region.

• Promote to Remote Point (p. 609) (Remote Attachment Only)

• Promote to Named Selection (p. 597)

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Graphics Prop- Visible
erties

Release 2020 R1 - © ANSYS, Inc.


1823
Objects Reference

Definition Material: This property enables you to select a material to define a constant
material-dependent damping ratio. The constant material-dependent damping
ratio is to be included in modal damping calculations for use in MSUP analyses.

Type (p. 818): read-only field that describes the spring - Longitudinal

Spring Behavior (p. 819): For Rigid Dynamics (p. 263) and Explicit Dynamics analyses,
the options include Both (default), Compression Only, and Tension Only. For all
other analysis types, Both is the only option and the field is read-only.

Longitudinal Stiffness (p. 818): entry field.

Longitudinal Damping (p. 818): entry field.

Preload (p. 818): options include None (default), Load, and Free Length.

Suppressed (p. 13)

Spring Length (p. 818): read-only indication.


Scope (p. 818) Scope: options include Body-Body or Body-Ground.
Refer- Scoping Method: Specify as Geometry Selection, Named Selection, or Remote
ence (p. 818) Point.

Applied By: displays for Body-Body scoping. Specify as Remote Attachment or


Direct Attachment. The default for this property can differ if you first select
geometry or a mesh node.

Based on the selection made for the Scoping Method property of this category,
the next property is:

• Scope: Appears if Scope (under Scope group) is set to Body-Body and Scoping
Method is set to Geometry Selection. Choose geometry entity then click Apply.

• Reference Component: Appears if Scope (under Scope group) is set to Body-


Body and Scoping Method is set to Named Selection.

• Remote Points: Appears if Scope (under Scope group) is set to Body-Body and
Scoping Method is set to Remote Point. This property provides a drop-down list
of available user-defined Remote Points. This property is not available when the
Applied By property is specified as Direct Attachment.

Body: This property appears if the Scope property (under Scope category) is set
to Body-Body. This property is a read-only indication of scoped geometry.

The following options appear if Scope (under Scope group) is set to Body-Ground
or if Scope is set to Body-Body and Applied By is specified as Remote Attach-
ment.

• Coordinate System

• Reference X Coordinate

• Reference Y Coordinate

Release 2020 R1 - © ANSYS, Inc.


1824
Spring

• Reference Z Coordinate

• Reference Location

• Behavior (p. 823)

• Material: This property is available when the Behavior property is set to Beam.
Select a material to define material properties for the beams used in the connection.
Density is excluded from the material definition.

• Radius: This property is available when the Behavior property is set to Beam.
Specify a radius to define the cross section dimension of the circular beam used
for the connection.

• Pinball Region (p. 715)

Mobile (p. 818) Scoping Method: specify as Geometry Selection, Named Selection, or Remote
Point.

Applied By: specify as Remote Attachment or Direct Attachment. The default


for this property can differ if you first select geometry or a mesh node.

Based on the selection made for the Scoping Method property of this category,
the next property is:

• Scope: appears if Scoping Method is set to Geometry Selection. Choose geometry


entity then click Apply.

• Mobile Component: appears if Scoping Method is set to Named Selection.

• Remote Points: appears if the Scoping Method is set to Remote Point. This property
provides a drop-down list of available user-defined Remote Points. This property is not
available when the Applied By property is specified as Direct Attachment.

Body: read-only indication of scoped geometry.

The following options appear if Scope (under Scope group) is set to Body-Ground
and Applied By is specified as Remote Attachment or if Scope is set to Body-
Body and Applied By is specified as Remote Attachment.

• Coordinate System

• Mobile X Coordinate

• Mobile Y Coordinate

• Mobile Z Coordinate

• Mobile Location

• Behavior (p. 823)

• Material: This property is available when the Behavior property is set to Beam.
Select a material to define material properties for the beams used in the connection.
Density is excluded from the material definition.

Release 2020 R1 - © ANSYS, Inc.


1825
Objects Reference

• Radius: This property is available when the Behavior property is set to Beam.
Specify a radius to define the cross section dimension of the circular beam used
for the connection.

• Pinball Region (p. 715)

Stress Tool (Group)


Provides stress safety tools (p. 1254) for analyzing simulation results.

Applies to the following objects: Safety Factor, Safety Margin, Stress Ratio, Stress Tool

Tree Dependencies:

• Valid Parent Tree Object:

– For Stress Tool: Solution (p. 1817) in a static structural or transient structural
analysis.

– For Safety Factor, Safety Margin, or Stress Ratio: Stress Tool

• Valid Child Tree Objects:

– For Stress Tool: Comment (p. 1654), Figure (p. 1697), Image (p. 1706), Safety
Factor, Safety Margin, Stress Ratio

– For Safety Factor, Safety Margin, or Stress Ratio: Alert (p. 1632), Com-
ment (p. 1654), Convergence (p. 1676), Figure (p. 1697), Image (p. 1706)

Insertion Options:

• For Stress Tool, use any of the following methods after highlighting Solu-
tion (p. 1817) object in a static structural or transient structural analysis:

– Choose Tools> Stress Tool on Solution context toolbar (p. 84).

– Click right mouse button on Solution (p. 1817) object or in the Geometry
window> Insert> Stress Tool> Max Equivalent Stress or Max Shear Stress
or Mohr-Coulomb Stress or Max Tensile Stress.

• For Safety Factor, Safety Margin, or Stress Ratio, use any of the following
methods after highlighting Stress Tool object:

– Choose Safety Factor, Safety Margin, or Stress Ratio on Stress Tool context
toolbar.

– Click right mouse button on Stress Tool object or in the Geometry window>
Insert> Stress Tool>Safety Factor, Safety Margin, or Stress Ratio.

Additional Related Information:

• Stress Tools (p. 1254)

• Maximum Equivalent Stress Safety Tool (p. 1255)

Release 2020 R1 - © ANSYS, Inc.


1826
Stress Tool (Group)

• Maximum Shear Stress Safety Tool (p. 1256)

• Mohr-Coulomb Stress Safety Tool (p. 1258)

• Maximum Tensile Stress Safety Tool (p. 1260)

The right mouse button context menu option Evaluate All Results (p. 1212) - is available for Safety
Factor, Safety Margin, Stress Ratio, and Stress Tool.

Object Properties
The Details view (p. 17) properties for this object include the following.

For Stress Tool:

Category Fields
Definition Theory (p. 1254)
Factor (p. 1256) - appears only if Theory is set to Max Shear Stress.
Stress Limit - appears only if Stress Limit Type is set to Custom Value.
Stress Limit Type - appears if Theory is set to any stress tool except Mohr-
Coulomb Stress.
Tensile Limit (p. 1258) - appears only if Theory is set to Mohr-Coulomb Stress
and Tensile Limit Type is set to Custom Value.
Compressive Limit (p. 1258) - appears only if Theory is set to Mohr-Coulomb
Stress and Compressive Limit Type is set to Custom Value.
Tensile Limit Type (p. 1258) - appears only if Theory is set to Mohr-Coulomb
Stress.
Compressive Limit Type (p. 1258) - appears only if Theory is set to Mohr-Cou-
lomb Stress.

For Safety Factor, Safety Margin, or Stress Ratio:

Category Fields
Scope Scoping Method
Geometry - Use selection filters (p. 126) to pick geometry (p. 125), click in the
Geometry field, then click Apply.
Definition Type – Read-only display of specific stress tool object name.
By
Display Time
Calculate Time History
Use Average
Identifier
Results - Minimum
Read-only Maximum - appears only for Stress Ratio.
display of the Minimum Occurs On
following Maximum Occurs On - appears only for Stress Ratio.
values:
Information - Time
Read-only Load Step
display of the Substep

Release 2020 R1 - © ANSYS, Inc.


1827
Objects Reference

following Iteration Number


values:

Surface
Represents a section plane to which you can scope results.

Tree Dependencies:

• Valid Parent Tree Object: Construction Geometry (p. 1667)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706).

Insertion Options: Use any of the following methods after selecting


Construction Geometry object:

• Click Surface button on Construction Geometry context toolbar.

• Click right mouse button on Construction Geometry (p. 1663) object or in the
Geometry window> Insert> Surface.

Additional Related Information:

• Specifying a Surface (p. 666)

• Specifying Construction Geometry (p. 661)

• Construction Geometry Object Reference (p. 1667)

• Path Object Reference (p. 1783)

• Solid Object Reference (p. 1816)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Defini- Coordinate System
tion (p. 666) Suppressed

Surface Coating
This feature enables you to apply a surface coating (shell layer) of a specified material and thickness
over one or more faces of your model. This feature is beneficial when you want to include the ability
to accurately evaluate surface stresses or to overlay your structure with thin parts, such as modelling
Thermal Barrier Coatings or sheet metal over support structures. To accurately model this type of ap-
plication, Mechanical enables you to specify the thickness, stiffness behavior, coordinate system, and
material.

Release 2020 R1 - © ANSYS, Inc.


1828
Surface Coating

Tree Dependencies:

• Valid Parent Tree Object: Geometry (p. 1701)

• Valid Child Tree Objects: Comment (p. 1654),


Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the


following methods after highlighting the
Geometry (p. 1701) object or the
Body (p. 1644) object:

• Click Surface Coating button on Geo-


metry context toolbar (p. 81).

• Right-click on the Geometry (p. 1701)


object or in the Geometry window and
select Insert > Surface Coating.

• Select the desired face geometry from


the parts available beneath the geometry
object, right-click, and select Insert >
Surface Coating. This option
automatically specifies the geometry.

Additional Related Information:

• Applying a Surface Coating (p. 507)

• Scoping Results to Surface Coating (p. 1223)

The following right mouse button context menu options are available for this object.

• Insert>Element Orientation (p. 1687)

• Insert>Point Mass (p. 505)

• Insert>Distributed Mass (p. 1684)

• Insert>Surface Coating (p. 507)

• Insert>Thickness (p. 1834) (available based on analysis specifications)

• Insert>Layered Section (p. 1745) (available based on analysis specifications)

• Suppress/Unsuppress

• Duplicate

• Copy

• Cut

• Delete

Release 2020 R1 - © ANSYS, Inc.


1829
Objects Reference

• Rename

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Properties/Options
Scope Scoping Method: Specify this property as either Geometry Selection or Named
Selection.

Geometry: This property is visible when the Scoping Method is set to Geometry
Selection. Use the Face selection filters to pick your geometry, click in the Geo-
metry field, then click Apply.

Named Selection: Visible when the Scoping Method is set to Named Selection.
This field provides a drop-down list of available face-based (only) user–defined
Named Selections.
Definition Thickness: Define the thickness of the Surface Coating. This property can be
designated as a parameter (p. 26).

Stiffness Behavior: The options for this property include the following.

• Stress Evaluation Only (default): Use this option to evaluate stresses and strains
on the exterior surface(s). Elements do not provide any stiffness contribution to
the model.

• Membrane Only: Elements have membrane stiffness only.

• Membrane/Bending: Elements have membrane and bending stiffness.

Suppressed

Coordinate System
Material Assignment: Using the fly-out menu of this property you can select an existing
material, create a new material definition, or import a new material. Creating and/or
importing materials automatically open the Engineering Data Workspace [Please
verify that EDA link is to appropriate section] enabling you to make your material
selections/specifications. Once you have completed either of these operations, you
must refresh the Model cell in the Project Schematic to bring new data into the
Mechanical application.

Symmetry
Represents all definitions of symmetry or periodic/cyclic planes within a model. Each symmetry definition
is represented in a Symmetry Region (p. 1831) object, each periodic definition is represented in a Peri-
odic Region (p. 1784) object, and each cyclic definition is represented in a Cyclic Region (p. 1784) object.

Release 2020 R1 - © ANSYS, Inc.


1830
Symmetry Region

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697),
Image (p. 1706), Periodic/Cyclic Region (p. 1784), Symmetry
Region (p. 1831)

Insertion Options:

• Automatically inserted in the tree if model includes


symmetry planes defined in DesignModeler (using the
Symmetry or Enclosure feature).

• For manual insertion, use any of the following methods


after highlighting Model (p. 1767) object:

– Choose Symmetry on Model context toolbar (p. 78).

– Click right mouse button on Model (p. 1767) object or in


the Geometry window> Insert> Symmetry.

Note

Only one Symmetry object is valid per


Model (p. 1767).

Additional Related Information:

• Symmetry

• Symmetry Context Toolbar (p. 80)

Symmetry Region
Defines an individual plane for symmetry or anti-symmetry conditions (including linear periodic sym-
metry). The collection of all Symmetry Region objects exists under one Symmetry (p. 1830) object.

Tree Dependencies:

• Valid Parent Tree Object: Symmetry (p. 1830)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options:

• Automatically inserted in the tree if model includes symmetry planes defined in


DesignModeler (using the Symmetry or Enclosure feature).

• For manual insertion, use any of the following methods after highlighting Sym-
metry (p. 1830) object:

Release 2020 R1 - © ANSYS, Inc.


1831
Objects Reference

– Choose Symmetry Region (or Linear Periodic) on Symmetry context


toolbar (p. 80).

– Click right mouse button on Symmetry (p. 1830) object, on an existing Symmetry
Region, Periodic Region, or Cyclic Region object, or in the Geometry window
Insert>Symmetry Region (or Linear Periodic).

• Linear Periodic: The Symmetry context toolbar (p. 80) (as well as the context
menus) contains a Linear Periodic option. When selected, a Symmetry object is
placed in the tree with the Type property automatically set to Linear Periodic.

Additional Related Information:

• Symmetry

• Symmetry Region (p. 622)

• Symmetry in the Mechanical Application (p. 649)

• Symmetry Context Toolbar (p. 80)

The following right mouse button context menu options are available for this object.

• Insert>Symmetry Region

• Insert>Linear Periodic

• Insert>Cyclic Region

• Group (p. 100)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping Method
Geometry - appears if Scoping Method is set to Geometry Selection.
Named Selection - appears if Scoping Method is set to Named Selection.
Definition Scope Mode
Type
Coordinate System
Symmetry Normal
Periodic Direction
Linear Shift
Suppress (p. 13)

Thermal Point Mass


Represents heat from surrounding objects.

Release 2020 R1 - © ANSYS, Inc.


1832
Thermal Point Mass

Tree Dependencies:

• Valid Parent Tree Object: Geometry (p. 1701)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Geometry (p. 1701) object or Body (p. 1644) object:

• Click Thermal Point Mass button on Geometry context toolbar (p. 81).

• Click right mouse button on Geometry (p. 1701) object, Body object, or in the
Geometry window> Insert> Thermal Point Mass.

Additional Related Information:

• Thermal Point Mass (p. 509)

• Coordinate Systems (p. 671)

• Geometry Context Toolbar (p. 81)

The following right mouse button context menu options are available for this object.

• Promote Remote Point (p. 609) (Remote Attachment Only)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping method - Specify as Geometry Selection (default) or
Named Selection or Remote Point (only available when a
user-defined Remote Point exists in the tree).
Geometry - Visible when the Scoping Method is set to Geo-
metry Selection. Displays the type of geometry (face, edge,
vertex) and the number of geometric entities (for example: 1
Face, 2 Edges) to which the boundary has been applied using
the selection tools. Use selection filters to pick geometry, click
in the Geometry field, then click Apply. The Remote Attachment
option is the required Applied By property (see below) setting
if the geometry scoping is to a single face or multiple faces, a
single edge or multiple edges, or multiple vertices.
Named Selection - Visible when the Scoping Method is set to
Named Selection. This field provides a drop-down list of available
user–defined Named Selections.
Remote Points - Visible when the Scoping Method is set to
Remote Point. This field provides a drop-down list of available
user–defined Remote Point.
Applied By - Specify as Remote Attachment (default) or Direct
Attachment.
Coordinate System - this property is available when the Applied
By property is set to Remote Attachment. Allows you to assign

Release 2020 R1 - © ANSYS, Inc.


1833
Objects Reference

the Thermal Point Mass to a local coordinate system if previously


defined using one or more Coordinate System objects. The
Thermal Point Mass is automatically rotated into the selected
coordinate system if that coordinate system differs from the
global coordinate system.

The individual coordinate properties, X/Y/Z, are available when the


Applied By property is set to Remote Attachment. Define coordinate
origins directly. These properties can be designated as a
parameter (p. 26).

• X Coordinate

• Y Coordinate

• Z Coordinate

Location - this property is available when the Applied By


property is set to Remote Attachment. Allows you to change
the location of the load. Once relocated, click in the Location
field and then click Apply.
Definition Thermal Capacitance - Can be designated as a
parameter (p. 26). (p. 509)
Suppressed (p. 13)
Behavior (p. 509)
Pinball Region (p. 715)

Thickness
Allows you to define variable thickness properties on selected faces of surface bodies.

Tree Dependencies:

• Valid Parent Tree Object: Geometry (p. 1701)

• Valid Child Tree Objects: Comment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following methods after highlighting


Geometry (p. 1701) object or Body (p. 1644) object:

• Click Thickness button on Geometry context toolbar (p. 81).

• Click right mouse button on Geometry (p. 1701) object, Body object, or in the
Geometry window> Insert> Thickness.

Additional Related Information:

• Specifying Surface Body Thickness (p. 491)

• Geometry Context Toolbar (p. 81)

The following right mouse button context menu options are available for this object.

Release 2020 R1 - © ANSYS, Inc.


1834
Topology Result Plot Trackers

• Search Faces with Multiple Thicknesses (p. 497)

• Promote Remote Point (p. 609)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Scope Scoping Method

Geometry– appears if Scoping Method is set to Geometry Selection.


In this case, use selection filters (p. 126) to pick geometry (p. 125), click
in the Geometry field, then click Apply.

Named Selection – appears if Scoping Method is set to Named


Selection.
Definition Scope Mode- read-only indication of Manual or Automatic.
Suppressed (p. 13)
Thickness (p. 491)
Offset Type (p. 489)
Tabular Data - appears Independent Variable (p. 491)
if Thickness is set to Coordinate System (p. 491)
Tabular Data.
Function - appears if Unit System - read only indication of the active unit system.
Thickness is set to a Angular Measure - read only indication of the angular measure
function. used to evaluate trigonometric functions.
Graph Controls - Number of Segments (p. 491)
appears if Thickness is Range Minimum (p. 491)
set to a function. Range Maximum (p. 491)

Note

The above description applies to a Thickness object that you manually insert into the tree.
When you include thickness associated with a surface body that you import from Design-
Modeler, an automatically generated Thickness object is added as a child object beneath
the associated Surface Body object. Read only object properties in the Scope and Definition
categories are available for these automatically generated Thickness objects. Additionally,
the right-click context menu item Make Thickness Manual (p. 489) is available for the auto-
matically generated version of the object.

Topology Result Plot Trackers


The tracker feature of the Topology Optimization analysis (p. 352), displays the iteration-based progressive
results in the Geometry window during the solution process. By default, the Topology Density Tracker
object is inserted as a child object of the Solution Information object. It displays node-based result
data. In addition, you can choose to insert the Topology Elemental Density Tracker object in order
to display element-based result data.

Release 2020 R1 - © ANSYS, Inc.


1835
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Solution Informa-


tion (p. 1820)

• Valid Child Tree Objects: This object currently


does not support any child objects.

Insertion Options: Use any of the following


methods after highlighting Solution Informa-
tion (p. 1820) object:

• Select Result Plot Tracker>Topology Density on


Solution Information context toolbar (p. 84).

• Right-click on the Solution Information (p. 1820)


object or within the Geometry window and select
Insert>Topology Density Tracker.

Note

You cannot add a plot tracker to an


analysis in the solved state. You
must first clear the solution to make
the addition.

Additional Related Information:

• Topology Optimization Analysis (p. 352) (see Result


Display Feature)

• Topology Density (p. 371)

• Solution Context Toolbar (p. 84)

The following right mouse button context menu options are available for this object.

• Export (p. 1407): Available once solution is obtained.

• Rename Based on Definition (p. 1366)

• Suppressed/Unsuppressed

Object Properties
The Details view (p. 17) for this object includes the following properties.

Category Properties/Descriptions
Scope Scoping Method. The options for this property include:

• Optimization Region (default): This option indicates that the design


region is applied to the select Optimization Region. When you

Release 2020 R1 - © ANSYS, Inc.


1836
Topology Result Plot Trackers

specify Optimization Region for the Scoping Method, the Optim-


ization Region property displays and is automatically populated.

• Geometry Selection: This option indicates that the design region


is applied to a geometry or geometries, which are chosen using the
graphical selection tools. When you specify Geometry Selection
for the Scoping Method, the Geometry property displays.

In this case, use selection filters on the Graphics


Toolbar (p. 70) to pick your geometric entities (body and
element selection only), and then click Apply. Once complete,
the property displays the type of geometry (Body, etc.) and
the number of selected geometric entities (for example: 1
Body).

• Named Selection: This option indicates that the design region is


applied to a Named Selection. When you specify Named Selection
for the Scoping Method, the Named Selection property displays.
This property provides a drop-down list of available user-defined
Named Selections (only body-based and element-based Named
Selections are supported).

Definition Type (p. 1405): Read-only indication of plot tracker result type.

Iteration: Indicates iteration number for the selected result.

Retained Threshold: This property is controlled by a slider option


that represents the range from minimum to maximum for the result.
The default value is 0.5. The supported range is 0.01 to 0.99 (greater
than zero and less than 1).

Once you evaluate results, you can use the slider to view the
optimized topology in the graphics view. When you release the slider,
press the Enter key to apply the entry. The application computes
and displays the values for the Original Volume, Final Volume, Percent
Volume of Original, Original Mass, Final Mass, and Percent Mass of
Original.

Suppressed: Include (Yes) or exclude the (default, No) the result.


Results Minimum: Read-only indication of the minimum value for the tracker.

Maximum: Read-only indication of the maximum value for the


tracker.
Visibility Show Optimized Region. This property is used for graphical view
changes only. The options for this property include:

• All Regions: This option displays all of the regions selected by the
Scoping Method. Three color bands are shown: Remove (Red),
Marginal (Yellow), and Keep (Gray). Remove indicates a Retained
Threshold value of 0 to 0.4, Marginal indicates a value of 0.4 to 0.6,
and Keep indicates a value greater than 0.6.

Release 2020 R1 - © ANSYS, Inc.


1837
Objects Reference

• Retained Region (default): When Retained Region is selected, then


the Retained Threshold value is used from the details view to show
the region which needs to be kept.

• Removed Region: This option displays what will be removed.

Information Iteration Number: Read-only field that displays the converged


iteration step number.

Validation
The Validation object enables you to evaluate the quality of mapping across source and target meshes.
It provides quantitative measures that help in identifying regions on the target where the mapping
failed to provide an accurate estimate of the source data. You can add validation objects under the
Imported Load (p. 1725), Imported Thickness (p. 1732), or Imported Trace (p. 1737) objects.

Applies to: Validation objects.

Tree Dependencies:

• Valid Parent Tree Objects: Imported


Load (p. 1725), Imported Thickness (p. 1732), or Im-
ported Trace (p. 1737) objects.

• Valid Child Tree Objects: Comment, Figure,


Image

Insertion Options: Use any of the following


methods after highlighting the Imported
Load (p. 1725), Imported Thickness (p. 1732), or
Imported Trace (p. 1737) objects:

• Select Validation in the Environment/Geometry


Context Toolbar

• Click the right-mouse button on the object you


highlighted and select Insert > Validation from
the context menu.

Additional Related Information:

• Imported Load (p. 1725)

• Imported Thickness (p. 1732)

• Mapping Validation in the ANSYS Mechanical User's


Guide

Right-mouse Options:

• Analyze: Invokes calculation of Validation object. See Mapping Validation in the ANSYS Mechanical User's
Guide.

Release 2020 R1 - © ANSYS, Inc.


1838
Validation

• Export: Exports the data to a text file in tabbed delimited format. See Exporting Data in the ANSYS
Mechanical User's Guide.

Object Properties
The Details view properties for this object include the following.

Category Fields
Definition File Identifier*: specify the file identifier(s) from parent object.

Layer (Imported Trace (p. 1737) only): specify the layer from the PCB layout.

Row: the row of the parent worksheet.

Data: the data type for the imported load.

Component: the vector component (X, Y, Z).

Complex Component: the real/imaginary component for complex loads.

Shell Face: specify the top/bottom for loads applied to shells.

Note

* This property is only available when data is imported through


the External Data system.

Settings Type: specify Reverse Validation, Distance Based Average Comparison,


Source Value, or Undefined Points.

Note

Not all options are available when validating Imported


Trace.

Number of Points: available when Distance Based Average Comparison


is selected. Specifies how many points to use in the distance based
average mapping calculations.

Output Type: specify either Relative Difference or Absolute Difference.


(This is not displayed for the Source Value or Undefined Points types.)
Graphics Controls Display: specify either Scaled Spheres, Colored Spheres, Colored Points,
Contours, or Isolines (Isolines are only available for Source Value Output
Type when element mesh data is provided)

Line Thickness: available when Display is set to Isolines. Control the


thickness of the isolines by selecting Single, Double, or Triple.

Scale: specify scale multiplier for increasing and decreasing sphere sizes.
Not displayed for Colored Points.

Release 2020 R1 - © ANSYS, Inc.


1839
Objects Reference

Category Fields
Display Minimum: appears if object state is solved. Graphics display will
use this value to show only items above this threshold. Must be greater
than the Minimum and less than the Maximum property. (This is not
displayed for the Undefined Points type.)

Display Maximum: appears if object state is solved. Graphics display will


use this value to only show items below this threshold. Must be greater
than Minimum and less than Maximum property. (This is not displayed
for the Undefined Points type.)

Display In Parent: graphics items can be overlaid on parent objects when


this item is set to On.

Legend Divisions: control how many contour colors to use in displaying


graphics data. (This is not displayed for the Undefined Points type.)
Statistics Minimum: read-only minimum value for entire mapped points. (This is
not displayed for the Undefined Points type.)

Maximum: read-only maximum value for entire mapped points. (This is


not displayed for the Undefined Points type.)

Number Of Items: read-only number of currently displayed items

Velocity
Applies velocity as an initial condition for use in a transient structural analysis (p. 384) or an Explicit Dy-
namics analysis.

Tree Dependencies:

• Valid Parent Tree Object: Initial Condi-


tions (p. 1740)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting Initial Condi-
tions (p. 1740) object:

• Click Velocity button on Initial Conditions con-


text toolbar.

• Click right mouse button on Initial Condi-


tions (p. 1740) object or in the Geometry window
> Insert> Velocity.

Additional Related Information:

• Define Initial Conditions (p. 186)

• Transient Structural Analysis (p. 384)

Release 2020 R1 - © ANSYS, Inc.


1840
Virtual Body

• Explicit Dynamics Analysis

Object Properties
The Details view properties for this object include the following.

Category Fields
Scope Scoping Method

Geometry – appears if Scoping Method is set to Geometry Selection. In this case, use
selection filters (p. 126) to pick geometry (p. 125), click the Geometry field, then click Apply.

Named Selection – appears if Scoping Method is set to Named Selection.


Definition Input Type - choose Angular Velocity, Drop Height, or Velocity.

Define By

Total– magnitude; appears if Define By is set to Vector.

Direction (p. 149)- appears if Define By is set to Vector.

Coordinate System – available list; appears if Define By is set to Components.

X, Y, Z Component – values; appears if Define By is set to Components.

Virtual Body
Defines an individual virtual body. Virtual bodies are supported for assembly meshing only.

Note

Virtual Body and Fluid Surface objects are fluids concepts, and as such they are not sup-
ported by Mechanical solvers.

Release 2020 R1 - © ANSYS, Inc.


1841
Objects Reference

Tree Dependencies:

• Valid Parent Tree Object: Virtual Body Group (p. 1843)

• Valid Child Tree Objects: Fluid Surface (p. 1698), Com-


ment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options: Use either of the following


methods after highlighting the Geometry (p. 1701)
object:

• Click right mouse button on the Geometry (p. 1701)


object and select > Insert> Virtual Body.

• Choose Virtual Body on the Geometry context toolbar.

Additional Related Information:

• Assembly Meshing

• Defining Virtual Bodies

The following right mouse button context menu options are available.

• Insert> Condensed Part

• Insert>Virtual body

• Insert>Fluid Surface

• Hide/Show Body

• Hide/Show All Other Bodies

• Suppress/Unsuppress

• Suppress/Unsuppress All Other Bodies

• Update Selected Parts>Update: Use Geometry Parameter Values (p. 176)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Graphics Prop- Visible - Toggles visibility of the selected virtual body in the Geometry window.
erties
Definition Suppressed - Toggles suppression of the selected virtual body.
Used By Fluid Surface - Defines whether the virtual body is being used by a
set of fluid surfaces. If you change the setting from Yes to No, the Fluid Sur-
face (p. 1698) object will be hidden.
Material Point - Specifies the coordinate system to be used for the selected
virtual body. The default is Please Define. The Fluid Surface object and the

Release 2020 R1 - © ANSYS, Inc.


1842
Virtual Body Group

Virtual Body object will remain underdefined until a material point is specified.
You can select the default coordinate system or define a local coordinate system.
In either case, the setting will be retained, even if the Used By Fluid Surface
setting is changed later.
Material Fluid/Solid - Read-only and always set to Fluid for virtual bodies.
Statistics Nodes - Read-only indication of the number of nodes associated with the virtual
body when meshed.
Elements - Read-only indication of the number of elements associated with
the virtual body when meshed.
Mesh Metric - Read-only metric data associated with the virtual body when
meshed.

Virtual Body Group


Represents all definitions of virtual bodies within a model. Each definition is represented in a Virtual
Body (p. 1841) object. Virtual bodies are supported for assembly meshing only.

Note

Virtual Body and Fluid Surface objects are fluids concepts, and as such they are not sup-
ported by Mechanical solvers.

Tree Dependencies:

• Valid Parent Tree Object: Geometry (p. 1701)

• Valid Child Tree Objects: Virtual Body (p. 1841), Com-


ment (p. 1654), Figure (p. 1697), Image (p. 1706)

Insertion Options: When you insert the first Virtual


Body (p. 1841) object into the tree, the Virtual Body
Group object is inserted automatically.

Additional Related Information:

• Assembly Meshing

• Defining Virtual Bodies

The following right mouse button context menu options are available.

• Insert>Virtual body

• Hide/Show Body

• Hide/Show All Other Bodies

• Suppress/Unsuppress

• Suppress/Unsuppress All Other Bodies

Release 2020 R1 - © ANSYS, Inc.


1843
Objects Reference

• Update Selected Parts>Update: Use Geometry Parameter Values (p. 176)

Object Properties
The Details view (p. 17) properties for this object include the following.

Category Fields
Graphics Prop- Visible - Toggles visibility of the virtual body group in the Geometry window
erties
Definition Suppressed - Toggles suppression of the virtual body group object
Statistics Nodes - Read-only indication
Elements - Read-only indication
Mesh Metric - Read-only indication

Virtual Cell
Defines an individual face or edge group, defined manually or automatically. Virtual Cell objects do
not appear in the tree.

Creation Options:

• For automatic creation of virtual cell regions, a Virtual Cell object is created for each region that meets the
criterion specified in the Details view of the Virtual Topology (p. 1847) object.

• For manual creation of Virtual Cell objects, highlight the Virtual Topology (p. 1847) object, select one or
more faces or one or more edges in the Geometry window, and then do one of the following:

– Choose Merge Cells on the Virtual Topology context toolbar (p. 79).

– Click right mouse button on the Virtual Topology (p. 1847) object and select Insert> Virtual Cell from the
context menu.

– Click right mouse button in the Geometry window and select Insert> Virtual Cell from the context menu.

Additional Related Information:

• Virtual Topology Overview (p. 183)

• Virtual Topology Context Toolbar (p. 79)

• Meshing: Virtual Topology (in the Meshing help)

Object Properties
The properties for this object include the following. For related information, refer to Using the Virtual
Topology Properties Dialog to Edit Properties.

Category Fields
General Cell Class - Read-only indication of cell class for selected Virtual Cell object.
Geometry - Read-only indication of components that make up the Virtual Cell
object.

Release 2020 R1 - © ANSYS, Inc.


1844
Virtual Split Edge

Suppressed - Read-only indication of suppression status of selected Virtual


Cell object.
Project to Underlying Geometry - Defines whether the mesh should project
to the original underlying geometry (Yes) or faceted geometry (No).

Virtual Hard Vertex


Defines a virtual hard vertex, which allows you to define a hard point according to your cursor location
on a face, and then use that hard point in a split face operation. Virtual Hard Vertex objects do not
appear in the tree.

Creation Options: Highlight the Virtual Topology (p. 1847) object. Select the face to split in the Geometry
window. Position your cursor on the face where you want the hard point to be located, left-click, and
do one the following:

• Right-click in the Geometry window and select Insert> Virtual Hard Vertex at + from the context menu.

• Choose Hard Vertex at + on the Virtual Topology context toolbar. (p. 79)

Additional Related Information:

• Virtual Topology Overview (p. 183)

• Virtual Topology Context Toolbar (p. 79)

• Meshing: Virtual Topology (in the Meshing help)

Object Properties
The properties for this object include the following. For related information, refer to Using the Virtual
Topology Properties Dialog to Edit Properties.

Category Fields
General Geometry - Read-only indication showing that one vertex makes up the Virtual
Hard Vertex object.
Suppressed - Read-only indication of suppression status of selected Virtual
Hard Vertex object.
Virtual Hard Vertex Location - Read-only indication of the XYZ location of
the Virtual Hard Vertex object.

Virtual Split Edge


Defines a virtual split edge. Virtual Split Edge objects do not appear in the tree.

Creation Options: Highlight the Virtual Topology (p. 1847) object, select the edge to split in the Geometry
window, and then do the following:

• To define the split location according to your cursor location on the edge, right-click in the Geometry window
and select Insert> Virtual Split Edge at + from the context menu, or choose Split Edge at + on the Virtual
Topology context toolbar (p. 79).

• To define the split without specifying the location, right-click in the Geometry window and select Insert>
Virtual Split Edge from the context menu, or choose Split Edge on the Virtual Topology context tool-

Release 2020 R1 - © ANSYS, Inc.


1845
Objects Reference

bar (p. 79). By default the split ratio will be set to 0.5, but it can be changed later using the Virtual Topology
Properties dialog.

Additional Related Information:

• Virtual Topology Overview (p. 183)

• Virtual Topology Context Toolbar (p. 79)

• Meshing: Virtual Topology (in the Meshing help)

Object Properties
The properties for this object include the following. For related information, refer to Using the Virtual
Topology Properties Dialog to Edit Properties.

Category Fields
General Geometry - Read-only indication of components that make up the Virtual
Split Edge object.
Suppressed - Read-only indication of suppression status of selected Virtual
Split Edge object.
Split Ratio - Defines the location of the split for the selected Virtual Split Edge
object. Represented as a fraction of the total length of the edge. The default
is 0.5.

Virtual Split Face


Defines a virtual split face. Virtual Split Face objects do not appear in the tree.

Creation Options: Highlight the Virtual Topology (p. 1847) object, select two vertices on the face that
you want to split in the Geometry window, and then do one of the following:

• Choose Split Face at Vertices on the Virtual Topology context toolbar (p. 79).

• Click right mouse button on the Virtual Topology (p. 1847) object and select Insert> Virtual Split Face at
Vertices from the context menu.

• Click right mouse button in the Geometry window and select Insert> Virtual Split Face at Vertices from
the context menu.

Note

Virtual Hard Vertex (p. 1845) objects can be defined for use in split face operations.

Additional Related Information:

• Virtual Topology Overview (p. 183)

• Virtual Topology Context Toolbar (p. 79)

• Meshing: Virtual Topology (in the Meshing help)

Release 2020 R1 - © ANSYS, Inc.


1846
Virtual Topology

Object Properties
The properties for this object include the following. For related information, refer to Using the Virtual
Topology Properties Dialog to Edit Properties.

Category Fields
General Geometry - Read-only indication of components that make up the Virtual
Split Face object.
Suppressed - Read-only indication of suppression status of selected Virtual
Split Face object.
Vertices - Read-only indication showing that two vertices were selected.

Virtual Topology
Represents all definitions of face or edge groups, and all definitions of virtual split edges, virtual split
faces, and virtual hard vertices within a model. Each definition is represented in a Virtual Cell (p. 1844),
Virtual Split Edge (p. 1845), Virtual Split Face (p. 1846), or Virtual Hard Vertex (p. 1845) object, respectively.
Virtual Cell, Virtual Split Edge, Virtual Split Face, and Virtual Hard Vertex objects do not appear in
the tree.

Tree Dependencies:

• Valid Parent Tree Object: Model (p. 1767)

• Valid Child Tree Objects: Comment (p. 1654), Fig-


ure (p. 1697), Image (p. 1706)

Insertion Options: Use any of the following


methods after highlighting Model (p. 1767) object:

• Choose Virtual Topology on Model context


toolbar (p. 78).

• Click right mouse button on Model (p. 1767) object or


in the Geometry window> Insert> Virtual Topology.

Note

Only one Virtual Topology object is


valid per Model (p. 1767).

Additional Related Information:

• Virtual Topology Overview (p. 183)

• Virtual Topology Context Toolbar (p. 79)

• Meshing: Virtual Topology (in the Meshing help)

The following right mouse button context menu options are available for this object.

• Generate Virtual Cells

Release 2020 R1 - © ANSYS, Inc.


1847
Objects Reference

• Generate Virtual Cells on Selected Entities

Object Properties
The Details view (p. 17) properties for this object include the following.

The Lock position of dependent edge splits setting applies to virtual split edge behavior.

Category Fields
Definition Method
Behavior
Custom Gauss Curvature Angle
Feature Angle
Advanced Cus- Aspect Ratio
tom Contact Angle
Edge Angle
Shared Boundary Ratio
Advanced Generate on Update
Simplify Faces
Merge Face Edges
Lock position of dependent edge splits
Statistics Virtual Faces - Read-only indication
Virtual Edges - Read-only indication
Virtual Split Edges - Read-only indication
Virtual Split Faces - Read-only indication
Virtual Hard Vertices - Read-only indication
Total Virtual Entities - Read-only indication

Release 2020 R1 - © ANSYS, Inc.


1848
Mechanical: CAD System Information
For detailed CAD-related information specific to the ANSYS DesignModeler application and ANSYS
Workbench, see the CAD Integration section of the product help. When accessing the ANSYS Workbench
Help from the Help menu, click the Contents tab and open the CAD Integration folder in the hierarch-
ical tree.

The CAD Integration section includes topics about:

• Overview

• Geometry Interface Support for Linux and Windows

• Project Schematic Presence

• Mixed import Resolution

• CAD Configuration Manager

• Named Selection Manager

• Caveats and Known Issues

• Installation and Licensing

• File Format Support (with information specific to the Mechanical application)

ACIS
AutoCAD
BladeGen
CATIA
Creo Elements/Direct Modeling
Creo Parametric (formerly Pro/ENGINEER)
ANSYS DesignModeler
GAMBIT
IGES
Inventor
JT Open
Monte Carlo N-Particle
NX
Parasolid
Solid Edge
SolidWorks
SpaceClaim
STEP

• ANSYS Teamcenter Connection

• SpaceClaim Related to CAD Integration

Release 2020 R1 - © ANSYS, Inc.


1849
CAD System Information

• Frequently Asked Questions

• Troubleshooting

• Glossary

• Updates

Mechanical application topics:

General Information (p. 1850)

General Information
Body Filtering Property
There are four body filtering properties: Process Solid Bodies, Process Surface Bodies, Process Line
Bodies and Mixed Import Resolution. Their value is set in the Project Schematic and they determine
what bodies will get imported to the Mechanical application. The default setting is:

Yes for Solid and Surface Bodies,


No for Line Bodies and,
None for Mixed Import Resolution.

Material Properties
The CAD system interfaces will process only the isotropic material type.

Multiple Versions of CAD Systems


For most CAD systems, you cannot use geometry that was created in a newer version of the same CAD
system. For example, if you have both SolidWorks 2016 and SolidWorks 2015 installed, but only the
2015 version is registered, and you attempt to insert geometry created in SolidWorks 2016 from the
Project Schematic, the registered 2015 version will not recognize the geometry created in the 2016
version.

Release 2020 R1 - © ANSYS, Inc.


1850
Mechanical Troubleshooting
Problem Situations (p. 1851)
Recommendations (p. 1874)

General Product Limitations


This section describes limitations that can be present in the Mechanical application during certain
conditions.

• For results displayed in Tabular Data window, if 0 (zero) displays for both the Minimum and Maximum
values of a row, the result set may not contain result data. You can use the Retrieve This Result option (via
right-click on table row), to view result sets in order to determine if any data exists for the set. If no data is
available, the result contours in the Geometry window display as fully transparent.

• Color coding may change or disappear when displaying shared topologies using both the By Connec-
tion (p. 97) edge coloring and the Section Plane (p. 154) features. The By Connection feature displays
connectivity color coding, while the Section Plane feature is used to cut or slice the model to view its interior.

• When you are running Mechanical version 14.0 or any later version on a Linux system, you may experience
graphical distortions when animating results, rotating an animation of results, as well as zooming in and/or
out on your results.

• When running a Mechanical session on the Linux operating system, if you encounter a delay while meshing
or launching the Mechanical application or even a crash of the Workbench application, a potential solution
is to create a new session with the Hardware Acceleration option turned off (display the OpenGL tab and
deselect the Hardware Acceleration option).

• If you are resuming a project in Mechanical on the Linux platform, there is a restriction that the path to the
project, as well as the project name, include ASCII characters only, otherwise, the project will not open.

• When using Nice DCV to remotely connect to a Linux machine running Mechanical, you may encounter
display issues when using the Report, Print Preview, or Image to File features. To correct this issue, it is
necessary to turn off DCV in the Nice DCV control panel, close and reopen Mechanical, and then generate
the Report, Print Preview, or Image to File. Once complete, close the application, turn DCV back on, and
then reopen the application once again.

Problem Situations
This section describes how to deal with the following problems:
A Linearized Stress Result Cannot Be Solved.
A Load Transfer Error Has Occurred.
A Master Node is Missing from the Condensed Part
Although the Exported File Was Saved to Disk
Although the Solution Failed to Solve Completely at all Time Points.
An Error Occurred Inside the SOLVER Module: Invalid Material Properties
An Error Occurred While Solving Due To Insufficient Disk Space

Release 2020 R1 - © ANSYS, Inc.


1851
Troubleshooting

An Error Occurred While Starting the Solver Module


An Internal Solution Magnitude Limit Was Exceeded.
An Iterative Solver Was Used for this Analysis
At Least One Body Has Been Found to Have Only 1 Element
At Least One Spring Exists with Incorrectly Defined Nonlinear Stiffness
Animation Does not Export Correctly
Application Not Closing as Expected
Assemblies Missing Parts
Cannot Undo Node Move
CATIA V5 and IGES Surface Bodies
Constraint Equations Were Not Properly Matched
Element n Located in Body (and maybe other elements) Has Become Highly Distorted
Error Inertia tensor is too large
Equivalent Creep Strain Ratio has Exceeded the Specified Limit Value
Failed to Load Microsoft Office Application
Illogical Reaction Results
Large Deformation Effects are Active
MPC equations were not built for one or more contact regions or remote boundary conditions
One or More Contact Regions May Not Be In Initial Contact
One or more MPC contact regions or remote boundary conditions may have conflicts
One or More Parts May Be Underconstrained
One or More Remote Boundary Conditions is Scoped to a Large Number of Elements
Problems Unique to Background (Asynchronous) Solutions
Problems Using Solution
Remote Points with Overlapping Geometry Selections are not Recommended within a Condensed Part
Running Norton AntiVirusTM Causes the Mechanical Application to Crash
The Correctly Licensed Product Will Not Run
The Deformation is Large Compared to the Model Bounding Box
The Initial Time Increment May Be Too Large for This Problem
The Joint Probe cannot Evaluate Results
The License Manager Server Is Down
Linux Platform - Localized Operating System
The Low/High Boundaries of Cyclic Symmetry
The Remote Boundary Condition object is defined on the Cyclic Axis of Symmetry
The Solution Combination Folder
The Solver Engine was Unable to Converge
The Solver Has Found Conflicting DOF Constraints
Problem with RSM-Mechanical Connection
Unable to Find Requested Modes
You Must Specify Joint Conditions to all Three Rotational DOFs
Fracture Meshing Problems
Lustre Parallel File Systems on Linux

A Linearized Stress Result Cannot Be Solved.


... The path is not entirely contained within the finite element mesh.
To solve a Linearized Stress (p. 1238) result, a necessary condition is that the associated path be totally
contained within the model.

Release 2020 R1 - © ANSYS, Inc.


1852
Problem Situations

If the start/endpoints of the path are not within the model (likely to occur when the mesh is coarse
and when using the XYZ Coordinate toolbar button for picking), you can use the Snap to mesh
nodes (p. 661) feature to adjust the endpoints to be coincident with the nearest nodes in the mesh.

Occasionally however, other internal “knots” of the path are not inside the model due to a hole or
other missing material in the model. These situations can prevent the solving of a Linearized Stress
result and cause this error message to appear, even after using the Snap to mesh nodes feature.

To verify that a discontinuity is the cause of the error, apply a result other than a Linearized Stress result
to that path, and solve it. By doing so you will take advantage of the fact that other results do not require
that the full path be inside the model. The results are displayed and discontinuities are indicated by
any gaps or missing fields shown in the Graph and Tabular Data windows. The following example il-
lustrates a Total Deformation result where gaps in the Graph window and empty fields in the Tabular
Data window provide evidence of discontinuities.

A Load Transfer Error Has Occurred.


... A load could not be applied to small or defeatured entity. See the Troubleshooting
section of the Help System for more information.
At least one load is not able to be applied. This may be due to mesh-based defeaturing of the geometry.
You can modify the mesh defeaturing settings to restore the nodes and elements where the loads need
to be applied. Another possible reason could be that the Details View property Send to Solver was
incorrectly set to No for the node-based Named Selection used for some Direct FE boundary condition
scoping. Additionally, in a Thermal environment, the load applied to a whole body might lose its scope
if all pertinent faces have other surface loads applied. See the Resolving Thermal Boundary Condition
Conflicts (p. 1472) section of the Help for a description of precedence.

A Master Node is Missing from the Condensed Part


A master node is missing from the condensed part named...
This error indicates that a remote point on the interface of the condensed part cannot be found at the
location advertised in its definition. This typically occurs if the solver automatically suppresses one or

Release 2020 R1 - © ANSYS, Inc.


1853
Troubleshooting

more remote points whose geometry selections overlap during Condensed Part Generation. See the
Remote Points with Overlapping Geometry Selections are not Recommended within a Condensed Part
(p. 1865)Troubleshooting section.

Although the Exported File Was Saved to Disk


... the Microsoft Office application failed to load. See the Troubleshooting section for
details.
This message is displayed when you have chosen to export a file to Microsoft Excel, but the Microsoft
application is either not supported or not installed correctly. The Microsoft Excel file is still exported
and can be opened provided the application is resident. To prevent this error message from appearing
again, you can either install Microsoft Excel or set Automatically Open Excel to No in the Export (p. 110)
preferences, accessible from the Main Menu under Tools> Options.

Although the Solution Failed to Solve Completely at all Time Points.


... partial results at some points have been able to be solved. Refer to Troubleshooting
in the Help System for more details.
This message displays if for some reason (such as non convergence or the user choosing the Stop
button) the simulation does not run to completion, but the solution does produce at least some results
that can be post processed.

If such a condition occurs, any applicable results in the tree that you request will be calculated (provided
that they are defined at a Time/Frequency/Set/Mode that is less than or equal to the final Time/Fre-
quency/Set/Mode in the result file). These results will be assigned a green check state (up to date) but
the solution itself will still be in an obsolete state because it is not fully complete.

Note that there are exceptions to this scenario. If the result's specified Time/Frequency/Set/Mode
property is equal to the maximum time/frequency/set/mode in the result file, the application:

• Assigns the result with a red check state.

• Indicates the action as a user error. The state icon on all of the results will be red until the result with
the out-of-bounds time/frequency/set/mode is suppressed or corrected and the solution is recomputed.

Use the Evaluate Results right mouse button option on a Solution (p. 1817) object or a result object in
order to additionally postprocess the partial solution.

See Unconverged Results (p. 1212) for further details.

An Error Occurred Inside the SOLVER Module: Invalid Material Properties


... See the Troubleshooting section of the Help system for possible causes.
Check the following:

Material Definition
Check the Details view for each part to see that you selected the correct material for each part. Go to
Engineering Data to edit and check your material files and data and to verify the material definitions

Release 2020 R1 - © ANSYS, Inc.


1854
Problem Situations

(including numbers and units). Note that, depending on the type of result, you will have a minimum
of properties to be set.

Structural, Vibration, Harmonic, and Shape Results:


• Need to define the Modulus of Elasticity

• If you don't define the Poisson's Ratio it will default to 0.0. Also note that the Solver engine will not accept
values of Poisson's Ratio smaller than 0.1 or larger than 0.4 for Shape Results.

• For bodies whose Stiffness Behavior (p. 480) is set to Stiff Beam (p. 484), make sure that Isotropic Modulus of
Elasticity is defined. Note that other types of elasticity, such as orthotropic or hyperelasticity, are not allowed.

• For Vibration and Harmonic results, include the Mass Density of your material.

• For Thermal-stress results, you will need the Coefficient of Thermal expansion.

Thermal Results:
Thermal conductivity is required. Can be constant or temperature-dependent.

Specific Heat is required in a thermal transient analysis. Can be constant or temperature-dependent.

Check Thermal Data


For thermal analysis, go to the Engineering Data to edit and check thermal conductivity in the material
files and to check thermal convection in the convection files. Verify the 'smoothness' of the temperature-
dependent conductivity data and convection data. Non-smooth curves will lead to Solve failures.

Electromagnetic Materials - Minimum Requirements


For a Conductor scoped to a body, the associated material must have either Resistivity or Orthotropic
Resistivity specified in order for the simulation to continue on to a solve.

For all materials in an electromagnetic simulation, one of the following four conditions must be met.
These conditions are mutually exclusive of each other so only one condition can exist at a time for a
material.

• Linear “Soft” Magnetic Material properties specified: Either Relative Permeability or Linear Orthotropic
Permeability are set.

• Linear “Hard” Magnetic Material properties specified. Only Linear “Hard” Magnetic Material property
is set.

• Nonlinear “Soft” Magnetic Material properties specified: Either only BH Curve or BH Curve and Nonlinear
Orthotropic Permeability are set.

• Nonlinear “Hard” Magnetic Material properties specified: Only Demagnetization BH Curve is set.

An Error Occurred While Solving Due To Insufficient Disk Space


... See the Troubleshooting section of the Help system for more information.
Possible reasons that this message appears:

Release 2020 R1 - © ANSYS, Inc.


1855
Troubleshooting

• You may be running out of disk space during the Mechanical APDL solution due to the writing of large
solution files. Verify that there is sufficient free disk space on the drive where the solver directory exists.

• You do not have write permissions to the solution directory.

• Files from a previous Workbench or Mechanical APDL session already reside in the solution directory.

An Error Occurred While Starting the Solver Module


To get further information on what the issue may be, insert a Solution Information (p. 1820) object under
Solution (p. 1817) in the tree, and view the contents.

Possible reasons that the solver may fail are:

• Insufficient memory - You may not have enough virtual memory assigned to your system. To increase the
allocation of virtual memory (total paging file size), go to Settings> Control Panel> System (on your Windows
Start Menu). Click the Advanced tab and then click Performance Options. Increase the size of your virtual
memory.

• Insufficient disk space - You may not have enough disk space to support the increase in virtual memory and
the temporary files that are created in the analysis. Be sure you have enough disk space or move to an area
where you have enough.

• Corrupt product installation

• License request rejected

• The startup directory for cmd.exe has been overridden by the AUTORUN option and as a result causes the
solver to be unable to locate the solver input files.

Solving and UNC Paths


If a Workbench database resides on a UNC path (for example, \\pghxpuser\Shares) for which you have
write permissions, the ANSYS input file will be written successfully but will fail to start the solver execut-
able. To solve, map a drive to the location and then reopen the project. If you did not have write per-
missions, Workbench will instead write the ANSYS input file to your temp directory (%tmp%) and perform
a solution from that directory.

An Internal Solution Magnitude Limit Was Exceeded.


… Check your Environment for inappropriate load values or insufficient supports. See the
Troubleshooting section of the Help System for more information.

In most cases this message will occur if your model is improperly constrained or extremely large load
magnitudes are applied relative to the model size. First check that the applied boundary conditions are
correct. In some cases, loads that are self-equilibrating with no support may be desired. To help in these
cases, if this message occurs, consider adjusting the weak spring stiffness (p. 881) or turning on inertia
relief (p. 882).

Thermal Solutions
For Thermal Solutions, verify that your set up has at least one heat sink and one heat source as well as
closed contact regions.

Release 2020 R1 - © ANSYS, Inc.


1856
Problem Situations

An Iterative Solver Was Used for this Analysis


...However, a direct solver may enhance performance. Consider specifying the use of
a direct solver.
An iterative solver was used to obtain the solution; however, a large number of iterations were needed
in order to get a converged answer.

By default, the program will either choose a direct or iterative solver based on analysis type and geo-
metric properties. (In general, thin models perform better with a direct solver while bulky models perform
better with an iterative solver.) However, sometimes the iterative solver is chosen when the direct
solver would have performed better. In such cases, you may want to force the use of the direct solver.
You may specify the solver type in the Details view of the Analysis Settings folder.

At Least One Body Has Been Found to Have Only 1 Element


...in at least 2 directions along with reduced integration. This situation can lead to invalid results.
Consider changing to full integration element control or meshing with more elements. Refer to
Troubleshooting in the Help System for more details.

This scenario is based on the following conditions:

• Structural solid model.

• Brick meshes that have only one element in less than two directions.

• Reduced element integration (p. 484) is assigned. (This can happen by default if Element Control in the
Geometry object (p. 1701) is set to Program Controlled.)

If the above conditions are met, there is a strong likelihood that your analysis will excite hourglass
modes. In such cases solver pivot warnings will be reported and nonphysical deformations will result
(see examples below). If this occurs, first determine which bodies have one element through the thickness
(Right-click in Geometry window, choose Go To> Bodies With One Element Through the Thickness,
and observe selected body objects in the tree). The offending bodies can then be corrected by doing
one of the following:

• Modify the mesh to have more than 1 element in at least 2 directions. This will remove the hourglass modes
in most cases. In rare cases you may need to modify the mesh such that more than 1 element exists in all 3
directions.

• Use Full integration (p. 484) on the offending bodies.

• Consider using lower order elements.

Example of a "bad" mesh for reduced integration:

Release 2020 R1 - © ANSYS, Inc.


1857
Troubleshooting

Example of a "good" mesh for reduced integration:

At Least One Spring Exists with Incorrectly Defined Nonlinear Stiffness


The force-deflection curve is incorrectly defined using tabular input for nonlinear stiffness for one or
more spring objects existing in the model, see the details in COMBIN39 element description for more
information.

Note

Support Requirements

• Tabular Data requires at least two rows of data.

• The properties Longitudinal Damping and Preload are not applicable for Springs with nonlinear
stiffness.

Animation Does not Export Correctly


When exporting an AVI file, make sure that you keep the Workbench module window in front of other
windows until the exporting is complete. Opening other windows in front of the module window before
the exporting is complete may cause those windows to be included in the AVI file capture.

Release 2020 R1 - © ANSYS, Inc.


1858
Problem Situations

Application Not Closing as Expected


During shutdown, if Mechanical is responding slowly, that is, taking two or more minutes to close, you
may want to review your Filesystem Settings.

Assemblies Missing Parts


When reading assemblies from CATIA V5, all part files that are referenced by assemblies must be access-
ible in order for the importing to occur.

Cannot Undo Node Move


...The node is no longer at the location that it was moved to.

Or...

...The node no longer exists in the mesh.

Node movements listed in the Worksheet can become obsolete if you implement mesh changes such
as Mesh Numbering, Fracture, Mesh Connections, etc. Undo actions are not available once a node
movement has become obsolete.

To return to a base mesh, you need to remove your mesh changes in the reverse order of their imple-
mentation. If this is not possible, you may need to clean and re-mesh your model.

CATIA V5 and IGES Surface Bodies


CATIA V5 and IGES surface bodies consisting of closed faces are transferred as solid bodies.

Constraint Equations Were Not Properly Matched


... for all node pairs across the low and high sector boundaries in the cyclic symmetry.
See the Troubleshooting section of the Help System for more information
This message may occur if the solver does not succeed to reproduce the exact pairing of nodes between
the low and high sector. An approximate technique was used to group like nodes and distribute the
loads, but this can reduce solution accuracy.

Element n Located in Body (and maybe other elements) Has Become Highly
Distorted
The application detected an element distortion error because one or more elements failed to meet
certain solver criteria (p. 1399) during the solution process.

If the application detects more than one instance of the error during the solver's iterative process, then
a message for the last instance is reported. The application obtains errors from file.err in the solver
files directory.

Use the Identify Element Violations (p. 1399) property on the Solution Information object to generate
Named Selections for the offending element(s).

Release 2020 R1 - © ANSYS, Inc.


1859
Troubleshooting

Error Inertia tensor is too large


This message is shown by the LS-DYNA solver if your model includes rigid bodies with large dimensions,
for example a few meters in length. Such rigid geometries cause the inertia tensor limit of the solver
to be exceeded.

You can attempt to resolve this issue by running the double precision LS-DYNA solver, which has a much
larger inertia tensor limit. The double precision solver executable can be accessed with the -dp command
line option as follows LSDYNA120.exe -dp.

Equivalent Creep Strain Ratio has Exceeded the Specified Limit Value
... Since the time increment has reached the minimum value, the analysis is stopped.
The application detected one or more elements failed to meet certain solver criteria (p. 1399) because
the creep strain increment is too large.

If the application detects more than one instance of the error during the solver's iterative process, then
a message for the last instance is reported. The application obtains errors from file.err in the solver
files directory.

Use the Identify Element Violations (p. 1399) property on the Solution Information object to generate
Named Selections for the offending element(s).

Failed to Load Microsoft Office Application


... See the Troubleshooting section for details.
This message is displayed when you have chosen a feature that is dependent on a Microsoft Office
application, such as exporting a file to Microsoft Excel, and the related Microsoft Office application is
not installed correctly.

Illogical Reaction Results


Cause
Loads, supports, or contact items are applied to the same or shared topology.

Reason
It is unclear or ambiguous as to which reaction should be attributed to which support, load, or contact
item. Refer to this Note (p. 1296) for details.

Large Deformation Effects are Active


... Which may have invalidated some of your applied supports such as displacement,
cylindrical, frictionless, or compression only supports. Refer to Troubleshooting in the
Help System for more details.
In a large deformation analysis, the program updates the nodal coordinates as the solution progresses
towards the final configuration. As a result, supports that fix only some of the degrees of freedom of a
node but not all (for example fix only UX=0), may become invalid as the model's nodal coordinates and

Release 2020 R1 - © ANSYS, Inc.


1860
Problem Situations

thus nodal rotation angles are updated. The imposed DOF displacement directions do not change even
though rotation angles change. This may or may not be a desirable situation. A classic example is a
simple torsion of a rod. Initially the nodes at zero degrees have a circumferential direction of UY but
after a twist of 90 degrees, have a circumferential direction of UX.

The user is responsible for determining if any nodal rotation at the support is significant enough to
cause undesired results.

The following is a list of supports which only fix the movement of a node partially and thus are suscept-
ible to large deformation effects:

• Displacement (p. 1080)

• Cylindrical support (p. 1098)

• Frictionless (p. 1093)

In addition a Compression Only Support (p. 1095) may be susceptible to large deformation effects because
if large sliding occurs, the face can literally "slide off" the compression only support.

MPC equations were not built for one or more contact regions or remote
boundary conditions
... Due to potential conflicts with the cyclic symmetry constraints. This may reduce
solution accuracy. Refer to the Troubleshooting section.
Cyclic symmetry is enforced with the help of constraint equations between pairs of nodes on the low
and high sector boundaries respectively. When such nodes also participate in MPC contact, which requires
constraint equations of its own, conflicts may arise. Review results carefully, since the MPC contact will
be compromised at these locations.

One or More Contact Regions May Not Be In Initial Contact


… Check results carefully. Refer to Troubleshooting in the Help System for more details.
During the solution it was found that one or more of the contact pairs was not initially in contact. You
may check the solution output located in the Worksheet of a Solution Information object (p. 1395) to
determine exactly which contact pairs are initially open, and take the appropriate action.

• This message is expected if a contact pair is meant to be initially open and may become closed after the
load application.

• If initial contact was desired and the contact pair has a significant geometric gap, setting the Pinball Radi-
us (p. 715) manually to a sufficiently large value may be required.

• If symmetric contact is active, it is possible that one pair may be initially open and its symmetric pair be
initially in contact. Check the solution output to confirm this.

Release 2020 R1 - © ANSYS, Inc.


1861
Troubleshooting

One or more MPC contact regions or remote boundary conditions may have
conflicts
...With other applied boundary conditions or other contact or symmetry regions. This
may reduce solution accuracy. Tip: You can graphically display FE Connections from
the Solution Information Object. Refer to Troubleshooting in the Help System for more
details.
During solution it was found that one or more contact pairs using MPC (multi point constraint) contact
formulation (p. 706) overlaps with another contact region or boundary condition. The same is true for
remote boundary conditions (p. 1132) overlapping with another contact region or boundary condition.

Due to the fact that MPC formulation can cause over constraint if applied to the same nodes more than
once, the program may have not been able to completely bond the desired entities together. You may
check the solution output located in the Worksheet of a Solution Information object (p. 1395) to de-
termine which pairs and nodes are affected by this condition. Specifically this can happen when:

• A contact pair entity (either an edge or face) also has a Dirichlet (prescribed displacement/temperature)
boundary condition applied to it. In this case the MPC constraints will not be created at nodes that have
prescribed conditions thus possibly causing parts to lose contact. Sometimes this warning may be disregarded
in cases such as a large face with a fixed support at one edge and a contact pair on another. If it is determined
that overlap does indeed exist, consider relocating the applied support or using a formulation other than
MPC.

• Two MPC contact pairs share topology (such as a face or an edge). Again it is possible for one or both of
these pairs to lose contact. This message may especially occur when edge/face contact is automatically
generated by the program because often 2 complementary contact pairs (that is, edge part 1/face part 2
and edge part 2/face part 1) are created. Often in this case the message can be ignored after verifying result
correctness and if necessary, deleting/suppressing one of the inverse pairs. This condition may also occur
when 1 part (typically a surface body), is being contacted by 2 or more parts in the same spatial region. In
this case it is possible for one or more of the parts to lose contact. Consider reducing the Pinball Radi-
us (p. 715) to avoid overlap or changing one or more of the regions in question to use a contact formulation
other than MPC.

• When MPC contact is used to connect rigid bodies and joints, the overconstraint situation can sometimes
occur.

• When Remote Boundary conditions overlap the Low/High Regions of the Periodic/Cyclic symmetry regions,
you may experience an overconstraint situation. In a severe situation, the application may terminate.

One or More Parts May Be Underconstrained


...and experiencing rigid body motion.
This message may occur for one of several reasons: If the program detects that the model may be un-
derconstrained, weak springs will be added to the finite element model to help obtain a solution. In
addition, the program will automatically add weak springs if unstable contact (frictionless, no separation,
rough) or compression only supports are active in order to make the problem more numerically stable.
Since the weak springs have a low stiffness relative to the model stiffness, they will not have an effect
on a properly constrained model. If you are confident that weak springs are not needed for a solution
and the program adds them anyway, you may disable them by setting the Weak Springs option to
Off in the Details view (p. 17) of the Analysis Settings object.

Release 2020 R1 - © ANSYS, Inc.


1862
Problem Situations

One or More Remote Boundary Conditions is Scoped to a Large Number of


Elements
...which can adversely affect solver performance. Consider using the Pinball setting
to reduce the number of elements included in the solver.
Remote boundary conditions scoped to a large number of elements can cause the solver to consume
excessive amounts of memory. Point masses in an analysis where a mass matrix is required and analyses
that contain remote displacements are the most sensitive to this phenomenon. If this situation occurs,
consider modifying the Pinball setting to reduce the number of elements included in the solver. Forcing
the use of an iterative solver may help as well.

The reason for the excessive memory consumption is that the remote boundary conditions generate
internal constraint equations to distribute the remote mass, displacement, or loads from one node of
the model to all other selected nodes. As described in Chapter 15.14. Constraint Equations, in the
Mechanical APDL Theory Reference, constraint equations could change a sparse matrix (for example, a
stiffness matrix, mass matrix, or damping matrix) to a dense matrix. An increase in the number of con-
straint equations used increases the density of the final matrix, which in turn places a higher demand
for more memory (or longer CPU time) in the solution of a problem.

Normally, if the maximum number of remote nodes selected is about 3000, then the increased memory
usage or CPU time is not significant. Caution should be taken to not use too many remote nodes in
these applications. Other techniques are available to distribute loads or masses. For example, to distribute
a point mass to the entire model, you might consider specifying density directly instead of using the
point mass approach.

Problems Unique to Background (Asynchronous) Solutions


Consider the following hints when troubleshooting background (asynchronous) solution problems:

• For security reasons, RSM will not allow any job to be run by the "root" user on Linux, including primary and
alternate accounts.

• It may sometimes be necessary for you to enter the full path to the solver executable file in the Solve Process
Settings.

• It may sometimes be necessary for you to enter the full path to the Linux working directory in the Linux
Working Folder field of the Solve Process Settings.

• The LSF administrator should configure the Workbench job server to disallow multiple, simultaneous jobs.
Two solves running on the same server will interfere with each other, preventing successful completion of
each.

• To help in debugging solver startup problems on the remote machine, it is sometimes useful for you to use
the Solution Information object (p. 1395) under the Solution object in the tree. The Solution Information
object will show the contents of the solve.out file that the remote solver produced, if the application
was able to start.

• When using the Stop Solution option to stop a solve running on a Linux machine, it is possible that the
solver will continue to run on that machine even though the Mechanical application thinks it has stopped.
If this happens and you don't want the solve job to continue on the Linux machine it will be necessary for
you to kill the process manually. The ability to solve to two different Linux machines simultaneously is not
allowed.

Release 2020 R1 - © ANSYS, Inc.


1863
Troubleshooting

• The solve command may have failed to execute on the remote Linux server. Verify the command's spelling
and/or path. Solve commands are issued to the remote server using the rexec interface. Failures may occur
if the resulting path ($path) is insufficient. $path can be verified by issuing rexec on the command
prompt on the local machine. For example:

rexec machinename -l username echo $path > diagnosticsfile

(where "l" is the letter "el)"

The machinename and username match the entries in the Solve Process Settings, and diagnosticsfile
corresponds to the recipient on the local machine for the command output.

Note

After issuing rexec, if you receive the following message, rexec isn't enabled on the remote
Linux server. This feature must be enabled on the remote Linux server in order for the
solution to proceed.

> rexec:connect:Connection refused

rexec: can't establish connection

If the path to the solve command is unavailable on the remote server, it can be added to user or
system-wide files that initialize the startup shell (for example, .cshrc or /etc/csh.login on C-
shells). Consult the Linux server's rexec interface and appropriate shell manual pages for details.

• If you cannot make ASCII transfers to a Linux server, changes need to be made on the server. Background
solutions on a remote Linux server use file transfer protocol (ftp). Therefore, the system administrator must
install ftp and enable it. Ftp uses ASCII transfer mode to convert PC text to Linux text. If ASCII mode is disabled,
it is not obvious because error messages do not imply this. On some ftp servers (vsftpd, for example), by
default, the server will pretend to allow ASCII mode, but in fact, will ignore the request. You will need to
ensure that the ASCII upload and download options are enabled to have the server actually do ASCII mangling
on files when in ASCII mode. To enable these options, the system administrator should consult the operating
system documentation. The following vsftp.conf modification procedure is Linux platform specific and
is provided as an example only.

1. In /etc/vsftpd/vsftpd.conf, uncomment the following lines (that is, remove the # at the beginning
of these lines):

ascii_upload_enable=YES

ascii_download_enable=YES

2. Restart the server.

Problems Using Solution


If Solution fails to complete, try the following suggestions.

Verify the Environment


Verify that the loads and supports in the Environment meet the requirements for Stress, Thermal,
Thermal-Stress, Shape or Vibration.

Release 2020 R1 - © ANSYS, Inc.


1864
Problem Situations

You can verify the environment quickly by looking at the icons adjacent to each environment item in
the Tree Outline. A green check indicates that the requirements are met. A indicates that the re-
quirements were not met.

Check System Requirements


Verify that your system meets the minimum requirements at the time you start Solution. Disk space
and memory may fluctuate depending on how the system is used. See also General Solver Error.

For Thin-Walled or Finely Detailed Parts


If your parts contain features whose size or thickness is extremely small in comparison to the principal
dimensions of the assembly, try adjusting the variables used in modeling geometry.

• Set the variable DSMESH DEFEATUREPERCENT to 1e-5. To set variables, click Tools> Variable Manager.

• If that fails, change the setting to 1e-6.

Invalid or Poorly Defined Models


At the end of the Solution procedure, the region of a part that caused the problem is usually labeled.

If the geometry that is notated looks valid, but is small compared to the rest of the model, adjusting
the Sizing Control may correct the problem.

Remote Points with Overlapping Geometry Selections are not Recommended


within a Condensed Part
Remote points with overlapping geometry selections are not recommended within a
condensed part...
This warning indicates that two or more remote points on the interface of a condensed part have been
found to share a face, edge or vertex. These remote points may have been defined in the Tree View,
or may have been created internally by the use of a joint, spring or other remote conditions.

This situation may lead the solver to suppress one or more remote points from the interface during
Condensed Part generation, rendering them unavailable for the use pass.

To eliminate the overlap, it is recommended to edit the pinballs so they select disjoint portions of the
resulting numerical model. It may also be possible to edit the geometry to separate the modeling features
where they are applied.

Release 2020 R1 - © ANSYS, Inc.


1865
Troubleshooting

Running Norton AntiVirusTM Causes the Mechanical Application to Crash


If the Norton AntiVirusTM product is running and you choose Allow the entire script once to resolve
a script error, the Mechanical application crashes. Choose Authorize this script to allow the Mechanical
application to function normally.

The Correctly Licensed Product Will Not Run


If you have installed a license file for a valid Mechanical product, but the product continues to run in
read-only mode or, in the case of an upgrade to a higher product, continues to run the lower product,
make sure you have specified the correct product in the launcher.

This situation can occur if you install the Mechanical application before creating your license file. In this
case, the Mechanical application will run only in read-only mode. When you create your license file
later, you must choose a license under Mechanical APDL Product Launcher in the Start menu. Once
there, select the product that you have licensed to reset the default to the correct product. Otherwise,
the Mechanical application will continue to run in read-only mode.

This situation can also occur if you upgrade your license to a higher Mechanical product. Again, you
must choose a license under Mechanical APDL Product Launcher in the Start menu. Then reset to
the appropriate product. Otherwise, the Mechanical application will continue to run as the lower, pre-
viously-licensed product.

The Deformation is Large Compared to the Model Bounding Box


... Verify boundary conditions or consider turning large deflection on.
This message will be displayed any time the software detects nodal deformations exceeding 10% of
the model diagonal. Exceeding 10% of this length suggests model mechanics that depart from linearity
in response to the applied boundary conditions. Load magnitudes, surface body thicknesses, and contact
options (p. 681), if applicable, should be verified. If these are intended, a nonlinear analysis is advised.
To request a nonlinear analysis, set Large Deflection to On in the Details view of the Analysis Settings
folder.

The Initial Time Increment May Be Too Large for This Problem
... Check results carefully. Refer to Troubleshooting in the Help System for more details.
This message will appear if the program determines that the initial time increment used in the thermal
transient analysis may be too large based on the "Fourier modulus" (Fo). This dimensionless quantity
can be used as a guideline to define a conservative time step based on thermal material properties and
element sizes. It is defined as:

Fo = k (Δt) / ρ c (lengthe2)

where:

lengthe = Average element length


Δt = Time step
k = Thermal Conductivity
c = Specific Heat
ρ = Density

Release 2020 R1 - © ANSYS, Inc.


1866
Problem Situations

Specifically this warning will be issued if the program finds that the Fourier modulus is greater than
100, that is, Fo > 100. Stated in terms of the initial time step (ITS), this warning appears when the ITS
is 100 times greater than the time step suggested by the Fourier modulus in the form expressed below:

Δt = lengthe2 / (k / (c ρ))

This check is done on a per body basis and the results are echoed in the Mechanical APDL output listing.
For example:
********* Initial Time Increment Check And Fourier Modulus *********
Specified Initial Time Increment: .75
Estimated Increment Needed, le*le/alpha, Body 1: 0.255118
Estimated Increment Needed, le*le/alpha, Body 2: 1.30416
Estimated Increment Needed, le*le/alpha, Body 3: 0.158196
Estimated Increment Needed, le*le/alpha, Body 4: 0.364406

If this warning is issued make sure that the specified time step sizes are sufficiently fine to accurately
capture the transient phenomenon. The proper use of this guideline depends on the type of problem
being solved and on accuracy expectations.

The Joint Probe cannot Evaluate Results


...A possible cause is that the joint is a fixed body-body joint on a rigid body.
This message displays because fixed body-body joints on rigid bodies do not report a reaction. See the
Probes (p. 1175) section of the help for more information.

The License Manager Server Is Down


Unless a connection is reestablished, the Mechanical application will exit in nn minutes.

Cause
This message occurs in a one-server license environment if your license manager has quit running. In
a three-license server environment, the ANSYS license manager must be running on at least two of the
three license server machines at all times. If two of the license server machines go down, or two of the
machines are not running the license manager, this error message will appear in the program output
or in a message box. The program will continue to run for nn minutes to allow the license manager to
be restarted or to be started on a second machine if using redundant servers. When the message first
displays, nn = 60. The message then reappears every five minutes with nn displaying the elapsed time
at each 5 minute increment (55, 50, 45, etc.) until the connection is established.

Resolution
When this error message appears, start the license manager on the other machines designated as license
servers. If you get this message and determine that the license manager is still running, and you are
running in a one-server environment, then the IP address of the license server machine was changed
while the application was running (this is usually caused by connecting to or disconnecting from an
Internet Service Provider (ISP) that dynamically allocates IP addresses). To correct this situation, you
must return the IP address to the same address that the license server had when the application was
started. If the IP address changes after you start the application (either because you connected to or
disconnected from your ISP), you can correct the error by restarting the application. You should not
need to restart the license manager.

Release 2020 R1 - © ANSYS, Inc.


1867
Troubleshooting

You can avoid this problem by remaining connected to or disconnected from the ISP the entire time
you are running the application.

Linux Platform - Localized Operating System


Specific to the Linux platform: if you are using a localized operating system (such as French or German),
or set your preferences to use regional settings for numbers and dates (comma delimiter versus period),
there is a discrepancy between applications: The ANSYS Workbench will honor the setting and display
the numbers with comma delimiter. However, some of the components (e.g. Geometry, Meshing,
Mechanical, etc.) can only recognize periods; numbers will be displayed and entered with periods. As
a result, you may have to use commas when working in Workbench, and periods when working within
those components. If this causes any inconvenience or confusion, define the "LANG" environment
variable and set to "en-us" (e.g. "setenv LANG en-us" for csh shell) to force ALL applications (including
Workbench) to use the period delimiter consistently throughout. Note that setting LANG to en-us may
also cause some strings to be displayed in English, even if your language preference was set to a non-
English language. Within Mechanical, analysis settings for Explicit Dynamics and Rigid Dynamics, as well
as Imported Load mapping settings are not localized.

If you are using a localized operating system (such as French or German), you must set the following
VisualMainWin control on any machines running these applications in order for these applications to
recognize the correct numerical format. ANSYS Workbench must already be installed before setting this
control.

1. cd to:
<wb_install directory>/v140/aisol

2. Issue the following command:


./.workbench -cmd mwcontrol

3. On the MainWin Control Panel, select Regional Settings.

4. Select the Regional Settings tab.

5. Change the language in the drop-down to match the language you want to use.

The Low/High Boundaries of Cyclic Symmetry


... Have been found to include one or more nodes along the axis of symmetry.This may
reduce solution accuracy. Refer to the Troubleshooting section.
Cyclic symmetry does not support the presence of nodes along the axis of symmetry. There, the node
pair on the high and low sector boundary degenerates to a single node. Consider removing the axial
nodes, fixing the nodes, or providing a much finer mesh in the vicinity.

Release 2020 R1 - © ANSYS, Inc.


1868
Problem Situations

The Remote Boundary Condition object is defined on the Cyclic Axis of Sym-
metry
... This may reduce solution accuracy. Refer to the Troubleshooting section in the Help
System.
This message is displayed when the software detects that a Remote Boundary Condition object is defined
on the Cyclic Axis of Symmetry. To obtain accurate results, it is necessary to scope that Remote
Boundary Condition to a Remote Point, which should be properly constrained by a Remote Displacement.
In addition, non-physical results might be exposed if the Remote Boundary Condition’s Behavior option
is specified as Deformable.

The Solution Combination Folder


...is underdefined due to invalid input environments.
When the Solution Combination Folder is underdefined, verify that:

• At least one environment is checked in the Solution Combination Worksheet.

• The selected environments are static structural analyses.

• The selected environments do not contain convergence.

• The Solution folder within one or more selected environments makes use of Cyclic Solution Display
options other than Program Controlled.

For more information, see Solution Combinations (p. 1370).

The Solver Engine was Unable to Converge


Cause
The solver engine was unable to converge on a solution of a nonlinear problem.

Recommendations
• When Advanced Contact is NOT Present in the Model ...

1. Check for sufficient supports to prevent rigid body motion (structural) or check for thermal material
curves or convection curves which rise and/or fall sharply over the temperature range (thermal).

2. If you encounter a convergence error during a thermal analysis that is using contact, consider modifying
the Thermal Conductance (p. 714) property.

• When Advanced Contact IS Present in the Model ...

1. Check for sufficient supports to prevent rigid body motion or that contact with other parts will prevent
rigid motion.

2. Check that the loading is of a reasonable nature. Unlike linear problems whose results will scale linearly
with the loading, advanced contact is nonlinear and convergence problems may arise if the loading is
too big or small in a real world setting.

Release 2020 R1 - © ANSYS, Inc.


1869
Troubleshooting

3. If the contact type is frictionless (p. 702), try setting the type (p. 701) to rough (p. 702). This may help some
problems to converge if any possible sliding is not constrained.

4. Check that the mesh is sufficiently fine on faces that may be in contact. Too coarse a mesh may cause
inaccurate answers and convergence difficulties.

5. Consider softening the normal contact stiffness KN to a value of .1. The default value is 1 and may be
changed by setting the Normal Stiffness (p. 713). Smaller KN multipliers will allow more contact penet-
ration which may cause inaccuracies but may allow problems to converge that would not otherwise.

6. If symmetric contact is being used (by default the contact is symmetric), consider using asymmetric
contact pairs (p. 703). This may help problems that experience oscillating convergence patterns due to
contact chattering. The program can be directed to automatically use asymmetric contact in the Details
view of the Contact Folder.

The Solver Has Found Conflicting DOF Constraints


...at one or more nodes. Refer to the Troubleshooting section in the Help System.
A variety of boundary conditions in Workbench direct the solver to apply a specific value of displacement
or rotation to one or more nodes. Among these are fixed supports, simple supports, rotational supports,
frictionless supports, cylindrical supports, symmetry planes and displacements. Workbench also allows
you to rotate nodes using the Nodal Orientation (p. 1120) boundary condition. Although Workbench
attempts to negotiate these constraints, along with the nodal rotations applied, there may be instances
in which a node is directed to take on different and incompatible values of displacement or rotation
by two or more of these boundary conditions. For such situations, Workbench will report a conflict.

One example could be to apply non-zero displacements to two faces of a model that meet at an edge,
especially when the displacements do not act in perpendicular directions. Nodes along the edge may
find conflicting instructions as they are instructed to move different amounts along the same direction
in space. If this is the case, consider modifying the non-zero displacements so they act in perpendicular
directions.

Another example could be when one or more nodal orientations are added in Workbench with other
boundary conditions which are applied to same section of geometry (for example by selecting the same
"Scope", or one "Scope" being a part of the other). Each Nodal Orientation prescribes a Nodal Coordinate
System to a subset of nodes. Only one Nodal Coordinate System can be prescribed to a given node.
Whenever this condition is not met, Workbench creates an error that "The solver has found conflicting
DOF constraints with Direct FE loading at one or more nodes".

Direct FE (p. 1120) boundary conditions cannot be applied to nodes that are already scoped with geometry-
based constraints which may modify Nodal Coordinate system.

Problem with RSM-Mechanical Connection


If Mechanical appears to hang up as a result of a job processing in the RSM, select the right-mouse
option Disconnect Job from RSM from the Solution folder to disconnect Mechanical from the current
RSM job.

Release 2020 R1 - © ANSYS, Inc.


1870
Problem Situations

Unable to Find Requested Modes


If this message occurs during a modal analysis (p. 227), most likely a frequency search range was specified
but no natural frequencies were found in the specified range. Either increase search range or specify
that the first N frequencies be found.

If this message occurs during an Eigenvalue Buckling analysis (p. 203), verify that the loading is in the
correct direction (that is, compressive) and that the structure is well constrained so that no rigid body
motion can occur. If the applied boundary conditions appear to be correct, it is likely that a buckling
failure will not occur.

You Must Specify Joint Conditions to all Three Rotational DOFs


...for one or more joints in the model. Refer to the Troubleshooting section in the ANSYS
Workbench Manual
Rotations are not independent in 3D. You must define all three rotations for a Joint Condition before
proceeding to a solve. The problem is mathematically different on the velocities, as the 3 components
are perfectly independent, thus you can define any of the components.

Fracture Meshing Problems


If you encounter fracture meshing failures, first refer to the Fracture Meshing (p. 845) section of the Help
for detailed information about the requirements, characteristics, and limitations of fracture meshing.
Otherwise, review the troubleshooting options described below.

Handling Cracks Close to Face Boundaries

When a crack is defined close to a common edge shared by two faces of a body, and if the Patch Inde-
pendent method is used to generate the base mesh, the fracture mesh generation might fail. This is
because there may be elements which span across the common edge.

To correct this problem, use the Patch Conforming method to generate the base mesh.

See Meshing by Algorithm for more information.

Handling Shallow Crack Failures

A crack failure can be caused if the Major/Minor Radius ratio is greater than 3:1 and there are a high
number of crack divisions. To correct this problem, reduce the Crack Front Divisions when defining the
crack. The recommended range is from 9 to 21 divisions.

A Large Contour Radius relative to the size of the crack might also cause a Fracture Mesh generation
failure. In this case, reduce the contour radius.

For more information, see the Defining a Semi-Elliptical Crack (p. 853) topic in the Fracture Meshing (p. 845)
section of the Help.

Handling Crack Errors for Multiple Cracks

If you define multiple cracks it might take a long time before the mesh fails. This is because multiple
cracks are generated sequentially. When more than one crack is defined, a crack with an undesired
parameter definition can only be detected after the cracks in front of it are generated.

Release 2020 R1 - © ANSYS, Inc.


1871
Troubleshooting

To correct this problem, either increase the buffer zones so that they overlap each other or reduce them
so that they are farther apart from each other.

Handling Buffer Zone Issues

When two Buffer Zones are very close, but not close enough to be combined as one zone during crack
mesh generation, crack mesh generation might fail. To prevent this, re-size the buffer zones such that
they either overlap or are farther apart from each other.

If long and skinny tetrahedral elements are generated inside the Buffer Zone, increase the size of the
zone using the scale factors. Also, refine the Base Mesh relative to the crack size.

Handling Base Mesh Issues

If the tetrahedra near the crack template boundary are long and skinny, the cause might be that the
base mesh is coarse compared to the crack size. To fix the tetrahedra, either increase the buffer zone
or refine the base mesh around the cracks.

If the crack mesh generation fails, it might be because the base mesh is either very coarse or very fine
compared to the crack definition. To correct this problem, regenerate the base mesh with a mesh size
relative to the crack definition. You should also scale the buffer zone to the crack definition.

If the crack mesh generation fails due to base mesh size, regenerate the base mesh with a size relative
to the crack size.

Handling Fracture Affected Zone Definition Failures

If an error occurs when the crack template is inserted, it can be caused by one or more of the following:

• The Fracture Affected Zone Height is big compared to the contour radius. If the height is too large, layers
outside of the contour will not look good.

• The Contour Radius is too big compared to the crack definition

• There are a large number of mesh contours

• There are a large number of Crack Front definitions

To correct these problems, you can:

• Reduce the Fracture Affected Zone Height manually or use the Program-Controlled option.

• Reduce the contour radius. The radius should be small enough to allow room for one layer of an element
outside the contour.

• Reduce the number of mesh contours.

• Reduce the Crack Front divisions. Make sure, however, that there are at least nine Crack Front divisions.

Handling X-Axis Rotation and Alignment

If the X-Axis of the coordinate system which is used to define the crack is not aligned along normal of
the surface on which the crack is inserted, the mesher issues a warning message and rotates the X-Axis
to be consistent with the surface normal.

Handling Projection to the Surface

Release 2020 R1 - © ANSYS, Inc.


1872
Problem Situations

If the origin point of the coordinate system is not on the surface of the scoped body, the crack mesher
automatically inserts a crack on a face of the scoped body that is nearest to the origin location. Note
that the chosen model face may be different than the intended model face. The mesher picks the face
nearest to the location of the origin.

To ensure the mesher chooses the intended model face, use the Create Coordinate System Aligned
with Hit Point Normal option:

1. Click the Hit Point Coordinate button on the Toolbar.

2. Select the point on the face where you want the origin to be located.

3. Right-click the point and choose Coordinate System Aligned with Hit Point Normal.

Improving Mesh Quality

Note that aggressive shape checking is available for Base Mesh generation, but is not available for
Fracture meshing.

High aspect ratio elements might be generated:

• Around the crack tip if a smaller number of crack front divisions are used.

• Near the buffer zone boundary if a small crack is defined in a coarse base mesh.

To improve mesh quality:

• Increase the Crack Front divisions within a range of 9-21 divisions.

• Increase the Buffer Zone or regenerate the Base Mesh with respect to the crack size by using Local Sizing
Control with Sphere of Influence.

Handling Cracks on High Curvature Surfaces

When you define a crack on a highly curved surface, such as the one shown below, the generation of
the crack may fail.

Release 2020 R1 - © ANSYS, Inc.


1873
Troubleshooting

To correct this, use the information from feedback messages to redefine the crack definition and/or
modify the mesh region on which the crack is inserted.

Lustre Parallel File Systems on Linux


Projects created prior to Release 18.2 will not be usable on Lustre until migrated as follows:

1. Load the project into 18.2 software on a system that does not use a Lustre parallel file system.

2. Perform an operation that changes each model in the Mechanical system (for example, hide and then
show a part). If systems share the same model, the change needs to be done for only one of the systems.

3. Save the project.

Recommendations
Microsoft ClearType edge smoothing option may cause font display problem
If you use Microsoft ClearType edge smoothing method with Large size DPI setting, you may see distorted
dimension text in DesignModeler and legend text in the Mechanical application. The problem occurs
when the user minimizes or maximizes the Workbench window. In DesignModeler the display can be
corrected on some machines by nudging the graphics window pane a pixel or two. This will cause a
resize event in the graphics browser which will redraw the dimension text properly. Nudging the
graphics window pane does not correct the problem in the Mechanical application, however. Alternatively,
if the edge smoothing method is set to Standard instead of ClearType, then the text display appears
correctly in both applets. Note though, this is machine dependent, so the suggestions may not work
on all machines. To ensure the text appears properly, you should turn off edge smoothing entirely.

Release 2020 R1 - © ANSYS, Inc.


1874
Appendix A. Glossary of General Terms
API Application Program Interface: This is a defined interface of functions
that can be called by the scripts. This interface will remain reasonably
constant and no functions will be removed without deprecation and
warning.

Callout A message that appears as a result of an action initiated within the wizard.
Callouts usually point to a toolbar button, a row in the Details
View (p. 17), or object in the Tree Outline (p. 7). The message contains
descriptive and instructive text.

Context Menu Provides a short list of options applicable to a specific object or window.
To view a context menu, click the right mouse button on an object or
in a window.

Context Toolbar A toolbar containing options appropriate for the current level in the Tree
Outline (p. 7).

Deprecate When a function in the API is removed it will be deprecated and undoc-
umented. This means that it will still be available for the next release,
but will be removed in the future. A warning will be provided with a
suggested alternative method of achieving the same function.

Details View Provides information on the highlighted object in the Tree Outline (p. 7).

Displacement A vector quantity used to measure the movement of a point from one
location to another. The basic unit for displacement is (Length).

Double Data type that can be assigned to real (decimal) numbers, e.g. 2.3462

Drag Moving an on-screen object in the Tree Outline (p. 7) from one location
to another using the mouse cursor while holding down the left button.
The drag is interpreted as "move" if the object is dragged from the outline
and "copy" if the object is dragged from the outline while holding down
the Ctrl key

Edge A selectable entity on a part that occurs at the intersection of two sur-
faces. In a surface model, an edge can also exist on the edge of one
surface.

Elastic Strain Normal elastic strain is a measure of the elongation or contraction of a


hypothetical line segment inside a body per unit length. Normal elastic
strain is dimensionless, however in practice it is common to assign normal
elastic strain the basic unit of (Length / Length). Shear elastic strain is a
measure of the change in angle that occurs between two initially perpen-
dicular hypothetical line segment inside a body. The basic unit for shear
elastic strain is radians.

Release 2020 R1 - © ANSYS, Inc.


1875
Glossary of General Terms

Environment Temperature This property of the analysis environment object (p. 1690), defines the
temperature of the body unless this temperature is specified by a partic-
ular load such as a thermal condition or an imported temperature. This
will also be the material reference temperature unless overridden by the
Body. Not a valid property for thermal analyses.

Face A selectable area on a part bordered on all sides by edges. Periodic, non-
boundary edged faces (like spheres) may occasionally appear.

Factor of Safety Factor of safety is defined as the ratio of the limit strength of a material
to the maximum stress predicted for the design. This definition of factor
of safety assumes that the applied load is linearly related to stress (an
assumption implicit in all calculations performed in the application). A
factor of safety of less than one generally predicts failure of the design;
in practice a factor of safety of one or greater is required to help avoid
the potential for failure.

FEA Finite Element Analysis. A robust and mature technique for approximating
the physical behavior of a complex system by representing the system
as a large number of simple interrelated building blocks called elements.

Fundamental Frequencies The fundamental frequencies are the frequencies at which a structure
under free vibration will vibrate into its fundamental mode shapes. The
fundamental frequencies are measured in Hertz (cycles per second).

Heat Flux A measure of heat flow per unit area. The basic unit for heat flux is (Heat
/ Length*Length).

Int Data type that can be assigned to integer (whole) numbers, e.g.2

Margin of Safety Margin of safety is always equal to the factor of safety minus one.

Multiple Select Select more than one surface, edge or vertex by holding the Ctrl key.

Object A set of information displayed visually as an icon (usually in the Tree


Outline (p. 7)).

Python This is a non-proprietary scriptable programming language that is com-


monly used throughout the world. Full details can be found at www.py-
thon.org. A number of debuggers are available to enable a script to be
stepped through.

Reference Temperature The reference temperature defines the temperature at which strain in
the design does not result from thermal expansion or contraction. For
many situations, reference temperature is adequately defined as room
temperature. The reference temperature is defined for each body in a
model. A coefficient of thermal expansion curve will be adjusted for the
body's reference temperature if the reference temperature of the coeffi-
cient of thermal expansion is different.

Right-Hand Rule The right-hand rule is a convenient method for determining the sense
of a rotation defined by a vector: close your right hand and extend your
thumb in the direction of the vector defining the rotation. Your fingers

Release 2020 R1 - © ANSYS, Inc.


1876
will indicate the sense or direction of the rotation. The direction in which
your fingers curl is the positive direction.

Rigid Body Motion Might occur when the part is free to translate or rotate in one or more
directions. For example, a body floating in space is free to move in the
X-, Y-, and Z-directions and to rotate about the X-, Y-, and Z-directions.

Stress A measure of the internal forces inside a body. The basic unit for stress
is (Force / Length*Length).

String Data type that can be assigned to one or more characters of text, e.g.
Hello World

Temperature A scalar quantity used to measure the relative hotness or coldness of a


point from one location to another. The basic units for temperature are
degrees Fahrenheit or Celsius.

Vertex A selectable entity on a part that occurs at the intersection of two or


more edges.

World Coordinate System The fixed global Cartesian (X, Y, Z) coordinate system defined for a part
by the CAD system.

XML eXtensible Markup Language: This is a standard layout of text based files
in a metalanguage that enables users to define their own customized
markup languages.

Release 2020 R1 - © ANSYS, Inc.


1877
Release 2020 R1 - © ANSYS, Inc.
1878
Appendix B. Data Transfer Mapping and Validation
This appendix examines the properties that are available when you map node and element data from
external systems to Mechanical systems. It defines the requirements for these properties and also de-
scribes additional properties that become available depending upon how you have configured your up
and downstream systems. In addition, this appendix discusses support properties that include graphical
controls and Named Selection generation options as well as the Mapping Validation feature that, if
available for your analysis configuration, performs an accuracy evaluation of the mapping process.
Data Transfer Mesh Mapping
Mapping Validation

Data Transfer Mesh Mapping


To transfer data across a dissimilar mesh interface, the nodes of one mesh must be mapped to the
local coordinates of a node/element in the other mesh. This section describes the settings that are
available in Mechanical when data is mapped across two different meshes.

You can add the exported mesh and loads as external data in the project schematic and couple a new
Mechanical analysis system with this external data. The Mapping Settings described below are available
within Mechanical for Thermal-Stress coupling with dissimilar mesh, Submodeling, when temperatures
or displacements are transferred from Mechanical to Ansoft, or when the source data comes from an
External Data system.

Mapping Settings
The Settings category provides the following properties.

Mapping Control
By default, when Program Controlled is selected, the software will determine the appropriate algorithm
and settings based on the source and target mesh data, as well as the data type being transferred. See
Program Controlled Mapping (p. 1895) topic below for additional information. You may choose to modify
the advanced features by setting this to Manual.

Mapping
This read-only property displays the mapping algorithms the application selects. Options include:

• Profile Preserving: Using this mapping option, the application simply takes the profile of the variable
(for example, temperature) on one mesh, and matches or maps it to the other mesh as best as it can.

• Conservative: Using this mapping option, the application makes sure that the profile is interpolated in
such a way as to ensure that a total quantity passing across the interface is conserved, that is the same
total passes out of one mesh and into the other. For example, a conservative interpolation of force ensures
that the total force on one side of the boundary exactly matches the total force received by the other

Release 2020 R1 - © ANSYS, Inc.


1879
Data Transfer Mapping and Validation

side of the boundary, even if the mesh resolution is poor. Conservative interpolation does not make
sense for a variable such as temperature where there is no corresponding physical quantity to conserve.

Note

Conservative algorithms are only available for Imported Force loads. Conservative al-
gorithms are not available for 2D to 3D data transfers. If conservative algorithms are
not available, it is a read-only field displaying that a "Profile Preserving" algorithm is
being used.

Weighting
Choose which type of weighting should be performed. This option can be changed only if Mapping
Control is set to Manual.

• Direct Assignment applies the source value directly on the nodes/elements identified by Node
IDs/Element IDs in the External Data specification.

Note

This mapping only supports loads applied to nodes or elements. The following loads
applied to element faces are not supported:

– Pressure (on element faces)

– Convection Coefficient

– Heat Flux

• Triangulation creates temporary elements from the n closest source nodes to find the closest points
that will contribute portions of their data values. For 3D, 4-node tetrahedrons are created, and for 2D,
3-node triangles are created by iterating over all possible combinations of the source points (maximum
number controlled by the Limit property), starting with the closest points. If the target point is found
within the element, weights are calculated based on the target’s location inside the element.

• Distance Based Average uses the distance from the target node to the specified number of closest
source node(s) to calculate a weighting value.

• Weighting:

– Shape Function: Two mapping methods are available for a load transfer: “Profile Preserving” and
“Conservative”.

In a Profile Preserving mapping, each node on the target (receiver) side maps onto an element
on the source (sender) side (α1). The transfer variable is then interpolated at α1. The transfer
value is T1 = φ (α1). Thus, all nodes on the target side query the source side.

Release 2020 R1 - © ANSYS, Inc.


1880
Data Transfer Mesh Mapping

Figure 34: Profile Preserving Mapping

In a conservative mapping, each node X on the source (sender) maps onto an element on the
target (receiver) side. Thus, the transfer variable on the source is split into two quantities that
are added to the target nodes. As shown in the following figure, the force at node 4 splits into
forces at nodes 3’ and 4’.

Figure 35: Conservative Mapping

Thus profile preserving (conservative) version of Shape Function algorithm loops over the
target (source) nodes and tries to locate a source (target) element that each target (source)
node can be mapped to. Weights for each of the source nodes are then assigned based on the
location of the target (source) node and the shape function of the element. For each target
(source) node, the search efficiency can be improved by restricting the search to a subset of
the source (target) elements. The search algorithm works by:

→ Distributing all source (target) elements into Cartesian boxes or buckets. The number of buckets is
controlled by the Scale property.

→ Locating each of the target nodes in a box

Release 2020 R1 - © ANSYS, Inc.


1881
Data Transfer Mapping and Validation

→ Finding an element that each target (source) node can be mapped to by restricting the search with
each target’s (source’s) box

Note

→ When there is a significant distance between target (source) node and the closest element,
e.g. Shell-Solid submodeling, the node and the element may not be found in the same
box. In order to improve mapping accuracy in such cases, the Pinball control may be
used. See Pinball in the Advanced (p. 1885) section for more details.

→ For conservative mapping, the value on a source node is distributed only on the nodes
of the target element it is mapped to. Therefore, it is possible, especially if you are
mapping from coarse to fine meshes, that some of the mapped target nodes get a zero
value. This is because none of the adjacent elements are mapped to one or more source
nodes.

– Kriging is a regression-based interpolation technique that assigns weights to surrounding source


points according to their spatial covariance values. The algorithm combines the kriging model with
a polynomial model to capture local and global deviations. The kriging model interpolates the source
points based on their localized deviations, while the polynomial model globally approximates the
source space. See Kriging Algorithms in the ANSYS DesignXplorer User's Guide for more information.

Note

By default, the Kriging technique uses an adaptive algorithm and ensures that the
interpolated values do not exceed specific limits. The adaptive algorithm starts by
using the higher-order Cross Quadratic polynomial to interpolate data. If the inter-
polated value of each target point is outside the extrapolation limit you specified,
the algorithm re-interpolates data by reducing the polynomial order and the number
of source points. Target nodes whose values are outside the limits when the lowest
polynomial type is used are not assigned a value.

The Kriging algorithm, when used with the higher-order Cross Quadratic or Pure
Quadratic polynomial, may fail to correctly interpolate data for a target point if
multiple source points are spaced close to one another or if the target point is outside
the region enclosed by the source points that are selected for interpolation. This
may introduce gross errors in the estimation of the target value and manifests itself
mostly when mapping data on surface or edge geometries. In such cases, you should
change the Polynomial Type to Constant or Linear and, if necessary, reduce the
number of source points to be included for the interpolation.

– UV Mapping can be used to transfer data from one surface to another. Unlike other algorithms, UV
mapping does not require the surfaces to be coincident. This allows for mapping between deformed
and un-deformed geometries, as well as transfers between dissimilar geometry. Element data is required
from both the source and the target mesh. If the source is an Mechanical APDL .cdb file containing
volumetric element data, a nodal component must also be specified which will be used to define the
surface from which the data transfer will occur.

Polyhedral Surface Creation and Conversion to UV

Release 2020 R1 - © ANSYS, Inc.


1882
Data Transfer Mesh Mapping

To map a mesh in UV space, the application first creates polyhedral surfaces from the given
mesh data. If the source mesh is volumetric data, an associated node-based component must
be selected such that the nodes consist of the surface area where the mapping takes place.
Once the application creates the source and target surfaces, they are then ‘unfolded’ and
converted into UV coordinates. The application defines the UV space as a parametric space
where the axis data equals 0.0 to 1.0. Alignment points anchor the node locations to the corners
of the 1x1 box.

Interpolation

Once the source and target data is converted to UV space, the target nodal UV locations are
used to locate the source element that would contain the target node. The value for the target
is then calculated based on the values provided from the source elements nodes.

Note

Available weighting options depend upon the data available from source and target
and on the Mapping setting. Some of the weighting options may not be available for
certain mesh data or Mapping settings. For example, when Mapping is set to Profile
Preserving, Shape Function and UV are only available when the source provides element
information. For Conservative Mapping, only Shape Function for Surface transfers is
available.

Transfer Type
Enables you to choose the dimension of the transfer (for 3D profile preserving transfers only). This option
is available only for Triangulation, Shape Function, and for adaptive Kriging. For best results, use the
Surface option when mapping data across surfaces and the Volumetric option when mapping data across
volumes.

When used with Triangulation:

• The Surface option tries to map each target point by searching triangles that are created from the set
of closest source points. The target point will be projected onto the plane relative to the triangle surface.
If the point is found inside the triangle, the weights are calculated based on the target’s projected location
inside the triangle.

• The Volumetric option tries to map each target point by searching tetrahedrons that are created from
the set of closest source points.

When used with the Shape Function:

• The Surface option uses the bucket surface search algorithm to locate a source element that each target
node can be mapped to. This option supports only triangle and quadrilateral source elements; do not
use it if your source elements are other shapes because the algorithm does not account for these shapes.

• The Volumetric option uses the bucket volume search algorithm to locate a source element that each
target node can be mapped to. This option supports triangle, quadrilateral, tetrahedron, hexahedron,
and wedge source elements.

When used with adaptive Kriging, the Surface option uses fewer surrounding source points to in-
terpolate data than the Volumetric option does.

Release 2020 R1 - © ANSYS, Inc.


1883
Data Transfer Mapping and Validation

2D Projection
Available only for 2D to 3D data transfers from an External Data system connected to Mechanical. The
default option is Normal To Plane. You will be able to choose between the default as well as all application
and user input coordinate systems.

Rigid Transformation Controls


Rigid transformation properties enable you to apply a coordinate transformation to the source points.
Two options are available through the Mesh Alignment property:

Use Origin and Euler Angles: The source locations are transformed by the coordinate system defined
by the Origin and Theta entries. For example, applying a value of .1 meters to Origin X would modify
the x locations of all the source points by adding .1 meters to their values.

Use Coordinate Systems: To use this option, choose two coordinate systems, (1) Source Coordinate
System attached to the source mesh frame of reference and (2) Target Coordinate System attached to
the target mesh frame of reference. The transformations are automatically calculated such that the
Source Coordinate System is aligned with the Target Coordinate System after transformation. For example,
when the source mesh is defined in the XY plane, whereas the target geometry is defined in a plane
obtained by applying the Euler rotations RXY, RYZ and RZX to the XY plane. Then choosing Global Co-
ordinate System as Source Coordinate System and the coordinate system created by applying the
transformations RXY, RYZ and RZX to the Global Coordinate System as the Target Coordinate Systems,
the source mesh is transformed such that it is aligned with the target geometry. This option is useful
if the source points are defined with respect to a coordinate system that is not aligned with the target
geometry system.

The option Display Source Points on an Imported Load or Imported Thickness object inside Mechan-
ical respects this transformation and can be very helpful in ensuring proper alignment between the
source and target points.

Graphics Controls
The Graphics Controls category provides the following properties.

• Display Source Points: Toggle display of source point data. This can be helpful in visualizing where the
source point data is in reference to the target mesh.

• Display Source Point Ids: Toggle display of source point identifiers. This can be helpful in conjunction with
validation objects when trying to identify nodes with undefined values. Note that if a column is not defined
with the Node ID Data Type, the source point ids will correspond to the row from which they come in the
file. For formatted and delimited files, ids will start after skipped lines.

• Display Interior Points: Available when Display Source Points or Display Source Point Ids is set to On.
Toggle allowing source point data to be displayed through the model so that interior points can be seen.

• Display Projection Plane: Toggle display of project plane (available only for 2D to 3D mapping).

Legend Controls
The Legend Controls category provides the following properties.

• Legend Range: Program Controlled (default) or Manual control of the legend minimum and maximum
values. When Program Controlled is selected, the target data's minimum and maximum values will be used

Release 2020 R1 - © ANSYS, Inc.


1884
Data Transfer Mesh Mapping

in the legend. When Manual is selected, control of the Maximum and Minimum values can input and the
graphics will be drawn based on these values.

• Minimum: When Legend Range is set to Manual, this option is available for inputting the minimum legend
value.

• Maximum: When Legend Range is set to Manual, this option is available for inputting the maximum legend
value.

• Source Minimum: Read only field providing the source data minimum value.

• Source Maximum: Read only field providing the source data maximum value.

Named Selection Creation


The Named Selections category provides the following properties.

• Unmapped Nodes: Activating this property creates a named selection containing all of the points that
cannot be mapped. The default setting is Off.

In addition, when you activate this property, an associated Name property displays. This property
displays the name of the Named Selection. You can edit this field. By default, the application assigns
name "Unmapped Nodes."

• Mapped Nodes: Activating this property creates a named selection that contains all mapped points. The
default setting is Off.

In addition, when you activate this property, an associated Name property displays. This property
displays the name of the Named Selection. You can edit this field. By default, the application assigns
name "Mapped Nodes."

• Outside Nodes: Activating this property create a named selection containing all the points that cannot be
found within tetrahedrons/triangles when Triangulation is used. The default setting is Off.

In addition, when you activate this property, an associated Name property displays. This property
displays the name of the Named Selection. You can edit this field. By default, the application assigns
name "Outside Nodes."

These settings are only available for profile preserving mapping.

Advanced
The application filters the properties of the Advanced category based on the settings made in the
Mapping Control and Weighting properties in the Mapping Settings (p. 1879) category. Properties include:

• Pinball: The Pinball property enables you to specify a region of interest around a target point. Only the
source points/elements inside the pinball region are considered for mapping and any point/element outside
of the pinball will not be used. Specific behavior of the Pinball control is dependent on the Weighting type
selected as discussed below:

– When used with Triangulation or Distance Based Average, a bounding box is created around the target
point based on the value of the pinball to find the closest source points. Any point outside of the
bounding box will not be used. By default, the Program Controlled value is 0.0, which calculates the
distance based on .05% of the source region's bounding box size. The bounding box will automatically

Release 2020 R1 - © ANSYS, Inc.


1885
Data Transfer Mapping and Validation

resize if the mapping is unable to find the minimum number of points required to calculate weighting
factors. (Note that resizing occurs only for Program Controlled.)

Note

In certain cases when Pinball is set to Program Controlled, the process of searching for
source nodes around a target node can take a long time. In the image below, the target
nodes are located on the red face. The target nodes (A) closest to the vertical body will
quickly find nodes in the +Y axis direction. Target nodes (B) further down the X axis will
take longer to find.

As an example, consider the case shown in the image below. The two red dots indicate
target nodes in regions A and B. For each target node, the triangulation algorithm will
begin its search for source nodes within the perimeter of a psuedo cube (bounding box)
centered at its location. For the first pass, the edge length of the cube is set to be 0.05%
of the maximum bounding box length of the source region. The algorithm looks to find
‘n’ source points (set by the limits property) in the positive and negative X, Y, and Z axes
of the cube. If ‘n’ source points cannot be found in any of the six directions (±X, ±Y, and
±Z), the size of the search region is doubled and the process repeated. The search process

Release 2020 R1 - © ANSYS, Inc.


1886
Data Transfer Mesh Mapping

continues until the required number of source points are found in all directions or until
the search region extends beyond the limits of the source bounding box.

During the first pass, for the target node in region A, the algorithm is able to find the re-
quired number of source nodes. However, for the target node in region B, sufficient nodes
cannot be found in the +Y direction and the size of the search area is increased. As illus-
trated in the figure below, for the target node in region B, the algorithm runs through
several iterations before it is able to find the required number of source nodes. This results
in an increase in time as well as the possible inclusion of source nodes that are significantly
further away from the target node.

Please note that for each target node the pinball is reset to its initial size (0.05% of the
maximum bounding box length) before the search begins.

For such cases it is recommended that you specify a pinball value so that the search box
can be controlled to only find nodes within a certain region. This allows for triangulation
to quickly search for source nodes, as well as to ignore source nodes that are sufficiently
far away from the target node.

Release 2020 R1 - © ANSYS, Inc.


1887
Data Transfer Mapping and Validation

– When used with Shape Function, the Pinball control can be used to:

→ Exclude from mapping to elements far away from the target point. When Transfer Type is Surface,
the target point is projected onto the source elements to find the matching element. Due to projection,
the gap (the distance between target point and its projection on the matching element) between the
target point and the matching element may be large. Such elements are excluded from mapping if the
gap is larger than the Pinball Value specified.

→ Expand the search region to find matching elements. Shape function algorithm works by distributing
the source elements into regions called buckets, and then for each target point, finding the appropriate
bucket and searching for the matching element in the bucket. When there is a significant distance
between a target node and the closest element, e.g. Shell-Solid submodeling, the node and the element
may not be found in the same bucket. In order to improve mapping accuracy in such cases, the Pinball
control may be used to include additional buckets for mapping. When a Pinball Value greater that 0
is specified, then a bounding region is created around the target node using the Pinball Value and all
the buckets associated with the region are used to find the appropriate element. To improve the
mapping efficiency, the search is restricted only to the elements within the bounding region.

Release 2020 R1 - © ANSYS, Inc.


1888
Data Transfer Mesh Mapping

α3 is excluded when pinball (p) < gap (g), and included when pinball (p) ≥gap (g).

The Pinball option is not available when Weighting is set to Kriging.

• Limit: Number of nearby points considered for interpolation. Defaults to 20. Lower values will reduce pro-
cessing time, however, some distorted or irregular meshes will require a higher Limit value to successfully
encounter nodes for triangulation.

When Weighting is set to Kriging, the minimum value that can be used is based on the selected
Polynomial type.

Weighting Minimum Maximum Limit


Limit
Triangulation 5 20
Kriging (Constant) 3 (3D), 2 (2D) Number of source points
Kriging (Linear) 4 (3D), 3 (2D) Number of source points
Kriging (Pure Quadratic) 7 (3D), 5 (2D) Number of source points
Kriging (Cross Quadratic) 10 (3D), 6 (2D) Number of source points

• Outside Option: Enables you to ignore or choose a different weighting algorithm for target points that
cannot be found within the source mesh/points. Different options are available, based on the Weighting
option chosen:

– When used with Triangulation. For target points that cannot be found within tetrahedrons/triangles
created for Triangulation.

→ Distance Based Average: The mapping will use a weighted average based on distances to the closest
Number of Points. Distance Based Average is the default option.

→ Ignore: Target points will be ignored and no value will be applied.

→ Projection: Triangles will be created from the closest Number of Points and the target point will be
projected onto the plane relative to the triangle surface. If the point is found inside the triangle, the
weights are calculated based on the target’s projected location inside the triangle. This option is available
only for 3D transfers when the Transfer Type is set to Volumetric.

– When used with Shape Function. For target points that cannot be found within source elements.

→ Nearest Node: The mapping will use the data from the nearest source node.

→ Ignore: Target points will be ignored and no value will be applied.

Note

– For the Conservative Shape Function algorithm, the source mesh is mapped onto the target
mesh (as opposed to profile preserving version, which maps target mesh onto source), and
outside options control the contribution from source nodes which fall outside the target mesh.

– Nearest Node is the default option for the Profile Preserving Shape Function algorithm,
while the Ignore option is the default for the conservative algorithm.

Release 2020 R1 - © ANSYS, Inc.


1889
Data Transfer Mapping and Validation

• Number of Points: When Weighting is set to Distance Based Average, or when Outside Option is set to
Distance Based Average or Projection, this option is available to specify how many closest source points
should be used when calculating weights. Valid range is from 1 to 8 for Distance Based Average and 3 to
20 for Projection. Defaults to 3.

• Outside Distance Checking: When Weighting is set to Triangulation and Outside Option is set to Distance
Based Average or Projection, this option enables you to specify a Maximum Distance cutoff beyond which
source points will be ignored. Defaults to Off. The maximum number of source points is limited to the value
specified by the Number of Points setting.

– If the Outside Option is set to Distance Based Average, only source points that lie on or within a sphere
(centered at the targets location and radius defined by the Maximum Distance value) will provide contri-
butions.

– If the Outside Option is set to Projection, the algorithm only uses triangles with centroids that lie on or
inside a sphere (centered at the targets location and radius defined by the Maximum Distance value).

In Figure 36: Outside Nodes (Pink) with Mesh Overlay (p. 1890), all the pink nodes on the surface are
found “Outside” the source points and will use the Outside Distance Checking based on the Max-
imum Distance specified.

Figure 36: Outside Nodes (Pink) with Mesh Overlay

In Figure 37: Maximum Distance set to 0.005 (m) (p. 1891), the circle is at the mouse location with radius
set to 0.005 (m). Nodes within this radius will be mapped. The source nodes are drawn as black dots
and come from an extremely coarse mesh.

Release 2020 R1 - © ANSYS, Inc.


1890
Data Transfer Mesh Mapping

Figure 37: Maximum Distance set to 0.005 (m)

In Figure 38: Mapped Nodes (p. 1891), the “Outside” nodes get mapped because they are located
within the Maximum Distance.

Figure 38: Mapped Nodes

The result of the import is shown in Figure 39: Imported Data using Maximum Distance for Outside
Nodes (p. 1892). Transparent areas show target nodes that do not get mapped because there are no
source nodes within the Maximum Distance.

Release 2020 R1 - © ANSYS, Inc.


1891
Data Transfer Mapping and Validation

Figure 39: Imported Data using Maximum Distance for Outside Nodes

When Weighting is set to Kriging, this option allows you to ignore target points that lie outside the
source bounding box. Defaults to Off. When this option is set to On, the Bounding Box Tolerance
property enables you to include target points that lie outside the source bounding box by specifying
a tolerance value. The algorithm adds this tolerance value to the source bounding box when it checks
to see if a target point should be ignored or not.

• Scale: When weighting is set to Shape Function, the scaling factor (%) determines the number of buckets
used to distribute the source elements. Defaults to 50% (2 buckets).

• Edge Tolerance: Dimensionless mapping tolerance (default = 0.05).

– Shape Function for Surface/Edge topology.

• Correlation Function: When weighting is set to Kriging, this property enables you to change the mathem-
atical function that is used to model the spatial correlation between the sample points. Defaults to Gaussian.

• Polynomial: When weighting is set to Kriging, this property enables you to change the mathematical
function that is used to globally approximate the sample. Defaults to Adaptive.

• Extrapolation Tolerance: You can use this option with adaptive Kriging to ensure that the interpolated
value for each target point lies within specific limits. The tolerance is applied to the source range (based on
the source points used for each target point) to determine if the interpolated value is satisfactory or if the
data needs to be re-interpolated by reducing the polynomial order and the number of source points. For
example, consider a target point having source values between 99 and 100. The default tolerance value of
10% will ensure that the mapped value is between 98.9 and 100.1. Target points whose values are outside
the limits when the lowest polynomial type is used are not assigned a value.

Advanced Shell-Solid
Advanced shell-solid settings are filtered based on the Mapping Control and Weighting type selected
in Mapping Settings (p. 1879). They are only available for Shell-Solid submodeling. In the case of imported
cut boundary conditions, Shape Function is the only available Weighting type.

Release 2020 R1 - © ANSYS, Inc.


1892
Data Transfer Mesh Mapping

Pinball Factor: This value is used to calculate the Pinball Value for shell-solid submodeling. The Pinball
Value is calculated by scaling the maximum shell thickness with the Pinball Factor.

Figure 40: Shell-Solid Submodeling with Pinball Factor = 1.0

Figure 41: Shell-Solid Submodeling with Pinball Factor = 1.2

As shown in Figure 40: Shell-Solid Submodeling with Pinball Factor = 1.0 (p. 1893) and Figure 41: Shell-
Solid Submodeling with Pinball Factor = 1.2 (p. 1893), the gap between the nodes in the filleted region
is greater than the maximum shell thickness for the model. Hence using a Pinball Factor equal to 1
results in nodes in the fillet not finding appropriate matching elements.(1) When Pinball Factor of 1.2
is used, then additional buckets are included in the search resulting in better mapping results.(2)

Note

Increasing the Pinball Factor increases the number of buckets searched to find the matching
element hence, may decrease the efficiency of the mapping. An appropriate value should

Release 2020 R1 - © ANSYS, Inc.


1893
Data Transfer Mapping and Validation

be chosen so that the resulting bounding region includes the matching element but not too
big so as to negatively affect the efficiency of the search.

Shell Thickness Factor: For shell models with variable thickness, the gap between the target
node, and matching element may be large. Shell Thickness Factor is used to exclude any
matching element which has a gap greater than Thickness* Shell Thickness Factor.
Thickness is the average element thickness of the matching element.

Figure 42: Shell-Solid Submodeling with Shell Thickness Factor = 0.6

Figure 43: Shell-Solid Submodeling with Shell Thickness Factor = 1.2

Note

Increasing the Shell Thickness Factor to allow submodel nodes to be “found” can produce
poor submodel results as shown in Figure 42: Shell-Solid Submodeling with Shell Thickness

Release 2020 R1 - © ANSYS, Inc.


1894
Data Transfer Mesh Mapping

Factor = 0.6 (p. 1894) and Figure 43: Shell-Solid Submodeling with Shell Thickness Factor =
1.2 (p. 1894). where large Shell Thickness Factor causes the target nodes on the web region
to be matched with the base (3), whereas the target nodes are more appropriately matched
for a smaller Shell Thickness Factor (4).

UV Source Controls/UV Target Controls


• Alignment: Program Controlled (default) or Manual control of selecting the four alignment points needed
for UV Mapping. The process of UV mapping involves aligning both the source and target nodal data from
XYZ coordinates into the equivalent UV space. To do this, the mapper needs to have access to four alignment
locations as reference points for unfolding and flattening the nodal information. These four locations are
referred to as “Front Bottom”,“Rear Bottom”,“Rear Top”, and “Front Top”. When the Program Controlled
alignment option is selected, the associated coordinate systems ZX plane is used in relation to the associated
mesh nodal locations.

– Coordinate System: Available when Alignment is set to Program Controlled. One of the available co-
ordinate systems must be selected as a reference point for Program Controlled alignment. The mesh
nodal data is transformed related to the ZX plane of the selected coordinate system. A mean Z value is
determined so that the nodes can be split into 2 groups, an upper and lower section. The nodes in each
section are then sorted based on their X position. If there are nodes at the same X position, these points
are then sorted based on their Z location. For the “Rear Bottom” and “Front Bottom” points, the minimum
sorted Z point will be used, and for the “Rear Top” and “Front Top”, the maximum Z point will be used.

– Nodes: Available when Alignment is set to Manual for UV Source Controls. The user must list the 4 node
locations in the text entry separated by commas. The order must be input as Front Bottom, Rear Bottom,
Rear Top, Front Top.

– Target Front-Bottom, Target Rear-Bottom, Target Front-Top, Target Front-Top: Available when
Alignment is set to Manual for UV Target Controls. The user must select geometric vertices for each
alignment point.

Program Controlled Mapping


Refer to the following table for the appropriate settings for when you set the Mapping Control property
to Program Controlled in order to determine which type of mapping algorithm to use. The application
determines default settings based on the properties described above.

When Mapping is Profile Preserving:

Source mesh can provide: Target mesh can provide: Weighting that will be used:
Node IDs Only Nodes Uses Direct Assignment to assign
values to target nodes.

Release 2020 R1 - © ANSYS, Inc.


1895
Data Transfer Mapping and Validation

Source mesh can provide: Target mesh can provide: Weighting that will be used:
Element IDs Only Elements Uses Direct Assignment to assign
values to target elements.
Nodes Only Nodes Only Uses Triangulation to calculate
mapping data.
Nodes and Elements Nodes Only Uses Shape Function to calculate
mapping data.

When Mapping is Conservative

Source mesh can provide: Target mesh can provide: Weighting that will be used:
Nodes Only Nodes and Elements Uses Shape Function to calculate
mapping data.

Manual Mapping
When manual mode is selected, you will be able to control advanced settings for the mapper. Based
on the mapping chosen (conservative or profile preserving) and mesh data provided from the source
and target, you will be able to choose the type of weighting algorithm.

For Profile Preserving Mapping:

If the source mesh contains only points, you will be able to select from the following:

• Direct Assignment (requires source Node or Element IDs)

• Triangulation

• Distance Based Average

• Kriging

If the source mesh also contains element data, you will have the items listed above as well as:

• Shape Function

For Conservative Mapping:

If the source mesh contains only points, you will be able to select from the following:

• Shape Function

Element shapes supported during mapping when Shape Function is selected:

Element Shape Supported


3 Node Triangle X (2D) (3D)
6 Node Triangle X (2D) (3D)
4 Node Quadrilateral X (2D) (3D)
8 Node Quadrilateral X (2D) (3D)
4 Node Tetrahedron X (3D)
10 Node Tetrahedron X (3D)

Release 2020 R1 - © ANSYS, Inc.


1896
Data Transfer Mesh Mapping

Element Shape Supported


8 Node Hexahedron X (3D)
20 Node Hexahedron X (3D)
6 Node Wedge X (3D)
15 Node Wedge X (3D)

2D to 3D Mapping
Mapping point data from 2D to 3D analyses is possible using the External Data system connected to a
downstream Mechanical system. This mapping is performed by collapsing the 3D mesh data into a 2D
plane and calculating target point weighting factors from the source point data.

2D results in the XY Plane:

You will be able to select the 2D project plane to use based on the available coordinate systems as well
as an option to select normal to the 2D source point data (Normal To Plane). Using the Graphics
Controls described above, you will be able to turn on and off visualization of the source point data
and the 2D projection plane.

Source point and 2D projection plane displayed:

Release 2020 R1 - © ANSYS, Inc.


1897
Data Transfer Mapping and Validation

When selecting Cartesian coordinate systems, the projection will be done on the XY Plane. If the co-
ordinate system is cylindrical, the projection will be rotated about the Z axis into the ZX Plane. Normal
To Plane will project the target points into the source point plane.

3D mapped data using cylindrical coordinate system projection:

3D mapped data using Normal To Plane:

Note

Conservative mapping is not available for 2D to 3D transfers.

Release 2020 R1 - © ANSYS, Inc.


1898
Mapping Validation

Notes
When mapping point cloud data, the mapping utility does not know where body boundaries are. If you
have a model with contact between two bodies, the mapping may pick up points from both bodies
causing undesired results.

Mapping Validation
Mapping Validation objects can be inserted under imported data objects* to allow for an evaluation
of how the mapping operation performed, by either right-clicking and selecting Insert > Validation
from the context menu, or by clicking the Validation button in the toolbar. To perform a validation,
right-click the Validation object and select Analyze. The following sections describe different methods
to help analyze and determine if the mapping and interpolation that was performed produced an ac-
curate representation of the mapped value data transferred from the source mesh onto the target mesh.

*Mapping Validation is supported on the following:

• External Data Import

• Submodeling

– Not supported for Shell-Solid Submodeling

• Thermal-Stress Analysis

• One-way Acoustic Coupling Analysis

Definition
The variable to display the validation information can be identified using the following properties:

1. File Identifier*: A list of variables obtained from the parent object will be listed in the File Identifier drop-
down. The validation information will be displayed based on the selected item.

2. Layer: This property is only available when validating Imported Trace (p. 1737) from External Data system.
Specify the layer from the PCB layout.

3. Row: The row of the parent worksheet.

4. Data: The data type for the imported load.

5. Component: The vector component (X, Y, Z).

6. Complex Component: The real/imaginary component for complex loads.

7. Shell Face: Top/Bottom for loads applied to shells.

Note

• File Identifier* property is only available for data imported through the External Data system.

• The source mesh referenced by the File Identifier property must provide node locations in order
for the application to be able to perform a validation.

Release 2020 R1 - © ANSYS, Inc.


1899
Data Transfer Mapping and Validation

• Properties 2-6 are not available for data imported through the External Data system. Instead
the validation information is displayed for the variable identified using the File Identifier property.

Settings
Within the Settings category, the Type of validation must be specified by selecting Reverse Validation,
Distance Based Average Comparison, or Source Value:

• Reverse Validation. Reverse Validation takes the results of the imported data (based on the File Identifier)
and maps these values back onto the source points. These newly mapped values are compared to the source
variables original values.

• Distance Based Average Comparison. Distance Based Average Comparison compares the results from
the parent (based on the File Identifier) to mapped results obtained by using the distance-based average
algorithm. Distance-based mapping will be done using the Number of Points specified. The output
graphics will be displayed at the nodal locations of the target mesh.

• Source Value. Source Value displays the selected File Identifier data values. With the Display In Parent
turned On and the parent of the validation tree node item selected, the interpolated values calculated on
the target mesh can easily be compared to the original source point values.

• Undefined Points. Undefined Points displays the nodes which do not have an associated value based on
the selected File Identifier.

Note

The Reverse Validation and Distance Based Average Comparison options are not available
when validating Imported Trace.

The Output Type can be set to Absolute or Relative Difference (default). For Relative Difference, the
percent error is calculated and any values that are above 0.01% will be displayed in the graphics window.
For Absolute Difference, any non-zero difference will be displayed. The Minimum and Maximum
values will be displayed in the Statistics category of the details view. Subsets of the full set for either
relative or absolute differences can be shown by adjusting the Display Minimum and Display Maximum
fields. These fields must be within the Maximum and Minimum range defined within the Statistics
category.

Graphics Controls
There are multiple display options available: Scaled Spheres, Colored Spheres, Colored Diamonds,
Colored Points, Contours, and Isolines. Colored Spheres and Scaled Spheres consume more memory
and take longer to display on the screen due to the number of sides being drawn for each sphere.
Colored Diamonds consume less memory and time, and Colored Points use the least amount. Contours
and Isolines option will only be available when source mesh element connectivity is provided. Use Ex-
ternal Data with an Mechanical APDL .cdb formatted file containing elements. All displays will be
based on the range entered in the Display Minimum/Display Maximum fields. Display items that are
colored will have a discrete legend displayed based on the Display Minimum and Display Maximum,
divided equally into ranges. Scaled Spheres, Colored Spheres, and Colored Diamonds can be scaled
based on the Scale field value.

Release 2020 R1 - © ANSYS, Inc.


1900
Mapping Validation

If the Display option is set to Isolines, a Line Thickness option will be available to control how the
isolines are drawn. This setting will be respected when drawing isolines on the parent object when
Display In Parent is On.

If the Display In Parent property is set to On, the validation data will also be displayed when the parent
object is selected. The validation data that is displayed in the parent object respects the Active Row
and, if available, the Data/Component option selected in the details pane of the Imported Load object.

• If the Component property in the details pane of the Imported Load object is set to All or Total, the displayed
data represents the vector magnitude of the validation results corresponding to the source identifiers defined
in the worksheet of the active row.

• If the Component property is set to X, Y or Z component for vectors, the displayed data represents the
validation results in the global X, Y or Z directions for the source identifiers defined in the worksheet of the
active row.

• If the Component property is set to XX/YY/ZZ/XY/YZ/ZX component for tensors, the displayed data represents
the validation results in the global coordinate system for the source identifiers defined in the worksheet
of the active row.

• If the Data property is set to Temperature or Convection Coefficient, the displayed data represents the
validation result for the corresponding source identifier selected in the worksheet of the active row.

Legend Divisions control how many contour colors to use and must be within the range from 3 to 14.

Statistics
The Maximum and Minimum read-only fields show the full range of available results from the validation.
Number Of Items shows how many items are currently being displayed in the graphics window. This
number is based on the Display Minimum and Display Maximum values.

Once a validation has been performed, the data can be exported to a file by simply right-clicking the
Validation object and selecting Export.

Release 2020 R1 - © ANSYS, Inc.


1901
Release 2020 R1 - © ANSYS, Inc.
1902
Appendix C.Workbench Mechanical Wizard Advanced Programming
Topics
This appendix examines programming techniques and provides a reference for customizing the Mech-
anical Wizard.

Topics
Overview (p. 1903)
URI Address and Path Considerations (p. 1904)
Using Strings and Languages (p. 1905)
Guidelines for Editing XML Files (p. 1906)
About the TaskML Merge Process (p. 1906)
Using the Integrated Wizard Development Kit (WDK) (p. 1907)
Using IFRAME Elements (p. 1907)
TaskML Reference (p. 1908)
Standard Object Groups Reference (p. 1939)
Tutorials (p. 1942)
Wizard Development Kit (WDK) Groups (p. 1952)

Overview
From a programming perspective, the Mechanical Wizard system is best described as a "task browser."
As a "web browser" used to view and navigate pages on the Internet, a task browser is used to view
and navigate tasks in an engineering system. A web browser accesses HTML files and resources on a
network; a task browser accesses TaskML files and resources on a network.

TaskML is an XML vocabulary that defines the rules and data necessary to display and process pages
of tasks in the Mechanical application. Like HTML, TaskML allows for general scripting and for inserting
arbitrary HTML content and user interface controls. Basic wizard customization using TaskML is similar
to working with HTML and requires only a text editor.

The Mechanical Wizard runs as a web application (specifically, a dynamic HTML page) inside of a web
browser control (Microsoft Internet Explorer). The web browser control is hosted by the Mechanical
application. Consequently, the Mechanical Wizard system has full access to the capabilities of the web
browser and the Mechanical application. Development of the Mechanical Wizard involves use of the
HTML, CSS, XML, JScript web standards, and, for access to and automation of the application, use of
the Mechanical application object model. The Mechanical Wizard displays tasks organized into groups.
A task displays a caption and a status or descriptive icon. Activating a task (by clicking) typically involves
automatic navigation to a particular context and selection in the user interface and display of a "callout"
with a text message pointing to a specific control. Custom tasks may perform any operation via TaskML
elements or scripting.

The Mechanical Wizard responds to events that occur in the Mechanical application. Adding a load is
an example of an event. When such an event occurs, each task is given the opportunity to determine
its status or take an action.

Release 2020 R1 - © ANSYS, Inc.


1903
Workbench Mechanical Wizard Advanced Programming Topics

The user may open a TaskML file inside the Mechanical Wizard from their local disk or from a network
location. Therefore, saving TaskML to a network server makes custom wizard definitions available to
any user with access to the server. Additionally, the Mechanical Wizard system itself may be run by any
number of clients from a network location.

TaskML, along with HTML and scripting, offers an efficient and powerful means of extending the
Mechanical application user interface.

URI Address and Path Considerations


The Merge (p. 1910), Script (p. 1910), task (p. 1916), set-icon (p. 1937), open-url (p. 1931), display-help-topic (p. 1928)
and iframe (p. 1919) TaskML elements use URIs to link together files to form a complete wizard definition.
TaskML supports the following URI formats.

Note

Standard network security conditions apply to these URIs. As a general rule, if a user cannot
open a linked file in their web browser, the file cannot be accessed by the Mechanical Wizard.

Local Machine and LAN


C:\folder\Wizard.xml

M:\folder\Wizard.xml

\\server\share\Wizard.xml

Standard Protocols
http://webserver/share/Wizard.xml

ftp://ftp.webserver.com/pub/Wizard.xml

file:///C:/folder/Wizard.xml

SIMWIZ Protocol
The SIMWIZ protocol supports paths relative to the location of the Mechanical Wizard (specifically, rel-
ative to the location of the file Default.htm in the Mechanical Wizard folder). The SIMWIZ protocol allows
custom TaskML files published to any arbitrary location to reuse standard TaskML files and other com-
ponents of the system.
simwiz://Tasks/StandardTasks.xml

Relative Paths
All relative paths are relative to the location of the file containing the link. Note that this behavior is
different from version 6.0, in which relative links were relative to the location of the Mechanical Wizard.
folder/Wizard.xml

./folder/Wizard.xml

../folder/Wizard.xml

/rootfolder/Wizard.xml

Release 2020 R1 - © ANSYS, Inc.


1904
Using Strings and Languages

Using Strings and Languages


The Mechanical Wizard obtains all strings from TaskML. The language-related section of the TaskML
uses the following structure:
<strings>
<language xml:lang="language-code">
<string id="String_ID">Sample Text</string>
</language>
</strings>

The Mechanical Wizard determines which strings to use by matching the Language setting in the Wizard
page of the Control Panel to the xml:lang attribute of a language element. If no language element
with a matching xml:lang attribute exists, or if no string element with the necessary ID exists, the
Mechanical Wizard takes the string from the language element with the xml:lang attribute set to "en-
us" (English, United States). If the default English string doesn't exist, the Mechanical Wizard takes the
first string with a matching ID or displays the string ID in place of the text.

Recommended Localization Process


This process describes how to localize all strings in a TaskML file:

1. Open the TaskML file in a text editor.

2. Copy the section of the file from:


<language xml:lang="en-us">

to
</language>

3. Paste the copy into the<string> element below the last <language> close tag.

4. Change the language code from en-us to the code appropriate for the localization.

5. Localize each <string> element within the new <language> element. String IDs must remain unchanged.

6. Test the new language by entering the language code in the Language setting in the Wizard page of the
Control Panel.

English Customization Process


This process describes how to customize individual English strings with specific information or termin-
ology:

1. Create a new <language xml:lang="x-foo"> element at the bottom of the <string> element below the
last </language> close tag. Set the xml:lang attribute to an arbitrary “x-code” descriptive of the custom-
ization (no spaces).

2. Copy individual <string> elements to customize from the < language xml: lang="en-us"> element to
the new <language xml: lang="x-foo"> element. Strings omitted from the new <language> element
will be obtained from the <language xml: lang="en-us"> element.

3. Customize the strings. String IDs must remain unchanged.

Release 2020 R1 - © ANSYS, Inc.


1905
Workbench Mechanical Wizard Advanced Programming Topics

4. Test the customized strings by entering the x-code in the Language setting in the Wizard page of the
Control Panel.

Guidelines for Editing XML Files


TaskML is an XML vocabulary. As such, TaskML consists of Unicode (wide character) text files that must
follow the standard XML rules for well-formedness. When editing a TaskML file, use caution to ensure
that the XML remains well-formed. For example, omitting a close tag will cause an error and may prevent
the wizard from loading. To test for well-formedness, open the file in Internet Explorer 5 or later.

Note

• XML is case-sensitive. All TaskML tags are lower-case.

• Attribute values must be in quotes.

• Use only the five predefined XML entity references for special characters if needed: & (&amp;),
< (&lt;) > (&gt;) " (&quot;) ' (&apo;).

• White space (new lines, tabs, etc) is generally discarded. However, within a string element extra
white space may result in multiple spaces between words. At this release there is no way to insert
a line break within a string element.

• string elements contain only text; string (p. 1915) elements may not contain any XML or HTML
elements.

• XML comments are allowed.

About the TaskML Merge Process


The merge process facilitates reuse of wizard components from local or network locations.

The merge process is the first step in loading TaskML into the Mechanical Wizard. The process involves
selectively copying information from a merged TaskML document into a parent TaskML document. The
parent document includes a Merge (p. 1910) element linking to the merged file. The merge process
generates a composite TaskML document in memory; neither the parent or merged TaskML files are
modified.

The merge process consists of the following steps:

1. If the merged TaskML document contains Merge (p. 1910) elements, this process is called recursively. That
is, a TaskML document may merge a file that merges a file, and so on.

2. Script (p. 1910) elements are copied to the parent only if the src attribute is unique.

3. object-group (p. 1911) elements are copied to the parent only if the merged object-group has a unique
name attribute.

4. status (p. 1913) elements are copied to the parent only if the merged status has a unique id.

5. language (p. 1914) collections (and contained string elements) are copied only if the language has a unique
xml:lang attribute.

Release 2020 R1 - © ANSYS, Inc.


1906
Using IFRAME Elements

6. string (p. 1915) elements are copied only if the merged string has a unique id.

7. task (p. 1916) elements are copied only if the merged task has a unique id.

8. If both the parent and the merged TaskML documents contain a group (p. 1918) with the same id:

• Attributes defined for the merged group but omitted in the parent group are copied to the parent
group.

• All children of the merged group are appended to the parent group.

For diagnostic purposes the merge process automatically adds a merged-from attribute to elements
added to the parent TaskML file. The merged-from attribute contains the url of the TaskML file from
which the element was obtained.

Using the Integrated Wizard Development Kit (WDK)


The Mechanical Wizard system includes an integrated toolkit to assist in customizing wizards.

The following topics describe the tools:

• WDK: Tools Group (p. 1952)

• WDK: Commands Group (p. 1953)

• WDK Tests: Actions (p. 1954)

• WDK Tests: Flags (Conditions) (p. 1954)

To enable the toolkit:

• In the Mechanical application, select Tools>Options.

• Select Wizard and set Enable WDK Tools to yes.

Enabling the WDK toolkit adds four groups to the bottom of every panel displayed in the Mechanical
Wizard. The WDK toolkit does not change the behavior of other groups in the panel.

Using IFRAME Elements


An IFRAME (inline frame) functions as an HTML document within a Mechanical Wizard group. An IFRAME
may contain any content, from static text to detailed user interface controls. IFRAMEs have full script
access to the Mechanical Wizard, and therefore full access to the Mechanical application.

The Options group in the Insert Geometry panel demonstrates a simple user interface extension using
an IFRAME. Other examples of IFRAME usage in the Mechanical application include the WDK: Tools (p. 1952)
group and "Tip of the Day."

IFRAMEs in the Mechanical Wizard provide a way to customize the Mechanical application without
modifying the main user interface. IFRAMEs may be published on a network, enabling customized user
interfaces for multiple users without requiring changes to each installation.

Working with IFRAMEs requires familiarity with HTML and JScript coding. See also Tutorial: Adding a
Web Search IFRAME (p. 1946).

Release 2020 R1 - © ANSYS, Inc.


1907
Workbench Mechanical Wizard Advanced Programming Topics

Security Restrictions
Due to the cross-frame scripting security model enforced by the web browser control, custom IFRAME
HTML pages should reside in the same location as the Mechanical Wizard. IFRAME pages from a different
domain as the parent page cannot access the parent via script.

IFRAME Toolkit
The WDK includes the following resources for developing IFRAMEs:

• The file MechanicalWizard\WDK\Info_IFRAME.htm contains a template HTML document for an


IFRAME. View the source for descriptions of recommended HTML elements and JScript functions.

• The file MechanicalWizard\System\IFrame.js implements generic functions for use in IFRAMEs.

The following files demonstrate use of IFRAMEs:

• MechanicalWizard\WDK\Tools_IFrame.htm contains implementation for the WDK: Tools (p. 1952)


IFRAME. See MechanicalWizard\WDK\Tools_Merge.xml for corresponding TaskML.

• MechanicalWizard\Panels\InsertGeometry_IFrame.htm contains implementation for the Insert


Geometry panel Options group. See MechanicalWizard\Panels\InsertGeometry.xml for corres-
ponding TaskML.

• MechanicalWizard\TipoftheDay\IFrame.htm contains implementation for Tip of the Day. See


MechanicalWizard\Panels\Startup.xml for corresponding TaskML.

TaskML Reference
This reference describes each element defined in TaskML. See XML Notes (p. 1906) for general usage
guidelines.

The Overview Map (p. 1908) contains a diagram showing the basic structure of TaskML.

• Document Element (p. 1909)

• External References (p. 1910)

• Object Grouping (p. 1911)

• Status Definitions (p. 1912)

• Language and Text (p. 1914)

• Tasks and Events (p. 1915)

• Wizard Content (p. 1917)

• Rules (p. 1920)

• Scripting (p. 1938)

Overview Map of TaskML


The following illustrates the basic hierarchical structure of TaskML.

Release 2020 R1 - © ANSYS, Inc.


1908
TaskML Reference

• simulation-wizard (p. 1909) document element

– Merge (p. 1910) elements

– Script (p. 1910) elements

– object-groups (p. 1911) collection

– statuses (p. 1913) collection

– strings (p. 1915) collection

– tasks (p. 1917) collection

→ task (p. 1916) elements

• update-event (p. 1917) element

– Rules (p. 1920) sequence

• activate-event (p. 1915) element

– Rules (p. 1920) sequence

– body (p. 1918) element

→ group (p. 1918) elements

• taskref (p. 1919) elements

• iframe (p. 1919) elements

• eval (p. 1938) statements

→ eval (p. 1938) statements

Document Element
• simulation-wizard (p. 1909)

simulation-wizard
Identifies the start of a TaskML file.
<simulation-wizard
version="1.0">

Attributes
version

Specifies the version of the TaskML vocabulary. The current version is "1.0."

Element Information

Parents None. This is the document element (root) of the XML structure.

Release 2020 R1 - © ANSYS, Inc.


1909
Workbench Mechanical Wizard Advanced Programming Topics

Children Merge (p. 1910), Script (p. 1910), object-groups (p. 1911), statuses (p. 1913), strings (p. 1915), tasks (p. 1917),
body (p. 1918)
End Required
Tag

External References
• Merge (p. 1910)

• Script (p. 1910)

Merge
Merges an external TaskML file.
<merge
src="url" />

Attributes

src

Specifies the URL of the TaskML file to merge.

Table 108: Element Information

Parents simulation-wizard (p. 1909)


Children None
End No - close element with
Tag "/>"

See Also
About the TaskML Merge Process (p. 1906) and URI Address and Path Considerations (p. 1904).

Script
Specifies an external JScript file to load into the Mechanical Wizard.
<merge
src="url" />

Attributes

src

Specifies the URL of the JScript file to load.

Remarks

• JScript files use the .js file extension.

• Code in the JScript file outside of any function is evaluated immediately upon loading.

Release 2020 R1 - © ANSYS, Inc.


1910
TaskML Reference

• The eval element may directly call functions defined in the JScript file.

Table 109: Element Information

Parents simulation-wizard (p. 1909)


Children None
End No - close element with
Tag "/>"

See Also
URI Address and Path Considerations (p. 1904).

Object Grouping
• object-group (p. 1911)

• object-groups (p. 1911)

• object-type (p. 1912)

object-group
Organizes objects by placing them in an assigned group.
<object-group
name="group_name">

Attributes
name

Specifies the name of the group.

Element Information

Parents object-groups (p. 1911)


Children object-type (p. 1912)
End Required
Tag

See Also
object (p. 1925), select-first-object (p. 1933), select-all-objects (p. 1932), Standard Object Groups Refer-
ence (p. 1939).

object-groups
Contains an unordered collection of object group definitions.
<object-groups>

Release 2020 R1 - © ANSYS, Inc.


1911
Workbench Mechanical Wizard Advanced Programming Topics

Element Information

Parents simulation-wizard (p. 1909)


Children object-group (p. 1911)
End Required
Tag

See Also
Standard Object Groups Reference (p. 1939).

object-type
Specifies an Outline object by its internal identifiers.
<object-type
class="id_Constant"
type="id_Constant" />

Attributes
class

Identifies the class ID constant.

type

Identifies the type ID constant. Applies only for a class of "id_Load" or "id_Result."

Remarks
ID constants are defined in the script file DSConstants.js.

The class attribute corresponds to the "Class" property of the Mechanical application objects.

The type attribute corresponds the "loadType" or "ResultType" property of specific the Mechanical ap-
plication objects.

Element Information

Parents object-group (p. 1911)


Children None
End No - close element with
Tag "/>"

See Also
Standard Object Groups Reference (p. 1939).

Status Definitions
• status (p. 1913)

Release 2020 R1 - © ANSYS, Inc.


1912
TaskML Reference

• statuses (p. 1913)

status
Defines a task status.
<status
id="statusID"
css-class="status-class"
tooltip="statusID_Tooltip" />

Attributes
id

Unique identifier for the status.

css-class

Specifies the class in the skin (cascading style sheet) to apply to the task. The style class defines the
visual appearance of task status.

tooltip

Optional. Specifies the string ID of text to display in a tooltip when the cursor hovers over the task.
Defaults to "statusID_Tooltip."

Element Information

Parents statuses (p. 1913)


Children None
End No - close element with
Tag "/>"

See Also
set-status (p. 1937).

statuses
Contains an unordered collection of status definitions.
<statuses>

Element Information

Parents simulation-wizard (p. 1909)


Children status (p. 1913)
End Required
Tag

See Also
set-status (p. 1937).

Release 2020 R1 - © ANSYS, Inc.


1913
Workbench Mechanical Wizard Advanced Programming Topics

Language and Text


• data (p. 1914)

• language (p. 1914)

• string (p. 1915)

• strings (p. 1915)

data
Data placeholder within a string.
<string id="stringID">string text<data />string text</string>

Remarks
Used only with the Lookup method on a Strings object as defined in StringLookupObject.js. Allows
JScript functions to retrieve a localized string containing arbitrary data.

Element Information

Parents string (p. 1915)


Children None
End No - close element with
Tag "/>"

language
Contains an unordered collection of strings in a specified language.
<language
[xml:lang="en us"]>

Attributes
xml:lang

Specifies the language code. Defaults to "en-us" (English, United States).

Remarks
The language code corresponds to the Language setting in the Wizard page of the Control Panel.

Element Information

Parents strings (p. 1915)


Children string (p. 1915)
End Required
Tag

Release 2020 R1 - © ANSYS, Inc.


1914
TaskML Reference

string
Specifies the text for a given string ID.
<string
id="stringID">string text</string>

Attributes
id

Unique identifier assigned to the string.

Element Information

Parents language (p. 1914)


Children data (p. 1914)
End Required
Tag

strings
Contains an unordered collection of languages.
<strings>

Element Information

Parents simulation-wizard (p. 1909)


Children language (p. 1914)
End Required
Tag

Tasks and Events


• activate-event (p. 1915)

• task (p. 1916)

• tasks (p. 1917)

• update-event (p. 1917)

activate-event
Contains a sequence of rules to process when the user clicks on a task.
<activate-event
tab="{design | print | report | help | any}">

Attributes
tab

Release 2020 R1 - © ANSYS, Inc.


1915
Workbench Mechanical Wizard Advanced Programming Topics

Optional. Selects a specific tab before processing the activate event rules.

design Selects the Design View tab. Default behavior if attribute omitted.
print Selects the Print Preview tab.
report Selects the Report Preview tab.
help Selects the Quick Help tab.
any Does not change tab selection.

Element Information

Parents task (p. 1916)


Children if (p. 1921), set-icon (p. 1937), set-caption (p. 1936), set-status (p. 1937), select-first-object (p. 1933),
select-all-objects (p. 1932), select-field (p. 1933), select-first-undefined-field (p. 1935),
select-first-parameter-field (p. 1934), select-zero-thickness-sheets (p. 1935), click-button (p. 1927),
display-task-callout (p. 1930), display-outline-callout (p. 1929), display-details-callout (p. 1928),
display-toolbar-callout (p. 1931), display-tab-callout (p. 1930), display-status-callout (p. 1929),
open-url (p. 1931), display-help-topic (p. 1928), send-mail (p. 1936), eval (p. 1938), update (p. 1923),
debug (p. 1921)
End Required
Tag

task
Defines a task.
<task
id="uniqueID"
caption="uniqueID_Caption"
tooltip="uniqueID_Tooltip"
disable-if-missing="group_name"
hide-if-missing="group_name"
check-ambiguity="{model | environment | solution}"
icon="url"
deemphasize="{yes | no}">

Table 110: Attributes

Attribute Description
id Arbitrary unique identifier assigned to the task.
caption Optional. Specifies the string ID of the text to display in the task caption. Defaults to
"uniqueID_Caption" if not specified.
tooltip Optional. Specifies the string ID of the text to display in the task tooltip. Defaults to
"uniqueID_Toolip" if not specified.
disable-if-missing Optional. Disables the task if an object matching the group name does not exist.
hide-if-missing Optional. Hides the task if an object matching the group name does not exist.
check-ambiguity Optional. Automatically tests for ambiguity of an outline level prior to processing event
rules.
icon Optional. Specifies the URI of an image to use as the task icon. See URI Address and
Path Considerations.

Release 2020 R1 - © ANSYS, Inc.


1916
TaskML Reference

Attribute Description
deemphasize Optional. Causes a task inside an emphasized group to render with a deemphasized
style.

Table 111: Element Information

Parents tasks (p. 1917)


Children update-event (p. 1917),
activate-event (p. 1915)
End Required
Tag

Also See: taskref

tasks
Contains an unordered collection of task definitions.
<tasks>

Element Information

Parents simulation-wizard (p. 1909)


Children task (p. 1916)
End Required
Tag

update-event
Contains a sequence of rules to process when the user navigates or modifies information in the Mech-
anical application.
<update-event>

Element Information

Parents task (p. 1916)


Children if (p. 1921), set-icon (p. 1937), set-caption (p. 1936), set-status (p. 1937), select-first-object (p. 1933),
select-all-objects (p. 1932), select-field (p. 1933), select-first-undefined-field (p. 1935),
select-first-parameter-field (p. 1934), select-zero-thickness-sheets (p. 1935), click-button (p. 1927),
display-task-callout (p. 1930), display-outline-callout (p. 1929), display-details-callout (p. 1928),
display-toolbar-callout (p. 1931), display-tab-callout (p. 1930), display-status-callout (p. 1929),
open-url (p. 1931), display-help-topic (p. 1928), send-mail (p. 1936), eval (p. 1938), debug (p. 1921)
End Required
Tag

Wizard Content
• body (p. 1918)

• group (p. 1918)

Release 2020 R1 - © ANSYS, Inc.


1917
Workbench Mechanical Wizard Advanced Programming Topics

• iframe (p. 1919)

• taskref (p. 1919)

body
Specifies content to display inside the Mechanical Wizard.
<body title="stringID">

Attribute
title

Optional. Specifies the string ID of text to display in the title of the panel containing the Mechanical
Wizard. Defaults to the text "Mechanical Wizard."

Element Information

Parents simulation-wizard (p. 1909)


Children group (p. 1918),
eval (p. 1938)
End Required
Tag

group
Defines a collapsible group of tasks or iframes.
<group
id="uniqueID"
caption="uniqueID_Caption"
description="uniqueID_Description"
emphasize="{yes | no}"
collapsed="{yes | no}"
onupdate="foo()">

Attributes
id

Arbitrary unique identifier assigned to the group.

caption

Optional. Specifies the string ID of the text to display in the group caption. Defaults to "uniqueID_Caption"
if not specified.

description

Optional. Specifies the string ID for a brief paragraph to display at the top of the group. Defaults to
"uniqueID_Description" if not specified. If the string ID is undefined the group contains no description.

emphasize

Optional. Emphasizes the group via different visual styles. Defaults to "no."

Release 2020 R1 - © ANSYS, Inc.


1918
TaskML Reference

collapsed

Optional. Initially displays the group collapsed. After first use the collapsed status of each group is
persisted. Defaults to "no."

onupdate

Optional. JScript expression to evaluate on the Update event prior to processing the update-event (p. 1917)
rules for tasks the group contains.

Element Information

Parents body (p. 1918)


Children taskref (p. 1919), iframe (p. 1919),
eval (p. 1938)
End Required
Tag

iframe
Inserts an HTML IFRAME element within a group. The IFRAME may contain any arbitrary web page and
may communicate with the Mechanical Wizard via script.
<iframe
src="uri" />

Attributes

src

Specifies the URI of the web page to load into the IFRAME. See the topic on IFRAME Elements for notes
on security restrictions.

Table 112: Element Information

Parents group
Children None
End No - close element with
Tag "/>"

See Also
Using IFRAME Elements (p. 1907).

taskref
Inserts a task into a group.
<taskref
task="uniqueID" />

Attributes
task

Release 2020 R1 - © ANSYS, Inc.


1919
Workbench Mechanical Wizard Advanced Programming Topics

Specifies the ID of a task defined elsewhere in the merged TaskML file.

Element Information

Parents group (p. 1918)


Children None
End No - close element with
Tag "/>"

See Also
task (p. 1916).

Rules
• Statements (p. 1920)

• Conditions (p. 1923)

• Actions (p. 1926)

Statements
• and (p. 1920)

• debug (p. 1921)

• if then else stop (p. 1921)

• not (p. 1922)

• or (p. 1922)

• update (p. 1923)

and
Performs a logical conjunction on two conditions. Equivalent to the JScript && operator.
condition1 <and> condition2 </and>

Element Information

Parents if (p. 1921)


Children Conditions: level (p. 1924), object (p. 1925), changeable-length-unit (p. 1923),
assembly-geometry (p. 1923), geometry-includes-sheets (p. 1924), zero-thickness-sheet (p. 1926)
Actions: select-first-object (p. 1933), select-all-objects (p. 1932), select-field (p. 1933),
select-first-undefined-field (p. 1935), select-first-parameter-field (p. 1934),
select-zero-thickness-sheets (p. 1935), eval (p. 1938)
End Required
Tag

Release 2020 R1 - © ANSYS, Inc.


1920
TaskML Reference

debug
Attempts to launch a script debugger to debug the JScript code corresponding to the rules in the current
event. Equivalent to the JScript debugger keyword.
<debug />

Element Information

Parents update-event (p. 1917), activate-event (p. 1915), then (p. 1921), else (p. 1921)
Children None
End No - close element with "/>"
Tag

if then else stop


Conditionally processes a sequence of rules, depending on the value of a condition.
<if> condition
<then>
rules
<stop/>
</then>
<else>
rules
<stop/>
</else>
</if>

Remarks

eval (p. 1938) statement. The not (p. 1922) operator negates the value of a condition. The and (p. 1920) and
or (p. 1922) operators perform logical operations on two conditions within an if statement.

The then statement contains a sequence of rules to process when the resolved value of the condition
is true. An if statement must contain one then statement.

The else statement contains a sequence of rules to process when the resolved value of the condition
is false. The else statement is optional. If used it must follow the close of the then statement.

The if...then...else structure is equivalent to the if...else statement in JScript:


if( condition )
{ statements }
else { statements }

The stop statement ends processing of an event at a specific point. If a stop statement is not included
within a then or else statement, rules following the if statement are processed. The stop statement is
equivalent to the JScript return statement.

Element Information for <if>

Parents update-event (p. 1917) and activate-event (p. 1915)


Children Operators: and (p. 1920), or (p. 1922), not (p. 1922) Conditions: level (p. 1924), object (p. 1925),
changeable-length-unit (p. 1923), assembly-geometry (p. 1923), geometry-includes-sheets (p. 1924),
zero-thickness-sheet (p. 1926) Actions: select-first-object (p. 1933), select-all-objects (p. 1932),

Release 2020 R1 - © ANSYS, Inc.


1921
Workbench Mechanical Wizard Advanced Programming Topics

select-field (p. 1933), select-first-undefined-field (p. 1935), select-first-parameter-field (p. 1934),


select-zero-thickness-sheets (p. 1935), eval (p. 1938)

Element Information for <then> and <else>

Parents if (p. 1921)


Children set-icon (p. 1937), set-caption (p. 1936), status (p. 1913), select-first-object (p. 1933),
select-all-objects (p. 1932), select-field (p. 1933), select-first-undefined-field (p. 1935),
select-first-parameter-field (p. 1934), select-zero-thickness-sheets (p. 1935), click-button (p. 1927),
display-task-callout (p. 1930), display-outline-callout (p. 1929), display-details-callout (p. 1928),
display-toolbar-callout (p. 1931), display-tab-callout (p. 1930), display-status-callout (p. 1929),
open-url (p. 1931), display-help-topic (p. 1928), send-mail (p. 1936), eval (p. 1938), update (p. 1923),
debug (p. 1921)
End Required
Tag

not
Performs logical negation on a condition. Equivalent to the JScript ! operator.
<not> condition </not>

Element Information

Parents if (p. 1921)


Children Conditions: level (p. 1924), object (p. 1925), changeable-length-unit (p. 1923),
assembly-geometry (p. 1923), geometry-includes-sheets (p. 1924), zero-thickness-sheet (p. 1926)
Actions: select-first-object (p. 1933), select-all-objects (p. 1932), select-field (p. 1933),
select-first-undefined-field (p. 1935), select-first-parameter-field (p. 1934),
select-zero-thickness-sheets (p. 1935), eval (p. 1938)
End Required
Tag

or
Performs a logical disjunction on two conditions. Equivalent to the JScript || operator.
condition1 <or> condition2 </or>

Element Information

Parents if (p. 1921)


Children Conditions: level (p. 1924), object (p. 1925), changeable-length-unit (p. 1923),
assembly-geometry (p. 1923), geometry-includes-sheets (p. 1924), zero-thickness-sheet (p. 1926)
Actions: select-first-object (p. 1933), select-all-objects (p. 1932), select-field (p. 1933),
select-first-undefined-field (p. 1935), select-first-parameter-field (p. 1934),
select-zero-thickness-sheets (p. 1935), eval (p. 1938)
End Required
Tag

Release 2020 R1 - © ANSYS, Inc.


1922
TaskML Reference

update
Forces an Update event to fire. In general, this statement is necessary only if preceding rules in the
event cause the status of other tasks to become out of sync.
<update />

Element Information

Parents activate-event (p. 1915), then (p. 1921),


else (p. 1921)
Children None
End No - close element with "/>"
Tag

Conditions
• assembly-geometry (p. 1923)

• changeable-length-unit (p. 1923)

• geometry-includes-sheets (p. 1924)

• level (p. 1924)

• object (p. 1925)

• zero-thickness-sheet (p. 1926)

assembly-geometry
Tests if the geometry in context of the current selection contains an assembly or a single part.
<assembly-geometry />

Element Information

Parents if (p. 1921), and (p. 1920), or (p. 1922),


not (p. 1922)
Children None
End Tag No - close element with "/>"
Return True if the geometry contains an assembly.
Value

changeable-length-unit
Tests if the geometry in context of the current selection does not explicitly specify a length unit (e.g.
for ACIS geometry types). Useful in prompting the user to verify a correct length unit setting.
<changeable-length-unit />

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1923
Workbench Mechanical Wizard Advanced Programming Topics

Element Information

Parents if (p. 1921), and (p. 1920), or (p. 1922),


not (p. 1922)
Children None
End Tag No - close element with "/>"
Return True if the length unit is not read-only.
Value

geometry-includes-sheets
Tests if the geometry in context of the current selection contains sheet parts.
<geometry-includes-sheets />

Element Information

Parents if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922)
Children None
End Tag No - close element with "/>"
Return True if the geometry contains one or more sheets.
Value

level
Tests the level of the current selection in the Outline.
<level
type="{project | model | environment | solution}"
condition="{is-ambiguous | is-not-ambiguous | is-selected | is-not-selected}" />

Attributes

type

Identifies the level. A level consists of a container (e.g., the Environment) and all children excluding
other containers.

condition

Specifies a condition to test.

is-ambiguous Returns true if a specific container cannot be resolved given the current Outline
selection.
is-not-ambiguous Returns true if a specific container is identified given the current Outline selection.
is-selected Returns true if any object at the given level is currently selected.
is-not-selected Returns true if no object at the given level is currently selected.

Element Information

Parents if (p. 1921), and (p. 1920), or (p. 1922),


not (p. 1922)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1924 of ANSYS, Inc. and its subsidiaries and affiliates.
TaskML Reference

Children None
End Tag No - close element with "/>"
Return As defined by the condition attribute.
Value

object
Tests the Outline tree for an object matching the given criteria. Searches only non-ambiguous objects
given the current selection.
<object
type="group_name"
state="{any | stateless | fully-defined | under-defined | suppressed |
not-updated | updated | obsolete | error | bad-license}"
name-regexp="regular_expression"
condition="{exists | does-not-exist | is-selected | is-not-selected}" />

Note

It was necessary to “word wrap” the long line of code in the above example.

Attributes

type

Optional. Identifies an object group name or an object type constant as a search criteria. If omitted, the
object type is not considered.

Object groups are defined by using the object-group (p. 1911) element. Refer to the Standard Object
Groups Reference (p. 1939).

Type constants for specific objects (prefixed by "id_") are defined in the script file DSConstants.js.

state

Optional. Specifies an object state as a search criteria. If omitted, the default of "any" is used, meaning
that object state is not considered.

States are defined in the script file DSConstants.js.

name-regexp

Optional. Specifies a regular expression of an object's name as a search criteria. For example, "part"
matches any object that includes "part" in its name (e.g. "part 2"). If omitted, object names are not
considered. See the Microsoft Scripting site under JScript for a regular expressions reference.

condition

Specifies a condition to test.

exists Returns true if an object matching the criteria exists.


does-not-exist Returns true if no object matches the criteria.
is-selected Returns true if an object matching the criteria is currently selected.
is-not-selected Returns true if no object matching the criteria is currently selected.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1925
Workbench Mechanical Wizard Advanced Programming Topics

Element Information

Parents if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922)
Children None
End Tag No - close element with "/>"
Return True if an object matching the criteria meets the condition.
Value

zero-thickness-sheet
Tests if the geometry in context of the current selection contains any sheet with zero thickness specified.
Useful in prompting the user to enter valid information for sheet thickness.
<zero-thickness-sheet />

Element Information

Parents if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922)
Children None
End Tag No - close element with "/>"
Return True if any sheet has a zero thickness
Value value.

valid-emag-geometry
Tests if the geometry in context of the current selection meets the requirements for performing an
electromagnetic simulation.
<valid-emag-geometry />

enclosure-exists
Tests if the geometry in context of the current selection contains an enclosure body for electromagnetic
simulation.
<enclosure-exists />

Actions
• click-button (p. 1927)

• display-details-callout (p. 1928)

• display-help-topic (p. 1928)

• display-outline-callout (p. 1929)

• display-status-callout (p. 1929)

• display-tab-callout (p. 1930)

• display-task-callout (p. 1930)

• display-toolbar-callout (p. 1931)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1926 of ANSYS, Inc. and its subsidiaries and affiliates.
TaskML Reference

• open-url (p. 1931)

• select-all-objects (p. 1932)

• select-field (p. 1933)

• select-first-object (p. 1933)

• select-first-parameter-field (p. 1934)

• select-first-undefined-field (p. 1935)

• select-zero-thickness-sheets (p. 1935)

• send-mail (p. 1936)

• set-caption (p. 1936)

• set-icon (p. 1937)

• set-status (p. 1937)

click-button
Simulates a toolbar button click.
<click-button
toolbar="key"
button="key" />

Attributes

Use the WDK command View Current Toolbar Keys (p. 1952) to determine values for the attributes below.

toolbar

Specifies the key for the toolbar.

button

Specifies the key for the button.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if successful.
Value

See Also

display-toolbar-callout (p. 1931).

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1927
Workbench Mechanical Wizard Advanced Programming Topics

display-details-callout
Displays a callout pointing to the currently selected Details field.
<display-details-callout
message="stringID" />

Attributes

message

Specifies the string ID (p. 1915) of the text to display in the callout.

Remarks

Before using this action:

Use select-first-object (p. 1933) or select-all-objects (p. 1932) to select one or more Outline objects prior to
accessing the Details control.

Use select-field (p. 1933) to select a Details field.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if successful.
Value

display-help-topic
Displays a topic from a Windows HTML Help file.
<display-help-topic
href="uri"
topic="path" />

Attributes

href

Optional. Defines the URI of the CHM file. Defaults to simwiz://../HHelp/DesignSpace.chm,


the location of the ANSYS Workbench Help system relative to the standard Mechanical Wizard location.
NOTE: The default value no longer exists - Specify a valid help system path. See URI Address and Path
Considerations (p. 1904).

topic

Optional. Specifies an internal path to a desired topic.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1928 of ANSYS, Inc. and its subsidiaries and affiliates.
TaskML Reference

End Tag No - close element with "/>"


Return None
Value

display-outline-callout
Displays a callout pointing to the currently selected Outline object.
<display-outline-callout
message="stringID" />

Attributes

message

Specifies the string ID (p. 1915) of the text to display in the callout.

Remarks

Use select-first-object (p. 1933) or select-all-objects (p. 1932) to select one or more Outline objects prior to
displaying the callout.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if successful.
Value

display-status-callout
Displays a callout pointing to a status bar panel.
<display-status-callout
panel="index"
message="stringID" />

Attributes

panel

Specifies the index of the status bar panel. The index of the leftmost panel is 1.

message

Specifies the string ID (p. 1915) of the text to display in the callout.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1929
Workbench Mechanical Wizard Advanced Programming Topics

Return True if successful.


Value

display-tab-callout
Displays a callout pointing to a tab.
<display-tab-callout
tab="{design | print | report | help}"
message="stringID" />

Attributes

tab

One of the following keywords:

design Design View tab.


print Print Preview tab.
report Report Preview
tab.
help Quick Help tab.

message

Specifies the string ID (p. 1915) of the text to display in the callout.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if successful.
Value

display-task-callout
Displays a callout pointing to the task itself.
<display-task-callout
message="stringID" />

Attributes

message

Specifies the string ID (p. 1915) of the text to display in the callout.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1930 of ANSYS, Inc. and its subsidiaries and affiliates.
TaskML Reference

Return True if successful.


Value

display-toolbar-callout
Displays a callout pointing to a toolbar button.
<display-toolbar-callout
toolbar="key"
button="key"
message="stringID" />

Attributes

Use the WDK command View Current Toolbar Keys (p. 1952) to determine values for the toolbar and
button attributes below.

toolbar

Specifies the key for the toolbar.

button

Specifies the key for the button.

message

Specifies the string ID (p. 1915) of the text to display in the callout.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if successful.
Value

See Also

click-button (p. 1927).

open-url
Opens a new web browser window and navigates to a given URI (URL).
<open-url
href="uri" />

Attributes

href

Any valid URI. See URI Address and Path Considerations (p. 1904).

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1931
Workbench Mechanical Wizard Advanced Programming Topics

Element Information

Parents activate-event (p. 1915), then (p. 1921),


else (p. 1921)
Children None
End Tag No - close element with "/>"
Return None
Value

select-all-objects
Selects a set of objects based on given criteria. Searches only non-ambiguous objects given the initial
selection.
<select-all-objects
type="group_name"
state="{any | stateless | fully-defined | under-defined | suppressed |
not-updated | updated | obsolete | error | bad-license}"
name-regexp="regular_expression" />

Note

It was necessary to “word wrap” the long line of code in the above example.

Attributes

type

Optional. Identifies an object group name or an object type constant as a search criteria. If omitted, the
object type is not considered.

Object groups are defined by using the object-group (p. 1911) element. Refer to the Standard Object
Groups Reference (p. 1939).

Type constants for specific objects (prefixed by "id_") are defined in the script file DSConstants.js.

state

Optional. Specifies an object state as a search criteria. If omitted, the default of "any" is used, meaning
that object state is not considered.

States are defined in the script file DSConstants.js.

name-regexp

Optional. Specifies a regular expression of an object's name as a search criteria. For example, "part"
matches any object that includes "part" in its name (e.g. "part 2"). If omitted, object names are not
considered. See the Microsoft Scripting site under JScript for a regular expressions reference.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1932 of ANSYS, Inc. and its subsidiaries and affiliates.
TaskML Reference

End Tag No - close element with "/>"


Return True if one or more objects meeting the criteria were selected.
Value

See Also

select-first-object (p. 1933).

select-field
Selects a field in the Details control by name.
<select-field
name="stringID" />

Attributes

name

Specifies the string ID for name of the field. Use the Details Field String ID (p. 1952) section in the WDK
Tools group to determine the string ID of a field.

Remarks

Use select-first-object (p. 1933) or select-all-objects (p. 1932) to select one or more Outline objects prior to
accessing the Details control.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if one Details meeting the criteria was selected.
Value

See Also

select-first-parameter-field (p. 1934), select-first-undefined-field (p. 1935).

select-first-object
Selects the first object matching given criteria. Searches only non-ambiguous objects given the initial
selection.
<select-first-object
type="group_name"
state="{any | stateless | fully-defined | under-defined | suppressed |
not-updated | updated | obsolete | error | bad-license
}"
name-regexp="regular_expression" />

Note

It was necessary to “word wrap” the long line of code in the above example.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1933
Workbench Mechanical Wizard Advanced Programming Topics

Attributes

type

Optional. Identifies an object group name or an object type constant as a search criterion. If omitted,
the object type is not considered.

Object groups are defined by using the object-group (p. 1911) element. Refer to the Standard Object
Groups Reference (p. 1939).

Type constants for specific objects (prefixed by "id_") are defined in the script file DSConstants.js.

state

Optional. Specifies an object state as a search criteria. If omitted, the default of "any" is used, meaning
that object state is not considered.

States are defined in the script file DSConstants.js.

name-regexp

Optional. Specifies a regular expression of an object's name as a search criterion. For example, "part"
matches any object that includes "part" in its name (e.g., "part 2"). If omitted, object names are not
considered. See the Microsoft Scripting site under JScript for a regular expressions reference.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if one object meeting the criteria was selected.
Value

See Also

select-all-objects (p. 1932).

select-first-parameter-field
Selects the first parameter field in the Details control.
<select-first-parameter-field />

Remarks

Parameter fields contain a check box to the left of the name. If checked, the parameter field is exposed
for use in the Parameter Workspace.

Use select-first-object (p. 1933) or select-all-objects (p. 1932) to select one or more Outline objects prior to
accessing the Details control.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1934 of ANSYS, Inc. and its subsidiaries and affiliates.
TaskML Reference

Children None
End Tag No - close element with "/>"
Return True if one Details meeting the criteria was selected.
Value

See Also

select-field (p. 1933), select-first-undefined-field (p. 1935).

select-first-undefined-field
Selects the first undefined Details field.
<select-first-undefined-field />

Remarks

The Details control highlights undefined fields in yellow.

Use select-first-object (p. 1933) or select-all-objects (p. 1932) to select one or more Outline objects prior to
accessing the Details control.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if one Details meeting the criteria was selected.
Value

See Also

select-field (p. 1933), select-first-parameter-field (p. 1934).

select-zero-thickness-sheets
Selects all parts containing zero-thickness sheet geometry.
<select-zero-thickness-sheets />

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if one or more objects meeting the criteria were selected.
Value

select-enclosures
Selects any enclosure bodies in the current geometry.
<select-enclosures />

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1935
Workbench Mechanical Wizard Advanced Programming Topics

send-mail
Opens a new email and fills in envelope information and default text. Does not send the email.
<send-mail
to="addr;addr"
cc="addr;addr"
bcc="addr;addr"
subject="stringID"
body="stringID" />

Attributes

to

Semicolon-delimited list of email addresses.

cc

Optional. Semicolon-delimited list of email addresses.

bcc

Optional. Semicolon-delimited list of email addresses.

subject

Optional. Default subject line.

body

Optional. Default body text.

Element Information

Parents activate-event (p. 1915), then (p. 1921),


else (p. 1921)
Children None
End Tag No - close element with "/>"
Return None
Value

set-caption
Sets the caption of the task.
<set-caption
caption="stringID" />

Attributes

caption

Specifies the string ID (p. 1915) of the text.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1936 of ANSYS, Inc. and its subsidiaries and affiliates.
TaskML Reference

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if successful.
Value

See Also

task (p. 1916).

set-icon
Sets the task icon to an image at a given URL.
<set-icon
src="url" />

Attributes

src

Specifies the URI of the icon. See URI Address and Path Considerations (p. 1904).

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if successful.
Value

See Also

task (p. 1916).

set-status
Sets the status of the task.
<set-status
status="{non-status | incomplete | complete | information | undefined |
indeterminate | solve | obsolete | ambiguous | caution |
warning | disabled | hidden}" />

Note

It was necessary to “word wrap” the long line of code in the above example.

Attributes

status

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1937
Workbench Mechanical Wizard Advanced Programming Topics

A status keyword. Status keywords are defined by using the status (p. 1913) element.

Remarks

The element definition shown above lists the standard statuses. The TaskML file MechanicalWiz-
ard\Data\Statuses.xml defines the standard statuses and is merged automatically while loading
any wizard.

Element Information

Parents activate-event (p. 1915), if (p. 1921), and (p. 1920), or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921)
Children None
End Tag No - close element with "/>"
Return True if successful.
Value

Scripting
• eval (p. 1938)

eval
Evaluates a JScript expression.
<eval
code="expression" />

Attributes
code

A string of valid JScript code. For example, "foo()" evaluates the global function foo.

Remarks
Use the Script (p. 1910) element to make custom JScript available for use with the eval statement.

If the eval statement is a task rule, the expression is evaluated when the rule is processed as part of an
event. Using eval in this context allows:

• custom code to determine the status of a task

• the task to perform any arbitrary operation

The file MechanicalWizard\WDK\Tools_Merge.xml demonstrates use of the eval statement


to:

• Execute global functions defined in a script file referenced by a Script (p. 1910) element.

• Access the DOM to manipulate the DHTML page containing the wizard.

• Call methods on global objects to automate the Mechanical Wizard.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1938 of ANSYS, Inc. and its subsidiaries and affiliates.
Standard Object Groups Reference

If the eval statement exists inside of a body or group element, the expression evaluates at that point
in the generation of the wizard DHTML. Using eval in this context allows for programmatically gen-
erating wizard content. See Startup.xml, New.xml and InsertGeometry.xml in the
MechanicalWizard\Panels folder for examples. These examples call global functions defined
in the script file MechanicalWizard\System\PanelFunctions.js.

Complete coverage of scripting is beyond the present scope of this documentation. You may use the
source code as a reference and a script debugger for exploring variables and object models. The
following globally-available JScript objects are particularly useful:

• g_Wizard - the global Wizard object that controls the Mechanical Wizard. Defined in MechanicalWiz-
ard\System\WizardObject.js.

• g_Wizard.App - provides access to the key objects in the Mechanical application and ANSYS Workbench.
Defined in MechanicalWizard\System\AppObject.js.

• g_Wizard.App.Scripting - reference to the script block inside the Mechanical application.

• g_Wizard.GlobalStrings - a Strings object (StringLookupObject.js) containing generic strings defined


in MechanicalWizard\Data\GlobalStrings.xml.

• g_Wizard.Strings - a Strings object containing strings from the loaded TaskML document.

Element Information

Parents As an action or condition: activate-event (p. 1915), update-event (p. 1917), if (p. 1921), and (p. 1920),
or (p. 1922), not (p. 1922), then (p. 1921), else (p. 1921) For evaluation as the wizard loads:
body (p. 1918), group (p. 1918)
Children None
End Tag No - close element with "/>"
Return Return value of the expression or null.
Value

Standard Object Groups Reference


The following table lists standard object-group (p. 1911) names and the object-type (p. 1912) elements they
contain. The corresponding TaskML file is MechanicalWizard\Data\ObjectGroups.xml, and is
merged automatically while loading any wizard.

The elements object (p. 1925), select-first-object (p. 1933), and select-all-objects (p. 1932) use object groups.
TaskML files may include an object-groups (p. 1911) section to define custom object-group (p. 1911) elements
(for example, to identify a specific object such as pressure). See Tutorial: Creating a Custom Task (p. 1944)
for an example.

Class and Type correspond to constants defined in the script file DSConstants.js. Type corresponds
to the "loadType" or "ResultType" property of specific Mechanical application objects.

Group Name Class Type


project id_Project
model id_Model
environment id_Environment

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1939
Workbench Mechanical Wizard Advanced Programming Topics

Group Name Class Type


solution id_AnswerSet
geometry id_PrototypeGroup
part id_Prototype
contact id_ContactGroup
contact id_ContactRegion
region
mesh id_MeshControlGroup
mesh id_MeshControl
control
global load id_Acceleration
id_Rotation
load id_Load
structural id_Load id_SurfacePressure
load id_Load id_SurfaceForce
id_Load id_EdgeForce
id_Load id_VertexForce
id_Load id_CylinderBoltLoad
id_Load id_ForceAtAPoint
id_Load id_SurfaceMoment
id_Load id_SurfaceRotation
id_Load id_EdgeRotation
id_Load id_VertexRotation
id_Load id_EdgeMoment
id_Load id_VertexMoment
displacement id_Load id_SurfaceDisplacement
load id_Load id_EdgeDisplacement
id_Load id_VertexDisplacement
id_Load id_SurfaceSupport
id_Load id_FixedEdgeSupport
id_Load id_FixedVertexSupport
id_Load id_CylinderRadialSupport
id_Load id_CylinderRadialAndAxialSupport
id_Load id_SurfaceFrictionlessSupport
id_Load id_CylinderFixedSupport
id_Load id_CylinderPinnedSupport
id_Load id_SimpleEdgeSupport
id_Load id_SimpleVertexSupport
thermal id_Load id_SurfaceHeatFlux
load id_Load id_SurfaceTemperature

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1940 of ANSYS, Inc. and its subsidiaries and affiliates.
Standard Object Groups Reference

Group Name Class Type


id_Load id_EdgeTemperature
id_Load id_VertexTemperature
id_Load id_SurfaceConvection
id_Load id_SurfaceInsulation
id_Load id_SurfaceHeat
id_Load id_EdgeHeat
id_Load id_VertexHeat
id_Load id_InternalPartHeat
stress tool id_StressSafetyTool
stress tool id_Result id_StressSafetyMargin
result id_Result id_StressSafetyFactor
id_Result id_StressRatio
result id_Result
structural id_Result id_EquivalentStress
result id_Result id_MaximumPrincipalStress
id_Result id_IntermediatePrincipalStress
id_Result id_MinimumPrincipalStress
id_Result id_MaximumShearStress
id_Result id_StressIntensity
id_Result id_XComponentStress
id_Result id_YComponentStress
id_Result id_ZComponentStress
id_Result id_XYShearStress
id_Result id_YZShearStress
id_Result id_XZShearStress
id_Result id_EquivalentStrain
id_Result id_MaximumPrincipalStrain
id_Result id_IntermediatePrincipalStrain
id_Result id_MinimumPrincipalStrain
id_Result id_MaximumShearStrain
id_Result id_StrainIntensity
id_Result id_XComponentStrain
id_Result id_YComponentStrain
id_Result id_ZComponentStrain
id_Result id_XYShearStrain
id_Result id_YZShearStrain
id_Result id_XZShearStrain
id_Result id_TotalDisplacement

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1941
Workbench Mechanical Wizard Advanced Programming Topics

Group Name Class Type


id_Result id_XComponentDisplacement
id_Result id_YComponentDisplacement
id_Result id_ZComponentDisplacement
thermal id_Result id_Temperature
result id_Result id_TotalHeatFlux
id_Result id_XComponentHeatFlux
id_Result id_YComponentHeatFlux
id_Result id_ZComponentHeatFlux
id_Result id_MaximumPrincipalThermalStrain
id_Result id_IntermediatePrincipalThermalStrain
id_Result id_MinimumPrincipalThermalStrain
id_Result id_XComponentThermalStrain
id_Result id_YComponentThermalStrain
id_Result id_ZComponentThermalStrain
fatigue tool id_FatigueTool
fatigue id_Result id_FatigueLife
result id_Result id_FatigueSafetyFactor
id_Result id_FatigueDamage
id_Result id_FatigueBiaxialityIndication
id_Result id_FatigueRainflowMatrix
id_Result id_FatigueDamageMatrix
id_Result id_FatigueSensitivity
frequency id_Result id_Frequency

Tutorials
• Tutorial: Adding a Link (p. 1942)

• Tutorial: Creating a Custom Task (p. 1944)

• Tutorial: Creating a Custom Wizard (p. 1945)

• Tutorial: Adding a Web Search IFRAME (p. 1946)

Tutorial: Adding a Link


This tutorial covers the steps needed to add a custom link to the Links group. The Links group is available
in any of the standard wizards.

View (p. 1948) the completed TaskML file for this tutorial.

Steps
To add a link to the web site MatWeb:

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1942 of ANSYS, Inc. and its subsidiaries and affiliates.
Tutorials

Open the TaskML file MechanicalWizard\Tasks\Links.xml in a text editor such as Notepad.


All standard wizards Merge (p. 1910) the Links.xml file; changes made to this file automatically appear
in all standard wizards.

Create a new task (p. 1916) definition by adding the following to the tasks (p. 1917) section:
<tasks>
<task id="DesignSpaceHomePage" icon="simwiz://Icons/Link.gif">
<activate-event>
<open-url href="http://www.designspace.com" />
</activate-event>
</task>
<task id="DesignSpaceResources" icon="simwiz://Icons/Link.gif">
<activate-event>
<open-url href="http://www.designspace.com/designspace/user_support/" />
</activate-event>
</task>
<task id="MatWeb" icon="simwiz://Icons/Link.gif">
<activate-event>
<open-url href="http://www.matweb.com/" />
</activate-event>
</task>
</tasks>

The value for the id attribute is arbitrary.

Define a new string (p. 1915) by adding the following to the strings (p. 1915) section:
<strings>
<language xml:lang="en-us">
<string id="Standard_Links_Caption">
Links
</string>
<string id="DesignSpaceHomePage_Caption">
DesignSpace.com
</string>
<string id="DesignSpaceResources_Caption">
DesignSpace Resources
</string>
<string id="MatWeb_Caption">
MatWeb Materials
</string>
</language>
</strings>

The value for the string id uses the built-in naming convention of the task id and "_Caption" to simplify
the task element by omitting the caption attribute. The new string applies to the default language
code "en-us." To support other languages, define a new string inside each language (p. 1914) section.

Insert the new task into the Links group (p. 1918) by modifying the body (p. 1918) section as follows:
<body>
<group id="Standard_Links" collapsed="yes">
<taskref task="DesignSpaceHomePage" />
<taskref task="DesignSpaceResources" />
<taskref task="MatWeb" />
</group>
</body>

The task attribute matches the id of the task.

Save the file.

Open a wizard in the Mechanical application. The Links group will contain a new link to the MatWeb
website.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1943
Workbench Mechanical Wizard Advanced Programming Topics

Tutorial: Creating a Custom Task


This tutorial describes the steps needed to develop a custom task for inserting a 100 psi pressure load.
The tutorial for Creating a Custom Wizard (p. 1945) uses the task created below.

View (p. 1948) the completed TaskML file for this tutorial.

Steps
Copy the file MechanicalWizard\Tasks\InsertStructuralLoad.xml to a file named In-
sert100psi.xml in a different folder. Generally, the easiest way to create a custom task is to
modify a similar existing task instead of starting from scratch.

task (p. 1916) element as follows:


<task id="Insert100psi" disable-if-missing="geometry" check-ambiguity="environment">

The other attributes on the task element disable the task if the Outline contains no geometry and
prompts the user to select a particular Environment if the current selection is ambiguous.

Create an object-groups (p. 1911) section at the top of the file:


<simulation-wizard version="1.0">
<object-groups>
<object-group name="pressure">
<object-type class="id_Load" type="id_SurfacePressure" />
</object-group>
</object-groups>
...
</simulation-wizard>

This creates a custom object-group (p. 1911) named "pressure" that contains a single object-group (p. 1911)
corresponding to the Pressure object type in the Outline. This object group is available in addition to
the Standard Object Groups Reference (p. 1939) to wizards merging (p. 1910) this task.

Modify the strings (p. 1915) section as follows:


<strings>
<language xml:lang="en-us">
<string id="Insert100psi_Caption">
Insert Pressure
</string>
<string id="Insert100psi_Message">
Use the Structural button to insert a Pressure load.
Enter 100 psi for Magnitude.
</string>
</language>
</strings>

The value for the first string id uses the built-in naming convention of the task id and "_Caption" to
simplify the task element by omitting the caption attribute. The value for the second string id is arbitrary
and referenced by the display-details-callout action defined below. The strings apply to the default
language code "en-us." To support other languages, define new strings inside each language (p. 1914)
section.

Modify the update-event (p. 1917) as shown:


<update-event>
<if><object type="pressure" condition="does-not-exist"/>
<then>
<set-status status="incomplete"/>
<stop/>

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1944 of ANSYS, Inc. and its subsidiaries and affiliates.
Tutorials

</then>
</if>
<if><object type="pressure" condition="exists" state="under-defined"/>
<then>
<set-status status="undefined"/>
<stop/>
</then>
</if>
<set-status status="complete"/>
</update-event>

Modify the activate-event (p. 1915) as shown:


<activate-event>
<if><object type="pressure" condition="exists" state="under-defined"/>
<then>
<select-first-object type="pressure" state="under-defined"/>
<select-first-undefined-field/>
<display-details-callout message="Insert100psi_Message" />
<stop/>
</then>
</if>
<if><level type="environment" condition="is-not-selected"/>
<then>
<select-first-object type="environment"/>
</then>
</if>
<click-button toolbar="DS_graphics" button="Surface"/>
<display-toolbar-callout toolbar="Context" button="Structural"
message="Insert100psi_Message" />***
</activate-event>

Note

***Note that it was necessary to “word wrap” the long line of code in the above example.

The first if statement checks for an under-defined pressure. The second if statement ensures that the
Outline selection is at the Environment level so that the user can insert a Pressure. The click-button
action ensures that the surface selection mode is active.

Save the file.

Proceed to the tutorial Creating a Custom Wizard (p. 1945) to use this custom task.

Tutorial: Creating a Custom Wizard


This tutorial describes the steps needed to develop a custom wizard. Before proceeding, complete the
tutorial Creating a Custom Task (p. 1944).

View (p. 1949) the completed TaskML file for this tutorial.

Steps
Copy the file MechanicalWizard\StressWizard.xml to a file named CustomWizard.xml
in the same folder as the file Insert100psi.xml created in the previous tutorial.

Change "InsertStructuralLoad.xml" to "Insert100psi.xml" in the Merge (p. 1910) element:


<merge src="Insert100psi.xml" />

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1945
Workbench Mechanical Wizard Advanced Programming Topics

This merge makes the custom task definition available to this wizard. Note that the URI to the file
containing the task is relative to the location of the file containing the wizard. See URI Address and
Path Considerations (p. 1904).

Modify the strings (p. 1915) section as follows:


<strings>
<language xml:lang="en-us">
<string id="Title_Caption">
Tutorial Wizard
</string>
<string id="Title_Description">
Demonstrates a custom wizard with a task for inserting a 100 psi Pressure.
</string>
</language>
</strings>

Change "InsertStructuralLoad" to "Insert100psi" in the taskref (p. 1919) element:


<taskref task="Insert100psi"/>

This taskref adds the task (p. 1916) to the body (p. 1918) of the wizard by its id.

Save the file.

In the Mechanical application, click the Choose Wizard option from the top of a standard wizard.

Choose "browse for a custom wizard definition.".

Select the file CustomWizard.xml.

Test the Insert Pressure task. The task should behave in the same way as the standard Insert Loads task
but with specific instructions for defining a 100 psi pressure.

Tutorial: Adding a Web Search IFRAME


This tutorial describes the steps needed to add an Internet search capability to a wizard as an IFRAME.
This tutorial uses the wizard created in Tutorial: Creating a Custom Wizard (p. 1945). See Using IFRAME
Elements (p. 1907) for a discussion on IFRAMEs.

View the file Search.htm (p. 1950) or the modified TaskML file CustomWizard.xml (p. 1949).

Steps
Create a new text file with the following contents:
<html>
<head>
<script src="System/IFrame.js"></script>
<link ID="Skin" REL="stylesheet">
<script>
function IFrame_onload() { Skin.href = g_Wizard.GetSkin() }
</script>
<style>
INPUT { width: 100%; margin-bottom: 4px; }
</style>
</head>
<body scroll="no">
<center>
<form method="GET" action="http://www.google.com/search" target="_blank">
<a HREF="http://www.google.com/" target="_blank">
<img SRC="http://www.google.com/logos/Logo_40wht.gif" border="0" ALT="Google"
width="128" height="53"></a><br>

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1946 of ANSYS, Inc. and its subsidiaries and affiliates.
Tutorials

<input TYPE="text" name="q" size="25" maxlength="255" value><br>


<input type="submit" name="btnG" VALUE="Google Search">
</form>
</center>
</body>
</html>

Note

It was necessary to “word wrap” the long line of code in the above example.

Note

• The script file MechanicalWizard/System/IFrame.js contains generic functions for use


with IFRAMEs.

• The link element initially lacks a href element. The script block implements the IFRAME_onload
function (called by IFrame.js) and sets href to the url returned by the GetSkin method on
the g_Wizard object. The file MechanicalWizard\WDK\Info_IFRAME.htm contains an
inaccuracy in that the link is not automatically assigned.

• The style element provides some additional formatting rules.

• The body element has the scroll element set to "no" to preserve margins and prevent scrollbars
from appearing. As long as a reference to IFrame.js appears in the IFRAME the Mechanical
Wizard will autosize the height such that scrollbars are unnecessary.

• The contents of the body are based on free code published by Google.

• Note use of the target attribute to prevent the linked pages from opening in place of the
Mechanical Wizard.

Save the file as Search.htm in the Mechanical Wizard folder. The files must reside together for web
browser security to permit cross-frame scripting.

Open the file CustomWizard.xml from the previous tutorial.

Add the following group at the bottom of the body:


<group id="Search" collapsed="yes">
<iframe src="simwiz://Search.htm" />
</group>

Add the following string to the <strings><language xml:lang="en-us"> section:


<string id="Search_Caption">
Search the Web
</string>

Note the use of the "groupID_Caption" shortcut for the string id.

Save the file and open the wizard in the Mechanical application.

Completed TaskML Files


The following sections examine examples of completed TaskML files.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1947
Workbench Mechanical Wizard Advanced Programming Topics

Links.xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml version="1.0"?>

<simulation-wizard version="1.0">
<strings>
<language xml:lang="en-us">
<string id="Standard_Links_Caption">
Links
</string>
<string id="DesignSpaceHomePage_Caption">
DesignSpace.com
</string>
<string id="DesignSpaceResources_Caption">
DesignSpace Resources
</string>
<string id="MatWeb_Caption">
MatWeb Materials
</string>
</language>
</strings>
<tasks>
<task id="DesignSpaceHomePage" icon="simwiz://Icons/Link.gif">
<activate-event>
<open-url href="http://www.designspace.com" />
</activate-event>
</task>
<task id="DesignSpaceResources" icon="simwiz://Icons/Link.gif">
<activate-event>
<open-url href="http://www.designspace.com/designspace/user_support/" />
</activate-event>
</task>
<task id="MatWeb" icon="simwiz://Icons/Link.gif">
<activate-event>
<open-url href="http://www.matweb.com/" />
</activate-event>
</task>
</tasks>
<body>
<group id="Standard_Links" collapsed="yes">
<taskref task="DesignSpaceHomePage" />
<taskref task="DesignSpaceResources" />
<taskref task="MatWeb" />
</group>
</body>
</simulation-wizard>

Insert100psi.xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml version="1.0"?>
<simulation-wizard version="1.0">
<object-groups>
<object-group name="pressure">
<object-type class="id_Load" type="id_SurfacePressure" />
</object-group>
</object-groups>
<strings>
<language xml:lang="en-us">
<string id="Insert100psi_Caption">
Insert Pressure
</string>
<string id="Insert100psi_Message">
Use the Structural button to insert a Pressure load.
Enter 100 psi for Magnitude.
</string>
</language>
</strings>
<tasks>
<task id="Insert100psi" disable-if-missing="geometry" check-ambiguity="environment">

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1948 of ANSYS, Inc. and its subsidiaries and affiliates.
Tutorials

<update-event>
<if><object type="pressure" condition="does-not-exist"/>
<then>
<set-status status="incomplete"/>
<stop/>
</then>
</if>
<if><object type="pressure" condition="exists" state="under-defined"/>
<then>
<set-status status="undefined"/>
<stop/>
</then>
</if>
<set-status status="complete"/>
</update-event>
<activate-event>
<if><object type="pressure" condition="exists" state="under-defined"/>
<then>
<select-first-object type="pressure" state="under-defined"/>
<select-first-undefined-field/>
<display-details-callout message="Insert100psi_Message" />
<stop/>
</then>
</if>
<if><level type="environment" condition="is-not-selected"/>
<then>
<select-first-object type="environment"/>
</then>
</if>
<click-button toolbar="DS_graphics" button="Surface"/>
<display-toolbar-callout toolbar="Context" button="Structural"
message="Insert100psi_Message" />***
</activate-event>
</task>
</tasks>
</simulation-wizard>

Note

***Note that it was necessary to “word wrap” the long line of code in the above example.

CustomWizard.xml
<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml version="1.0"?>

<simulation-wizard version="1.0">
<merge src="Tasks/InsertGeometry.xml" />
<merge src="Tasks/VerifyLengthUnit.xml" />
<merge src="Tasks/DefineSheetThickness.xml" />
<merge src="Tasks/AssignMaterial.xml" />
<merge src="Insert100psi.xml" />
<merge src="Tasks/InsertDisplacementLoad.xml" />
<merge src="Tasks/ThermalStressNote.xml" />
<merge src="Tasks/InsertStructuralResults.xml" />
<merge src="Tasks/StressStiffeningNote.xml" />
<merge src="Tasks/Solve.xml" />
<merge src="Tasks/ViewResults.xml" />
<merge src="Tasks/ViewReport.xml" />

<merge src="Tasks/StandardTasks.xml"/>
<strings>
<language xml:lang="en-us">
<string id="Title_Caption">
Tutorial Wizard
</string>
<string id="Title_Description">
Demonstrates a custom wizard with a task for inserting a 100 psi Pressure.
</string>

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1949
Workbench Mechanical Wizard Advanced Programming Topics

</language>
</strings>
<body>
<group id="Title">
<taskref task="ChooseWizard"/>
</group>
<group id="RequiredSteps" emphasize="yes">
<taskref task="InsertGeometry"/>
<taskref task="VerifyLengthUnit"/>
<taskref task="DefineSheetThickness"/>
<taskref task="AssignMaterial"/>
<taskref task="Insert100psi"/>
<taskref task="InsertDisplacementLoad"/>
<taskref task="ThermalStressNote"/>
<taskref task="InsertStructuralResults"/>
<taskref task="StressStiffeningNote"/>
<taskref task="Solve"/>
<taskref task="ViewResults"/>
<taskref task="ViewReport"/>
</group>
<group id="Standard_OptionalTasks" />
<group id="Standard_ParameterTasks" />
<group id="Standard_GeneralTasks" />
<group id="Standard_AdvancedTasks" />
<group id="Standard_Links" />
</body>
</simulation-wizard>

Search.htm
<?xml version="1.0" encoding="ISO-8859-1"?>
<!doctype HTML public "-//W3C//DTD HTML 4.0 Frameset//EN">

<html>

<!--(==============================================================)-->
<!--(Document created with RoboEditor. )============================-->
<!--(==============================================================)-->

<head>

<title>Search</title>

<!--(Meta)==========================================================-->

<meta name=generator content="RoboHELP by eHelp Corporation - www.ehelp.com">


<meta name=generator-major-version content=0.1>
<meta name=generator-minor-version content=1>
<meta name=filetype content=kadov>
<meta name=filetype-version content=1>
<meta name=page-count content=1>
<meta name=layout-height content=427>
<meta name=layout-width content=640>
<meta name=date content="07 9, 2003 11:30:11 AM">

<!--(Links)=========================================================-->

<link ID=Skin REL=stylesheet>

<!--(Style Sheet)===================================================-->

<style>
<!--

INPUT {
width: 100%;
margin-bottom: 4px;
}

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1950 of ANSYS, Inc. and its subsidiaries and affiliates.
Tutorials

-->
</style>

<!--(Scripts)=======================================================-->

<script src="System/IFrame.js"></script>

<script>function IFrame_onload() { Skin.href = g_Wizard.GetSkin() }</script>

</head>

<!--(Body)==========================================================-->

<body scroll=no>

<form method=GET
action="http://www.google.com/search"
target=_blank>
<p style="text-align: center;"
align=center><a HREF="http://www.google.com/"
target=_blank><img src="http://www.google.com/logos/Logo_40wht.gif"
ALT=Google
style="width: 128px;
height: 53px;
border-style: none;"
width=128
height=53
border=0></a><br>
<input TYPE=text
name=q
size=25
maxlength=255
value><br>
<input type=submit
name=btnG
VALUE="Google Search"></p>
</form>

</body>

</html>

CustomWizardSearch.xml
<?xml version="1.0"?>

<simulation-wizard version="1.0">
<merge src="simwiz://Tasks/InsertGeometry.xml" />
<merge src="simwiz://Tasks/VerifyLengthUnit.xml" />
<merge src="simwiz://Tasks/DefineSheetThickness.xml" />
<merge src="simwiz://Tasks/AssignMaterial.xml" />
<merge src="Insert100psi.xml" />
<merge src="simwiz://Tasks/InsertDisplacementLoad.xml" />
<merge src="simwiz://Tasks/ThermalStressNote.xml" />
<merge src="simwiz://Tasks/InsertStructuralResults.xml" />
<merge src="simwiz://Tasks/StressStiffeningNote.xml" />
<merge src="simwiz://Tasks/Solve.xml" />
<merge src="simwiz://Tasks/ViewResults.xml" />
<merge src="simwiz://Tasks/ViewReport.xml" />

<merge src="simwiz://Tasks/StandardTasks.xml"/>
<strings>
<language xml:lang="en-us">
<string id="Title_Caption">
Tutorial Wizard
</string>
<string id="Title_Description">
Demonstrates a custom wizard with a task for inserting a 100 psi Pressure.
</string>
<string id="Search_Caption">
Search the Web

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1951
Workbench Mechanical Wizard Advanced Programming Topics

</string>
</language>
</strings>
<body>
<group id="Title">
<taskref task="ChooseWizard"/>
</group>
<group id="RequiredSteps" emphasize="yes">
<taskref task="InsertGeometry"/>
<taskref task="VerifyLengthUnit"/>
<taskref task="DefineSheetThickness"/>
<taskref task="AssignMaterial"/>
<taskref task="Insert100psi"/>
<taskref task="InsertDisplacementLoad"/>
<taskref task="ThermalStressNote"/>
<taskref task="InsertStructuralResults"/>
<taskref task="StressStiffeningNote"/>
<taskref task="Solve"/>
<taskref task="ViewResults"/>
<taskref task="ViewReport"/>
</group>
<group id="Standard_OptionalTasks" />
<group id="Standard_ParameterTasks" />
<group id="Standard_GeneralTasks" />
<group id="Standard_AdvancedTasks" />
<group id="Standard_Links" />
<group id="Search" collapsed="yes">
<iframe src="simwiz://Search.htm" />
</group>
</body>
</simulation-wizard>

Wizard Development Kit (WDK) Groups


• WDK: Tools Group (p. 1952)

• WDK: Commands Group (p. 1953)

• WDK Tests: Actions (p. 1954)

• WDK Tests: Flags (Conditions) (p. 1954)

WDK: Tools Group


The WDK: Tools group provides interactive access to the functionality of several of the most important
TaskML elements and exposes some key internal data. The group also demonstrates how IFRAMEs allow
arbitrary customization of the user interface.

The WDK: Tools group updates automatically when the selection in the Outline changes.

Level Testing

The Outline Level section exercises the functionality of the level (p. 1924) element.

Object Testing and Selection

The second section exercises the functionality of the object (p. 1925), select-first-object (p. 1933) and select-
all-objects (p. 1932) elements. Expert users may find this section useful for automating selection in the
Outline. For example, typing "prt" under Name Regular Expression and clicking Select All Matching
Objects selects all Outline objects with "prt" in their name.

Details Field String ID

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1952 of ANSYS, Inc. and its subsidiaries and affiliates.
Wizard Development Kit (WDK) Groups

The third section exposes the string ID of the currently selected Details field for use with the select-
field (p. 1933) element.

Preview Event Code

Advanced. If checked, displays a message box containing virtual JScript event code prior to its evaluation.
Used for low-level debugging of task rules.

Folder

Displays the folder from which the Mechanical Wizard is currently running. Corresponds to "Mechanical
Wizard URL" in the Control Panel.

WDK: Commands Group


The Commands group exposes options for viewing internal data and for manipulating the system.

Reload Sim Wizard

Reloads the HTML page containing the Mechanical Wizard. The system is reset and the Startup panel
displayed.

Open Wizard

Displays an Open dialog to choose a TaskML file to load. Same as selecting the "browse" option from
"Choose Wizard" on the Startup panel or in wizards.

Fire Update Event

Forces an update-event (p. 1917) to occur in the Mechanical Wizard.

View Current Toolbar Keys

Displays a temporary XML file containing the toolbar and button keys for the current state of the user
interface. Toolbar and button keys are used to define the click-button (p. 1927) and display-toolbar-cal-
lout (p. 1931) elements.

View Wizard XML

Displays a temporary XML file containing the internal merged TaskML.

Remove Merge Information

Removes merge tracking information from the internal TaskML.

Snapshot Wizard DHTML

Saves an HTML file snapshot of the current Mechanical Wizard. The HTML snapshot is useful for devel-
oping CSS skins.

Clear UserData

Clears the Mechanical Wizard UserData store. The UserData store consists of Tip of the Day, group ex-
pansion, and other non-critical data.

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1953
Workbench Mechanical Wizard Advanced Programming Topics

WDK Tests: Actions


The Actions group exercises actions used to define task rules.

Actions
• display-outline-callout (p. 1929)

• display-details-callout (p. 1928)

• display-task-callout (p. 1930)

• display-toolbar-callout (p. 1931)

• display-tab-callout (p. 1930)

• display-status-callout (p. 1929)

• send-mail (p. 1936)

• open-url (p. 1931)

• display-help-topic (p. 1928)

• select-zero-thickness-sheets (p. 1935)

• select-first-undefined-field (p. 1935)

• select-first-parameter-field (p. 1934)

• select-enclosures (p. 1935)

WDK Tests: Flags (Conditions)


The Flags group exercises conditions used to define task rules.

Flags (Conditions)
• changeable-length-unit (p. 1923)

• assembly-geometry (p. 1923)

• geometry-includes-sheets (p. 1924)

• zero-thickness-sheet (p. 1926)

• valid-emag-geometry (p. 1926)

• enclosure-exists (p. 1926)

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1954 of ANSYS, Inc. and its subsidiaries and affiliates.
advanced contact region settings - listed and defined,
Index 706
alert
Symbols object reference, 1632
2D analyses - description and characteristics, 502 alert object reference, 1632
ambient temperature - in radiation load, 997
analysis
A 2D analyses - description and characteristics, 502
ABAQUS Input file import
apply loads and supports step, 190
finite element mesh, 511
apply mesh controls step, 182
Absorption Element
apply preview mesh step, 182
object reference, 1746
approach - overall steps, 173
Absorption Surface
assign behavior to parts step, 177
object reference, 1746
attach geometry step, 174
acceleration
composite, 466
description, 923
create analysis system step, 173
acceleration load
create report step, 193
object reference, 1746
define initial condition step, 186
acceleration object reference, 1746
define resources step, 174
acoustic
define substructures, 181
port in duct, 1045
ecad trace mapping in Mechanical, 469
acoustic absorption element, 1062
ecad trace mapping overview, 466
acoustic absorption surface, 1058
ecad trace mapping workflow, 466
acoustic analysis, 463
establish analysis settings, 183
acoustic analysis types, 247
interface - listing of components, 5
acoustic diffuse sound field, 1040
options - listed and described, 105
acoustic far field mesh, 1069
review results step, 192
acoustic far-field radiation surface, 1073
set connections options step, 182
acoustic free surface, 1064
solve step, 191
acoustic impedance boundary, 1055
types - listed, 195
acoustic impedance sheet, 1049
window components - layout and description, 5
acoustic incident wave, 1042
analysis data management - analysis settings, 910
acoustic mass source, 1035
analysis settings , 873
acoustic port, 1071
establishing - overall analysis step, 183
acoustic pressure, 1053
fracture controls, 889
acoustic radiation boundary, 1060
object reference, 1634
acoustic results
role of time, 914
description, 1308
steps and step controls overall topics, 914
acoustic rigid wall, 1067
topic listing, 873
acoustic static pressure, 1035, 1051
analysis settings analysis data management, 910
acoustic temperature, 1047
analysis settings and solution
acoustic thermo-viscous BLI boundary, 1066
options, 105
acoustic transfer admittance matrix, 1076
analysis settings object reference, 1634
adaptive convergence, 1411
analysis settings output controls, 904
adaptivity, 1411
analysis settings rotordynamics controls, 913
add linearized stress, 1238
analysis topics - special, 402
add offset no ramping contact region setting , 717
analysis type
add offset ramped effects contact region setting, 717
applicable analysis settings, 873
adding beams, 825
analysis types
adjust to touch contact region setting, 717
design assessment, 195
adjustment result in bolt tool
eigenvalue buckling, 203
description, 1274
electric, 199

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1955
Index

explicit dynamics, 202 assemblies, 477


harmonic, 211 assemblies missing parts - troubleshooting, 1859
harmonic acoustics, 247 assemblies of surface bodies, 488
listing, 195 Assignment
magnetostatic, 259 of material properties, 179
modal, 227 associative and non-associative coordinate systems,
modal acoustics, 253 672
random vibration, 235 asymmetric behavior contact region setting, 701
response spectrum, 242 asynchronous solutions
rigid dynamics, 263, 431 description, 1376
static structural, 339 troubleshooting, 1863
steady-state thermal, 344 attaching geometry
thermal-electric, 348 overall analysis step, 174
topology optimization, 352 augmented Lagrange formulation contact region set-
transient structural, 384 ting , 706
transient thermal, 397 auto asymmetric behavior contact region setting , 701
angular periodicity, 625 auto-hiding windows, 6
angular velocity Autodesk Inventor
object reference, 1635 assigning parameters, 1488
angular velocity object reference, 1635 automatic contact, 723
animation controls, 1358 automatic result creation
annotations all result sets, 1356
basics, 160 automatic time stepping analysis settings, 915
environment, 160 automatically generated connections, 691
highlight and selection graphics, 160 averaged vs. unaveraged contour results, 1200
message, 160 axial force result
multiple objects, 162 object reference, 1804
positioning, 160 axisymmetric behavior - 2D simulation, 502
probe - in result context toolbar, 77
rescaling, 160 B
solution, 160 back-face culling - in view menu, 63
ANSYS CFX- solving with fluid solid interface , 1027 background solutions
ANSYS Product Improvement Program, 1 troubleshooting, 1863
ANSYS Workbench beam, 825
safety tools, 1254 object reference, 1638
ANSYS Workbench product beam end release
adaptive solutions, 1411 object reference, 1689
anti-periodic symmetry type, 625 beam end release object reference, 1689
anti-symmetric electromagnetic symmetry type, 624 beam end releases, 828
anti-symmetric structural symmetry type, 622 beam object reference, 1638
anti-symmetric thermal symmetry type, 622 beam probe result, 1303
anti-virus causing crash - troubleshooting, 1866 beam results, 1276
APDL programming - using, 1479 beam tool result
APIP (see ANSYS Product Improvement Program) description, 1275
application not closing - troubleshooting, 1859 object reference, 1640, 1804
applying a graphical view, 152 beam tool result object reference, 1804
applying loads and supports direct stress, 1640
overall analysis step, 190 maximum bending stress, 1640
applying pre-stress effects, 188 maximum combined stress, 1640
arbitrary crack minimum bending stress, 1640
object reference, 1636 minimum combined stress, 1640
arbitrary crack object reference, 1636 bearing

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1956 of ANSYS, Inc. and its subsidiaries and affiliates.
object reference, 1642 box zoom - graphics toolbar button, 70
bearing load
description, 963 C
object reference, 1746 CAD parameters, 1488
bearing load object reference, 1746 CAD systems
bearing object reference, 1642 general information, 1849
bearings isotropic material limitation, 1850
description, 831 multiple versions, 1850
behavior contact region setting, 701 callouts in details view, 17
bending moment result campbell diagram chart result
object reference, 1804 object reference, 1804
bending stress - beam tool, 1275 cannot undo node move - troubleshooting, 1859
biaxiality indication result in fatigue tool capped isosurfaces, 77, 1361
description, 1337 cdb file import
object reference, 1692 finite element mesh, 511
biaxiality indication result object reference, 1692 supported element types, 547
bin size - fatigue simulations, 1332 CFD load transfer
blips, 124 convections, 423
body structural, 423
description, 477 surface temperatures, 423
hide, 485 chart
object reference, 1644 object reference, 1652
suppress, 485 chart and table, 1162
body interaction chart object reference, 1652
object reference, 1649 charts
body interaction object reference, 1649 control, 151
body interactions tips, 151
object reference, 1648 clean results data, 1199
body interactions object reference, 1648 geometry change, 1199
body object reference, 1644 mesh change, 1199
bolt pretension CLOCAL Mechanical APDL application command - use,
description, 967 1232
bolt pretension load close vertices, 94
object reference, 1746 color by parts, 486
bolt pretension object reference, 1746 colors - contact initial information table, 1268
bolt thread contact region setting, 717 combined stress - beam tool, 1275
bolt tool result commands - using the Mechanical APDL application,
description, 1274 1479
object reference, 1650 commands object
bolt tool result object reference properties, 1475
adjustment, 1650 commands object reference, 1652
working load, 1650 commands objects
bonded type contact region setting, 701 available parameter, 1479
boundary condition conflicts between the Mechanical and Mechanical
types, 922 APDL applications, 1479
boundary condition scoping method description, 1475
description, 919 input arguments, 1479
boundary condition types - listed, 922, 1077 object reference, 1652
boundary conditions point selection mode, 1479
description, 919 post processing, 1476
boundary conditions - electromagnetic, 1015 Rigid Dynamics Solver, 1484
box select, 124 solver target, 1479

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1957
Index

step selection mode, 1479 conflicts with remote boundary condition(s) -


comment troubleshooting, 1862
object reference, 1654 connection detection global setting, 685
comment object reference, 1654 connection group
composite analysis, 466 object reference, 1664
composite failure criteria connection group object reference, 1664
object reference, 1655 connection lines with remote point, 617
composite failure criteria object reference, 1655 connections
composite failure results, 1265 context toolbar - screenshot and description, 77
composite failure tool, 1265 general description, 681
object reference, 1656 global settings - listed and defined, 685
composite failure tool object reference, 1656 object reference, 1663
composite results, 1209 setting options - overall analysis step, 182
automated scoping, 1214 connections object reference, 1663
scoping, 1214 connections worksheet, 682
compression only support constraint equation
description, 1095 description, 1107
object reference, 1746 constraint equation condition
compression only support object reference , 1746 object reference, 1746
computation of fracture parameters, 1472 constraint equation object reference, 1746
condensed geometry constraint equations were not properly matched-
object reference, 1659 troubleshooting, 1859
condensed geometry object reference, 1659 constraint type contact region setting, 706
condensed part construction geometry
object reference, 1660 object reference, 1667
condensed part expansion settings object reference, construction geometry object reference, 1667
1691 contact
condensed part missing master node - troubleshooting, advanced region settings - listed and defined, 706
1853 automatic, 723
condensed part object reference, 1660 best practices, 735
condensed parts (RBD Only), 835 controlling transparency for regions - animated ex-
condensing parts, 181 ample, 725
conditions definition region settings - listed and defined, 701
constraint equations, 1105 ease of use features - listed, 723
coupling, 1105 flipping contact/target scope settings - animated
joint, 938 example, 727
pipe idealization, 1105 formulation theory, 694
conductor general description, 681
current excitation for solid source conductors, 1020 hiding bodies not scoped to contact region - proced-
description, 1017 ure, 726
solid body as conductor, 1017 identifying regions - procedure, 727
stranded source body as conductor, 1021 initial, 1268
stranded source conductor, 1022 loading region settings - procedure, 728
voltage excitation for solid source conductors, 1019 locating bodies without contact - application and
conductor load procedure, 729
object reference, 1746 locating parts without contact - application and
conductor object reference, 1746 procedure, 729
conflicts - between workbench and the Mechanical manual, 723
APDL application when using commands objects,1479 merging regions - procedure, 728
conflicts - thermal boundary condition, 1472 options, 105
conflicts with contact region(s) using MPC - overview, 693
troubleshooting , 1862 reactions, 1268

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1958 of ANSYS, Inc. and its subsidiaries and affiliates.
region object reference, 1669 object reference, 1759
region settings - categories, 681 contact sizing object reference, 1759
renaming regions - animated example, 726 contact tool result
resetting regions to defaults - procedure, 729 description, 1268
results, 1243 object reference, 1674
saving region settings - procedure, 728 contact tool result object reference, 1674
scope region settings - listed and defined, 698 context toolbars
setting conditions manually - guidelines and proced- location in the Mechanical application window, 5
ure, 723 overall description and listing, 77
settings, 697 contour options - in result context toolbar, 77
supported contact types, 722 contour results, 1165
supported formulations, 722 contours during solve, 1404
symmetry, 722 controlling transparency for contact regions - animated
tool, 1268 example, 725
contact based reactions, 1290 convection
contact best practices description, 992
contact behavior, 735 convection load
contact tool, 739 object reference, 1746
diagnostics, 743 convection object reference, 1746
mesh quality, 740 convections
non-convergence, 743 at CFD boundary, 423
overlap conditions, 742 convective heat transfer, 992
solver preparation, 739 convergence
contact bodies object reference, 1676
colors, 725 plots, 1395
contact bodies scope region setting, 698 convergence criteria analysis setting , 900
contact debonding convergence object reference, 1676
application, 868 convergence options, 105
object reference, 1667 converting boundary conditions to nodal degree-of-
contact debonding object reference, 1667 freedom constraints, 1471
contact geometry correction contact region setting, coordinate system object reference, 1677
717 coordinate systems
contact match applying local coordinate systems, 676
object reference, 1757 create section plane, 677
contact match group creating, 77, 671
object reference, 1754 creating construction surfaces, 667
contact match group object reference, 1754 global, 77
contact match object reference, 1757 importing, 676
contact region object reference, 1680
automatically generate objects, 724 orientation, 674
contact region object properties overall topics, 671
electromagnetic analyses, 1672 principal axis, 674
explicit dynamics analyses, 1672 reference number, 671
rigid body dynamic (rbd) analyses, 1673 references, 676
structural analyses, 1671 result, 1196
thermal analyses, 1672 transferring to the Mechanical APDL application,679
contact region object reference, 1669 transformations, 674
contact region settings - categories, 681 use in specifying joint locations., 676
contact region(s) not in initial contact - troubleshooting using, 671
, 1861 coordinate systems object reference, 1680
contact scope region settings, 698 coordinate systems result
contact sizing object reference, 1804

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1959
Index

coordinate systems result object reference, 1804 cyclic symmetry in a static structural analysis, 636
coordinate systems results, 1165 boundary conditions, 636
coordinates - graphics toolbar button, 70 results, 637
copying graphical view to Mechanical APDL, 153 cyclic symmetry in a thermal analysis, 648
coupling cylindrical joints, 750
description, 1105 cylindrical support
crack description, 1098
pre-meshed, 1791 object reference, 1746
crack analysis, 841 cylindrical support object reference, 1746
crack meshing, 845 cylindrical surface direction, 1150
cracks, 845, 851
solving analysis, 1472 D
create coordinate system from nodes, 141 damage matrix result in fatigue tool
create named selection from element faces, 142 description, 1337
create named selection from elements, 142 object reference, 1692
create named selection from nodes, 142 damage matrix result object reference, 1692
create solid geometry in Mechanical, 181 damage result in fatigue tool
creating a graphical view, 152 description, 1337
creep controls, 888 object reference, 1692
creep strain - equivalent, 1235 damage result object reference, 1692
Creo Parametric damping controls - analysis settings, 898
assigning parameters, 1488 data standard toolbar button - commands and descrip-
cross section object tions, 69
object reference, 1681 data transfer
cross section object reference, 1681 Polyflow to Mechanical , 428
cross sections database file - saving results
object reference, 1681 as a dsdb, 1468
cross sections object reference, 1681 as a Mechanical APDL database file, 1468
current debonding
description, 1012 fracture analysis, 865
current density result define initial condition
description, 1317 overall analysis step, 186
object reference, 1804 defining cracks, 845
current density result object reference, 1804 definition contact region settings - listed and defined,
current excitation 701
stranded source conductor body, 1022 deformation , 1226
current excitation for solid conductors deformed shape - scaling in result context toolbar, 77
current object reference, 1746 degrees - in main menu, 63
current excitation for solid source conductors degrees of freedom and joint types, 750
description, 1020 delamination
current object reference, 1746 fracture analysis, 865
cursors - rotation, 123 deleting a graphical view, 153
cut boundary displacement method (see submodeling) depth picking, 124
cyclic axis of symmetry - troubleshooting, 1869 design assessment analysis type, 195
cyclic controls, 889 design validation
cyclic region, 628 topology optimization, 378
object reference, 1784 details view
cyclic region object reference, 1784 description and user interactions, 17
cyclic symmetry in a harmonic response analysis, 639 location in the Mechanical application window, 5
boundary conditions, 640 detonation point
results, 641 object reference, 1746
cyclic symmetry in a modal analysis, 642 detonation point object reference, 1746

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1960 of ANSYS, Inc. and its subsidiaries and affiliates.
Diffuse Sound Field description, 1312
object reference, 1746 object reference, 1804
dimensions - geometry, 177 directional heat flux result object reference , 1804
direct element selection, 146 directional magnetic field intensity result
direct fe description, 1317
nodal displacement, 1120 directional magnetic flux density result
nodal force, 1120 description, 1317
nodal orientation, 1120 directional velocity result
nodal rotation, 1120 description, 1226
Direct FE object reference, 1804
EM Transducer, 1746 directional velocity result object reference, 1804
Nodal Displacement, 1746 displacement
Nodal Force, 1746 description, 1080
Nodal Orientation, 1746 edge, 1080
Nodal Pressure, 1746 object reference, 1746
Nodal Rotation, 1746 remote, 1080
direct fe object reference, 1685 surfaces, 1080
direct fe types - listed, 1120 vertex, 1080
direct node selection, 146 displacement constraint - topology optimization
direct stress result in beam tool description, 362
description, 1275 displacement object reference, 1746
object reference, 1804 displacement support
direct stress result object reference, 1804 object reference, 1746
direction display points - in solution information, 1395
defaults, 149 Distance Based Average Comparison option
defining, 1150 for Mapping Validation, 1899
graphics toolbar button, 70 distributed mass
selecting, 149 description, 506
directional acceleration result object reference, 1684
description, 1226 distributed mass object reference, 1684
object reference, 1804 docking windows, 6
directional acceleration result object reference, 1804 duplicate - in main menu, 63
directional current density result dynamic legend, 1363
object reference, 1804
directional deformation result E
description, 1226 ease of use contact features - listed, 723
object reference, 1804 edge direction, 1150
directional deformation result object reference , 1804 edge graphics options
directional electric field intensity result screenshot and description, 97
object reference, 1804 toolbar location in the Mechanical application win-
directional field intensity result dow, 5
object reference, 1804 edge options - in result context toolbar, 77
directional field intensity result object reference, 1804 eigenvalue buckling analysis type, 203
directional flux density result elastic slip tolerance contact region setting, 706
object reference, 1804 elastic strain intensity result
directional flux density result object reference, 1804 description, 1231
Directional Force electromagnetic result object reference, 1804
description, 1317 elastic strain intensity result object reference, 1804
directional force electromagnetic result elastic support
object reference, 1804 description, 1103
directional force result object reference, 1804 object reference, 1746
directional heat flux result elastic support object reference, 1746

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1961
Index

electric analysis type, 199 equivalent plastic strain result object reference , 1804
electric loads, 938 equivalent stress result
electric potential result description, 1230
description, 1317 object reference, 1804
object reference, 1804 equivalent stress result object reference, 1804
electric potential result object reference, 1804 equivalent total strain result
electric results, 1321 description, 1235
electric voltage result object reference, 1804
object reference, 1804 error - magnetic result
electro-mechanical transducer description, 1319
description, 1130 error result
electromagnetic boundary conditions - listed, 1015 structural, 1232
electromagnetic loads - listed, 938 thermal, 1313
electromagnetic periodic symmetry, 626 error status symbol, 8
electromagnetic-thermal interaction, 402 ESOL command, 1350
electromagnetic-thermal load import, 403 Euler angle sequence, 1232
element distortion error - troubleshooting, 1859 excitations - electromagnetic, 1015
element name results, 1218 expansion settings
element orientation, 570 object reference, 1691
application, 570 explicit dynamics analysis type, 202
specification requirements, 570 explode model, 99
element select - graphics toolbar button, 70 explode view options toolbar
element selection screenshot and description, 99
direct, 146 export
element through the thickness - troubleshooting,1857 description, 54
element type results, 1218 external file, 419
elemental coordinate systems results, 1166 file format, 54
em transducer options, 105
description, 1130 exported file saved to disk but microsoft office failed
emissivity - in radiation load, 997 to load - troubleshooting, 1854
enclosure - in radiation load, 997 exporting a saved graphical view list, 153
energy accuracy tolerance analysis setting, 900 exporting load history, 1150
energy result, 1289 extend selection
environment description, 124
annotations, 160 graphics toolbar button, 70
context toolbar - screenshot and description, 77 extend to adjacent selection, 124
object reference, 1690 extend to connection selection, 124
environment filtering of GUI, 104 extend to limits selection, 124
environment object reference, 1690 External Data systems
equivalent alternating stress result in fatigue tool Master file, 412
description, 1337 external model
object reference, 1692 importing deformation-based geometry, 575
equivalent alternating stress result object reference, importing mesh-based geometry, 511
1692 External Thickness, 1734
equivalent creep strain ratio has exceeded the specified External Thickness reference, 1734
limit - troubleshooting, 1860
equivalent creep strain result F
description, 1235 face meshing object reference, 1759
object reference, 1804 failed to load microsoft office application -
equivalent plastic strain result troubleshooting, 1860
description, 1234 Far-field Radiation Surface
object reference, 1804 object reference, 1746

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1962 of ANSYS, Inc. and its subsidiaries and affiliates.
fatigue results fluid solid interface
frequency-based fatigue, 1326 description, 1027
stress life versus strain life, 1325 fluid solid interface load
fatigue sensitivity result in fatigue tool object reference, 1746
description, 1337 fluid solid interface object reference, 1746
object reference, 1692 fluid surface
fatigue sensitivity result object reference , 1692 object reference, 1698
fatigue simulations fluid surface object reference, 1698
loading options, 1332 fluid-structure interaction
material properties, 1323 convections, 423
options, 105 surface temperatures, 423
overview, 1323 fluid-structure interaction - one-way using imported
results, 1337 loads, 421
strain-life, 1323 fluid-structure interaction - one-way using system
stress-life, 1323 coupling, 450
user life units, 1332 fluid-structure interaction - overall description, 419
fatigue tool result fluid-structure interaction - two-way, 420
description, 1337 fluid-structure interface
object reference, 1692 face forces, 423
fatigue tool result object reference , 1692 flux linkage result
figure description, 1318
description, 166 object reference, 1804
object reference, 1697 force
figure object reference, 1697 description, 953
file management in the Mechanical application, 1417 force load
file names - CAD limitation, 1850 object reference, 1746
filter for objects, 14 force object reference, 1746
filter for tags, 14 force reaction constraint - topology optimization
filter the tree, 14 description, 362
filtering GUI based on environment, 104 force reaction result
filters object reference, 1804
selection, 124 formulation contact region setting, 706
fit - graphics toolbar button, 70 foundation stiffness - in elastic support , 1103
fixed joints, 750 fracture, 841
fixed rotation object reference, 1746 define arbitrary crack, 859
fixed rotation support define pre-meshed crack, 863
description, 1101 define semi-elliptical crack, 853
object reference, 1746 object reference, 1699
fixed support fracture analysis, 841
Edge: description, 1078 computation of parameters, 1472
object reference, 1746 multi-point constraint contact, 871
surFace: description, 1078 solving, 1472
Vertex: description, 1078 workflows, 841
fixed support object reference, 1746 fracture analysis results object reference, 1804
flexible bodies, 480 fracture controls, 889
flexible parts in a Rigid Dynamics analysis , 181 fracture meshing, 845
flip reference and mobile for joints, 814 fracture object reference, 1699
flipping contact/target scope settings - animated ex- fracture results, 1261
ample, 727 fracture tool, 1261
flipping periodic low and periodic high settings, 649 object reference, 1700
Fluent Input file import fractures, 845
finite element mesh, 511 Free Surface

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1963
Index

object reference, 1746 generate objects from template object, 1621


frequency response, 1246 generating reports
frequency response result publishing, 33
object reference, 1804 tables, 32
frequency response result object reference, 1804 geometric axis direction, 1150
frequency simulations geometric modification contact region settings - listed
options, 105 and defined, 717
frequency-based fatigue, 1326 geometry, 77
material properties, 1327 attach - overall analysis step, 174
result formulation methods, 1330 context toolbar - screenshot and description, 77
friction coefficient contact region setting , 706 full screen mode, 26
frictional stress result in contact tool legend, 29
description, 1268 object reference, 1701
object reference, 1674 options, 105
frictional stress result object reference , 1674 tab, 26
frictional type contact region setting, 706 updating, 174
frictionless support window, 26
description, 1093 geometry from deformation results, 575
object reference, 1746 geometry object reference, 1701
frictionless support object reference, 1746 geometry view
frictionless type contact region setting, 706 saving, 152
FSI - one-way coupled, 450 geometry window
FSI - one-way imported loads, 421 model movement - manipulation, 147
FSI - overall description, 419 global connection settings - listed and defined , 685
FSI - two-way, 420 global coordinate system
full integration scheme, 484 description, 77
full screen mode, 35 object reference, 1705
function loads, 1150 global coordinate system object reference, 1705
global von-mises stress constraint - topology optimiza-
G tion
gap result in contact tool description, 362
description, 1243 glossary, 1875
object reference, 1674 go to options in tree outline, 10
gap result object reference, 1674 go to selected items - worksheet, 48
gasket go to selected items in tree - worksheet, 48
mesh control, 482 Graph window, 50
gasket bodies, 480, 482 graphical views
specify, 482 applying, 152
gasket mesh control copying to Mechanical APDL, 153
object reference, 1701 creating, 152
gasket mesh control object reference, 1701 deleting, 153
gasket meshing, 482 exporting list, 153
gasket results, 482, 1304 importing list, 153
gaskets managing, 151
defining, 482 renaming, 152
general joints, 750 replacing saved, 153
generalized plane strain graphics
behavior in 2D analyses, 502 blips, 124
description, 976 control, 123
reactions, 1290 options, 105
using, 503 options in result context toolbar, 77
generate connections on update global setting, 685 painting, 124

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1964 of ANSYS, Inc. and its subsidiaries and affiliates.
picking, 124 hysteresis result object reference , 1692
tips, 123
toolbar - commands and descriptions, 70 I
toolbar location in the Mechanical application win- ICEM CFD Input file import
dow, 5 finite element mesh, 511
graphics - topic listing, 123 Icepak
graphics option Mechanical data transfer, 424
edge coloring, 97 transient, 426
screenshot and description, 94 identifying contact regions - procedure, 727
show mesh, 94 illogical reaction results - troubleshooting, 1860
graphics options image from file, 1706
toolbar location in the Mechanical application win- image object reference, 1706
dow, 5 Impedance Boundary
group by global connection setting, 685 object reference, 1746
group tree objects, 100 Impedance Sheet
object reference, 1746
H import
harmonic acoustics analysis type, 247 CDB mesh file, 511
harmonic analysis, 211 external file, 412
harmonic analysis amplitude result calculation, 222 external thickness, 413
harmonic analysis linked to modal, 225 finite element mesh, 511
harmonic analysis linked to structural, 223 Import thickness, 493
heat flow imported body force density load, 1138
description, 1001 imported body temperature load, 1139
heat flow load imported boundary conditions, 1133
object reference, 1746 imported convection coefficient load, 1141
heat flow object reference, 1746 imported cut boundary constraint, 1141
heat flux imported cut remote force, 1141
description, 1003 imported displacement load, 1142
heat flux load imported force, 1142
object reference, 1746 Imported from External Model
heat flux object reference, 1746 contacts, 1708
heat flux results, 1312 coordinate systems, 1710
heat reaction result coupling equations, 1707
description, 1313 element orientations, 1711
hidden status symbol, 8 nodal orientation, 1715
hide all other bodies, 485 point masses, 1716
hide body, 485 remote connection, 1713, 1718
hide faces, 485 shell thicknesses, 1720-1721
hide items, 13 imported heat flux load, 1143
hide other bodies for joints, 814 imported heat generation load, 1143
hiding bodies not scoped to contact region - procedure, imported initial stain load, 1144
726 imported initial stress load, 1145
hotkeys, 167 imported load
hydrostatic pressure electromagnetic-thermal, 403
description, 949 Imported Loads, 1725
hydrostatic pressure load Imported loads reference, 1725
object reference, 1746 imported material field, 1728
hydrostatic pressure object reference, 1746 imported material fields (group), 1727
hysteresis result in fatigue tool Imported Plies, 1633, 1723
description, 1337 Imported Plies reference, 1723
object reference, 1692 Imported Ply reference, 1633

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1965
Index

imported pressure load, 1147 initial information result object reference, 1674
imported remote loads, 1730 initial temperature
imported surface force density, 1148 object reference, 1740
imported temperature load, 1148 initial temperature object reference, 1740
Imported Thickness, 1732 initial time increment problems - troubleshooting ,1866
Imported Thickness (Group), 1734 inside pinball search direction contact region setting,
Imported Thickness reference, 1732, 1734 706
Imported Trace, 1737 insufficient disk space - troubleshooting, 1855
Imported Trace Folder, 1736 integration scheme, 484
imported velocity load, 1149 interaction loads - listed, 938
importing interface
coordinate systems, 676 ease of use, 169
importing a graphical view list, 153 interface - listing of components, 5
importing load history, 1150 interface behavior based on license levels, 104
importing material fields, 569 interface delamination
importing mesh-based databases application, 866
coordinate systems, 533 object reference, 1741
element orientations, 535 interface delamination object reference, 1741
flexible remote connections, 539 interface treatment contact region setting , 706, 717
named selections, 540 internal heat generation
nodal orientations, 541 description, 1005
point masses, 541 internal heat generation load
rigid remote connections, 543 object reference, 1746
shell thickness, 544 internal heat generation object reference , 1746
springs, 546 interpolation
importing mesh-based databases via external model, path results, 1184
522 probe results, 1184
constraint equations, 530 surface results, 1184
contacts, 532 invalid material properties - troubleshooting , 1854
in process solutions, 1376 invert suppressed body set, 13
Incident Wave Source iso - graphics toolbar button, 70
object reference, 1746 isotropic materials - CAD limitation, 1850
inductance result iterative solver problem - troubleshooting, 1857
description, 1317
object reference, 1804 J
inertia relief analysis setting, 877 joint
inertia tensor is too large - troubleshooting, 1860 create manually, 784
inertial loads - listed, 922 description, 985
infinite life - fatigue simulations, 1332 legend, 29
inflation object reference, 1744
object reference, 1759 properties, 761
inflation object reference, 1759 joint checker, 814
initial condition joint condition
object reference, 1740 object reference, 1746
initial condition object reference, 1740 joint condition object reference, 1746
initial contact, 1268 joint configure toolbar
initial information object in contact tool screenshot and description, 100
description, 1268 joint legend, 814
initial information result in contact tool joint object reference, 1744
colors in table, 1268 joint probe problems - troubleshooting, 1867
description, 1268 joint probes
object reference, 1674 results, 1298

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1966 of ANSYS, Inc. and its subsidiaries and affiliates.
joints Linearized Middle Principal Stress, 1804
characteristics, 746 Linearized Minimum Principal Stress, 1804
detecting overconstrained conditions, 817 Linearized Normal Stress, 1804
ease of use features, 814 Linearized Shear Stress, 1804
example, 785, 796 Linearized stress, 1238
generate automatically, 809 linearized stress error - troubleshooting, 1852
topics, 746 Linearized Stress Intensity, 1804
types, 750 Linearized stresses, 1804
joule heat result load transfer error - troubleshooting, 1853
object reference, 1804 load transfer mesh mapping, 1879
load types - listed, 922
K loading contact region settings - procedure, 728
keyboard support, 70 loading types - fatigue simulations, 1332
known temperature load, 989 loads and supports object reference, 1746
local coordinate system
L applying, 676
labeling objects, 1626 creating, 77
large deflections analysis setting, 877 in coordinate system object reference, 1677
large deformation effects are active - troubleshooting local von-mises stress constraint - topology optimization
, 1860 description, 362
large deformation problems - troubleshooting, 1866 locating bodies without contact - application and pro-
layered section cedure , 729
object reference, 1745 locating parts without contact - application and proced-
layered section object reference, 1745 ure , 729
layered sections, 494 look at - graphics toolbar button, 70
legend customization, 77 low/high cyclic symmetry - troubleshooting, 1868
license manager server problems - troubleshooting , lustre
1867 troubleshooting, 1874
licensed product issues - troubleshooting, 1866
life - fatigue user life units, 1332 M
life result in fatigue tool macros - usage and accessing, 123
description, 1337 magnetic error result, 1319
object reference, 1692 object reference, 1804
life result object reference, 1692 magnetic error result object reference, 1804
lighting controls, 166 magnetic field intensity result
limitations directional, 1317
topology optimization, 383 total, 1317
line bodies, 477 magnetic flux boundary condition, 1015
general description, 498 magnetic flux density result
line pressure directional, 1317
description, 979 total, 1317
line pressure load magnetic flux parallel load
object reference, 1746 description, 1015
line pressure object reference, 1746 object reference, 1746
line search analysis setting, 900 magnetic flux parallel object reference, 1746
linear dynamic analysis types, 202 magnetostatic analysis type, 259
linear periodic structural symmetry type, 622 magnetostatic results, 1316
linear periodic thermal symmetry type, 622 magnifier window - toggle graphics toolbar button, 70
linear perturbation, 865 main menu
Linearized Equivalent Stress, 1804 commands and descriptions, 63
Linearized Maximum Principal Stress, 1804 location in the Mechanical application window, 5
Linearized Maximum Shear Stress, 1804 manage view settings, 151

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1967
Index

manual contact, 723 description, 1255


manually insert connection objects, 691 maximum principal elastic strain result object reference,
manufacturing constraint (topology optimization) 1804
member size, 1748 maximum principal stress result object reference ,1804
object reference, 1748 maximum principal stress/elastic strain result
manufacturing constraint - topology optimization description, 1231
description, 359 object reference, 1804
member size, 359 maximum shear elastic strain result object reference,
mapped face meshing 1804
object reference, 1759 maximum shear stress result object reference, 1804
status symbol, 8 maximum shear stress safety tool result
mapping -CFD results, 424 description, 1256
Mapping Control maximum shear stress/elastic strain result
Distance Based Average weighting, 1879 description, 1231
Manual enables modification of Advance Features, object reference, 1804
1879 maximum tensile stress safety tool result
Program Controlled gives best accuracy, 1879 description, 1260
Shape Function weighting, 1879 mean stress theory - fatigue simulations, 1332
Triangulation weighting, 1879 Mechanical APDL application - using commands, 1479
Mapping Validation objects, 1899 Mechanical APDL application database file - saving
mass constraint (topology optimization) results as, 1468
object reference, 1799 Mechanical APDL application Euler angle sequence,
mass constraint - topology optimization 1232
description, 362 Mechanical APDL application input file - saving results
mass flow rate as, 1468
description, 1008 Mechanical APDL application memory options, 1377
mass flow rate object reference , 1746 Mechanical APDL application plots , 1479
mass moment of inertia, 505 Mechanical APDL application- conflicts with workbench
Mass Source when using commands objects, 1479
object reference, 1746 Mechanical objects reference, 1629
match control memory options - the Mechanical APDL application
object reference, 1759 setting defaults, 105
status symbol, 8 setting for a solution, 1377
match control object reference, 1759 merging contact regions - procedure, 728
material properties - fatigue, 1323 mesh connection
material properties - frequency-based Fatigue, 1323 object reference, 1757
material property usage in postprocessing, 1199 mesh connection group
material type results, 1218 object reference, 1754
materials, 177 mesh connection group object reference, 1754
assigning properties to, 179 mesh connection object reference, 1757
assigning to parts - analysis step, 177 mesh control tools
maximum bending stress result in beam tool applying - overall analysis step, 182
description, 1275 object reference, 1759
object reference, 1804 mesh control tools object reference, 1759
maximum bending stress result object reference ,1804 mesh edit
maximum combined stress result in beam tool context toolbar - screenshot and description, 77
description, 1275 object reference, 1761
object reference, 1804 mesh edit object reference, 1761
maximum combined stress result object reference,1804 mesh group
maximum data points to plot - fatigue simulations , object reference, 1763
1332 mesh group object reference, 1763
maximum equivalent stress safety tool result mesh grouping

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1968 of ANSYS, Inc. and its subsidiaries and affiliates.
object reference, 1765 modal acoustics analysis type, 253
mesh grouping object reference, 1765 modal analysis
mesh import troubleshooting, 1871
supported element types, 547 modal analysis type, 227
mesh nodes modal object reference, 1766
result contour, 140 model
mesh numbering, 657 context toolbar - screenshot and description, 77
object reference, 1765 object reference, 1767
mesh numbering object reference, 1765 pan, 147
mesh object reference, 1749 rotate, 147
mesh selection triad, 147
element, 142 zoom, 147
element face, 142 model movement - manipulation, 147
mesh selection - elements model object reference, 1767
element information, 145 Mohr-Coulomb stress safety tool result
mesh selection - nodes, 137 description, 1258
meshing moment
context toolbar - screenshot and description, 77 description, 972
specialized - cracks, 845 moment load
specialized - fracture, 845 object reference, 1746
messages window, 58 moment object reference, 1746
method mesh control tool moment of inertia, 505
object reference, 1759 motion load
method mesh control tool object reference, 1759 description, 1025
method scope contact region geometry, 698 solving with inertia relief, 1025
method scope contact region named selection, 698 move and copy connection objects, 691
method scope contact region pre-generate interface, moving windows, 6
698 mpc equations were not built for one or more contact
method scope contact region setting, 698 regions - troubleshooting , 1861
middle principal elastic strain result object reference, MPC formulation contact region setting, 706
1804 multi-point constraint contact for fracture, 871
middle principal stress result object reference, 1804 multibody parts, 479
middle principal stress/elastic strain result multiple versions of CAD systems, 1850
description, 1231
object reference, 1804 N
minimum bending stress result in beam tool named selection
description, 1275 exporting, 606
object reference, 1804 named selections
minimum bending stress result object reference, 1804 converting to Mechanical APDL application compon-
minimum combined stress result in beam tool ents, 607
description, 1275 creating, 583
object reference, 1804 creating though promotion, 597
minimum combined stress result object reference ,1804 criteria rules, 587
minimum principal elastic strain result object reference, defining, 586
1804 display, 598
minimum principal stress result object reference, 1804 including in program controlled inflation, 606
minimum principal stress/elastic strain result merging, 607
description, 1231 object reference, 1768
object reference, 1804 overview, 583
miscellaneous options, 105 scoping analysis objects to, 605
modal sending to solver, 606
object reference, 1766 toolbar, 94

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1969
Index

toolbar location in the Mechanical application win- transient thermal, 903


dow, 5 nonlinear formulation analysis setting, 900
worksheet, 596 nonlinear material effects
Named Selections assigning to parts - analysis step, 177
importing, 606 nonlinear solution, 1395
managing, 603 normal elastic strain result
toolbar, 603 description, 1875
named selections object reference, 1768 object reference, 1804
Nastran Bulk Data file import normal elastic strain result object reference, 1804
finite element mesh, 511 normal gasket pressure
natural frequency constraint - topology optimization object reference, 1804
description, 362 normal gasket pressure object reference, 1804
new section plane, 154 normal gasket total closure
Newton-Raphson residuals, 1395 object reference, 1804
next view - graphics toolbar button, 70 normal gasket total closure object reference, 1804
no separation type contact region setting, 701 normal Lagrange formulation contact region setting,
nodal coordinate systems results, 1166 706
nodal displacement normal stiffness contact region setting, 706
description, 1126 normal stiffness factor contact region setting , 706
Nodal Displacement normal stress result
object reference, 1685 description, 1231
nodal force object reference, 1804
description, 1121 normal stress result object reference, 1804
Nodal Force number of processors solution setting, 1377
object reference, 1685 numbering control
nodal orientation object reference, 1776
description, 1120 numbering control object reference, 1776
Nodal Orientation NX
object reference, 1685 assigning parameters, 1488
nodal pressure
description, 1123 O
nodal rotation object generator, 1621
description, 1128 object reference
Nodal Rotation imported material field, 1728
object reference, 1685 imported material fields (group), 1727
nodal rotation object reference, 1746 objective (topology optimization)
node merge object reference, 1778
object reference, 1772, 1774 objective - topology optimization
node merge object reference, 1772, 1774 description, 365
node move objects
object reference, 1776 generating multiple from template object, 1621
node move object reference, 1776 tagging, 1626
node select - graphics toolbar button, 70 objects reference
node selection alphabetical listing, 1629
direct, 146 description of page content, 1629
nonlinear adaptive region offsets
description, 1112 surface bodies, 489
object reference, 1746 ok status symbol, 8
nonlinear adaptive region controls, 887 optimization region (topology optimization)
nonlinear controls analysis settings, 900 object reference, 1779
rigid dynamic, 903 optimization region - topology optimization
static and transient, 900 description, 357

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1970 of ANSYS, Inc. and its subsidiaries and affiliates.
options - analysis settings, 890 periodicity - angular, 625
options - listed and described, 105 phase angle
order of precedence in resolving thermal boundary in current for solid source conductor, 1020
condition conflicts, 1472 in current for stranded source conductor body, 1022
other selection scoping in periodic symmetry region, in voltage for solid source conductor, 1019
649 phase response, 1246
out of process solutions, 1376 phase response result
output controls - analysis settings, 904 object reference, 1804
overconstrained conditions phase response result object reference, 1804
joints, 817 physics region
object reference, 1787
P physics region object reference, 1787
painting graphics, 124 picking - depth, 124
pan, 147 picking graphics, 124
pan - graphics toolbar button, 70 pinball radius contact region setting, 706
parameters pinball region contact region setting, 706
CAD, 1488 pinch
defined in solution commands objects, 1479 object reference, 1759
overall description, 1485 pinch object reference, 1759
parameterizing a variable, 26 pipe idealization
restrictions, 1485 description, 1109
specifying, 1485 pipe idealization condition
part object reference, 1746
description, 477 pipe idealization object reference, 1746
object reference, 1781 pipe pressure
part object reference, 1781 description, 945
partial solution returned - troubleshooting, 1854 pipe pressure object reference, 1746
path pipe temperature
object reference, 1783 description, 947
path - construction geometry, 661 pipe temperature object reference, 1746
path object reference, 1783 planar face direction, 1150
path result planar joints, 750
scoping, 1217 plane strain behavior - 2D simulation, 502
path results, 1168 plane stress behavior - 2D simulation, 502
PDEF command, 1350 plastic strain - equivalent, 1234
peak result, 1209 PLNSOL command, 1350
penetration result in contact tool plots - Mechanical APDL application, 1479
description, 1243 point mass
object reference, 1674 description, 505
penetration result object reference, 1674 object reference, 1789
penetration tolerance contact region setting, 706 point mass object reference, 1789
perfectly insulated load pointer modes, 124
description, 1001 Polyflow to Mechanical
object reference, 1746 data transfer, 428
perfectly insulated object reference, 1746 Port
periodic high scoping in periodic symmetry region,649 object reference, 1746
periodic low scoping in periodic symmetry region, 649 Port In Duct
periodic region object reference, 1746
object reference, 1784 position probe, 1288
using, 649 postprocessing commands objects, 1479
periodic region object reference, 1784 postprocessing features, 1404
periodic symmetry type, 625 pre stress

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1971
Index

object reference, 1792 Q


pre-meshed crack quick rainflow counting - fatigue simulations , 1332
object reference, 1791
pre-meshed crack object reference, 1791 R
pre-meshed cyclic region
rad/s - in main menu, 63
object reference, 1784
radians - in main menu, 63
pre-meshed cyclic region object reference, 1784
radiation
pre-meshed cyclic symmetry, 630
description, 997
pre-stress object reference, 1792
Radiation Boundary
preprocessing commands objects, 1479
object reference, 1746
presentation
radiation load
full screen mode, 35
object reference, 1746
pressure
radiation object reference, 1746
description, 939
radiosity controls, 889
Pressure (Acoustic)
rainflow counting - fatigue simulations, 1332
object reference, 1746
rainflow matrix result in fatigue tool
pressure load
description, 1337
at CFD boundary, 423
object reference, 1692
object reference, 1746
rainflow matrix result object reference, 1692
pressure object reference, 1746
random colors
pressure result in contact tool
contact bodies, 725
description, 1243
named selections, 598
object reference, 1674
random vibration analyses
pressure result object reference, 1674
considerations for acceleration, 1226
preview mesh - overall analysis step, 182
considerations for deformation, 1226
previous view - graphics toolbar button, 70
considerations for velocity, 1226
print preview, 30
random vibration analysis type, 235
context toolbar - screenshot and description, 77
reactions
priority global connection setting, 685
bolt load, 1290
PRNSOL command, 1350
contact, 1268
probe
generalized plane strain, 1290
annotations in result context toolbar, 77
overall list, 1290
description, 1175
reactions result in contact tool
probe result
description, 1243
object reference, 1794
reduced integration scheme, 484
probe result object reference , 1794
reference number - coordinate system, 671
procedure
reference temperature, 177
overall steps in an analysis, 173
refinement
programming - using Mechanical APDL, 1479
object reference, 1759
project
refinement object reference, 1759
context toolbar - screenshot and description, 77
relative assembly tolerance analysis setting, 900
object reference, 1795
relative scaling - in result context toolbar, 77
project object reference, 1795
remote boundary conditions, 1132
psd base excitation
remote boundary conditions - troubleshooting, 1863
description, 982
remote displacement object reference , 1746
PSD base excitation load
remote displacement support
object reference, 1746
description, 1086
PSD base excitation object reference, 1746
object reference, 1746
publishing reports, 33
remote force
pure penalty formulation contact region setting, 706
description, 957
remote force load
object reference, 1746

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1972 of ANSYS, Inc. and its subsidiaries and affiliates.
remote force object reference, 1746 result plot tracker
remote point object reference, 1835
commands objects, 617 result plot tracker object reference, 1835
connection lines, 617 result tracker
features, 617 description, 1405
geometry behavior, 614 exporting, 1405
object reference, 1796 features, 1405
overview, 609 object reference, 1802
promote, 617 plotting, 1405
support specifications, 616 renaming, 1405
remote point object reference, 1796 structural, 1407
remote points thermal, 1411
object reference, 1798 result tracker object reference, 1802
remote points object reference, 1798 results
remote solving, 1376 acoustic, 1308
rename based on definition composite failure, 1265
commands objects, 1652 contour, 1165
results and result tools, 1366 display issues, 1213
rename tree objects, 7 electric, 1321
renaming a graphical view, 152 fracture, 1261
renaming contact regions - animated example, 726 gasket, 1304
renaming joints based on geometry, 814 geometry represented, 1161
replacing a saved graphical view, 153 how to apply, 1161
report introduction and overview, 1161
context toolbar - screenshot and description, 77 magnetostatic, 1316
creating - overall analysis step, 193 response psd tool, 1303
creating editions, 34 reviewing - overall analysis step, 192
customizing, 34 scoping, 1214
options, 105 structural, 1224
report preview, 31 thermal, 1311
reported frequency result topology density, 371
object reference, 1804 topology elemental density, 373
reported frequency result object reference, 1804 unaveraged contour, 1200
resetting contact regions to defaults - procedure, 729 unconverged results, 1212
response constraint - topology optimization vector plots, 1185
description, 362 results and result tools object reference, 1804
response psd results scoping
results, 1300 element-based, 1214
response psd tool, 1303 geometry, 1214
response PSD tool result object reference, 1801 named selections, 1214
response spectrum analysis type, 242 node-based, 1214
restart analysis, 884 results set listing, 1183
restart controls, 885 Reverse Validation option
restitution value, 706 for Mapping Validation, 1899
restore original window layout, 6 revolute joints, 750
restore original window layout - in main menu , 63 rigid bodies, 480
result rigid body motion - troubleshooting , 1862
automatically create result for all result sets, 1356 Rigid Dynamics Analysis
context toolbar - screenshot and description, 77 to static structural analysis, 432
coordinate systems, 1196 rigid dynamics analysis type, 263
legend, 29 commands, 273
result coordinate systems, 1196 Rigid Dynamics Solver

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1973
Index

using commands, 1484 saving results


Rigid Transformation as a database file, 1468
applies a transformation to source points, 1884 as a simulation database file, 1468
Rigid Wall scale factor value, 1701
object reference, 1746 scaling
rotate, 147 deformed shape - result context toolbar, 77
rotate - graphics toolbar button, 70 relative - in result context toolbar, 77
rotating force, 1030 scenarios - solving, 1393
object reference, 1746 scope
rotation cursor, 147 conflicts, 1472
rotation cursors, 123 graphics, 160
rotational acceleration results, 1214
description, 934 scope contact region settings - listed and defined, 698
rotational acceleration object reference, 1746 search across global connection setting, 685
rotational order of coordinate systems results, 1167 search for connection duplicate pairs, 691
rotational velocity search object names, 17
description, 931 search the tree, 17
rotational velocity load section plane - drawing/editing in result context toolbar,
object reference, 1746 77
rotational velocity object reference, 1746 section planes
rotordynamics analysis, 465 creating, 154
rotordynamics controls - analysis settings, 913 select mode - body, 70
rough type contact region setting, 701 select mode - edge, 70
rpm - in main menu, 63 select mode - face, 70
rs base excitation select mode - graphics toolbar button, 70
description, 983 select mode - vertex, 70
RS base excitation load selecting
object reference, 1746 mesh nodes on result contour, 140
RS base excitation object reference, 1746 selecting direction, 149
selecting element faces on the mesh, 142
S selecting elements on the mesh, 142
safety factor selecting nodes on the mesh, 137
for maximum equivalent stress safety tool result, selection
1255 box select, 124
for maximum shear stress safety tool result, 1256 extend selection, 124
for maximum tensile stress safety tool result, 1260 extend to adjacent, 124
for Mohr-Coulomb stress safety tool result, 1258 extend to connection, 124
safety factor result extend to limits, 124
[fatigue] description, 1337 filters, 124
[fatigue] object reference, 1692 single select, 124
[stress] description, 1254 selection information window
[stress] object reference, 1826 activating, 37
safety factor result object reference, 1826 export, 47
safety margin overview, 36
for maximum equivalent stress safety tool result, reselect, 47
1255 selection modes and reported information, 38
for maximum shear stress safety tool result, 1256 sort, 47
for maximum tensile stress safety tool result, 1260 toolbar, 43
for Mohr-Coulomb stress safety tool result, 1258 selection utilities toolbar, 74
object reference, 1826 semi-elliptical crack
safety margin result object reference, 1826 object reference, 1813
saving contact region settings - procedure , 728 semi-elliptical crack object reference, 1813

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1974 of ANSYS, Inc. and its subsidiaries and affiliates.
setting contact conditions manually - guidelines and object reference, 1816
procedure, 723 solid construction geometry object reference, 1816
setting variables, 122 Solid Edge
sharp angle tool assigning parameters, 1488
object reference, 1759 solid source conductor body, 1017
sharp angle tool object reference, 1759 SolidWorks
shear elastic strain result assigning parameters, 1488
description, 1875 solution
object reference, 1804 annotations, 160
shear elastic strain result object reference , 1804 context toolbar - screenshot and description, 77
shear force result object reference, 1817
object reference, 1804 solution combination object reference, 1820
shear gasket pressure solution information object reference, 1820
object reference, 1804 solving overview, 1373
shear gasket pressure object reference, 1804 troubleshooting (convergence problems), 1869
shear gasket total closure troubleshooting (general), 1864
object reference, 1804 solution combination
shear gasket total closure object reference, 1804 description, 1370
shear moment diagram, 1277 object reference, 1820
shear stress result troubleshooting, 1869
description, 1229 solution combination object reference, 1820
object reference, 1804 solution coordinate system, 1196
shear stress result object reference, 1804 solution information
shell element results, 1229 description, 1395
show all bodies, 485 object reference, 1820
show body, 485 solution information object reference, 1820
show faces, 485 solution magnitude limit exceeded - troubleshooting
show vertices, 94 , 1856
Simplorer solution object reference, 1817
Pins, 431 solution restarts, 1385
simply supported solve process settings, 1377
Edge: description, 1099 solve status symbol, 8
object reference, 1746 solver - conflicting DOF constraints
Vertex: description, 1099 troubleshooting, 1870-1871
simply supported object reference, 1746 solver component results, 1218
simply supported support solver failure - troubleshooting, 1856
description, 1099 solver pivot checking, 877
simulation wizard - features and types, 170 solver type, 877
single selection, 124 solving
sizing overall analysis step, 191
object reference, 1759 overview, 1373
sizing object reference , 1759 units, 1418
sliding distance result in contact tool solving analysis containing cracks, 1472
description, 1243 solving scenarios, 1393
object reference, 1674 Source Value option
sliding distance result object reference, 1674 for Mapping Validation, 1899
slot joints, 750 spatial displacements, 1149
snap to mesh nodes, 661 spatial load and displacement function data, 1150
solid - construction geometry, 668 spatial load tabular data, 1150
solid bodies, 477 spatial loads, 1149
solid bodies - using, 487 spatially varying displacements, 1149
solid construction geometry spatially varying loads, 1149

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1975
Index

special analysis topics, 402 status symbols , 8


specify offset contact region setting, 706 steady-state thermal analysis type, 344
specifying constant load expressions, 1150 steps
specifying constant load values, 1150 details of equilibrium iterations, 914
specifying load values, 1150 details of steps, 914
specifying surface body layered sections, 494 details of substeps, 914
specifying surface body thickness, 491 guidelines for integration step size, 916
specifying tabular loads, 1150 overall topics, 914
spot weld step controls, 873
object reference, 1821 using multiple steps, 183
using, 828 stiffness
spot weld object reference, 1821 assigning to parts - analysis step, 177
spot welds stiffness behavior
assumptions and restrictions, 828 defining, 480
spring flexible bodies, 481
object reference, 1823 gasket bodies, 482
spring behavior rigid bodies, 481
rigid dynamics analysis settings, 819 stiff beam, 484
spring object reference, 1823 strain energy result
springs description, 1238
applying springs, 819 object reference, 1804
behavior property, 823 strain energy result object reference, 1804
incompatibility, 825 strain-life fatigue, 1323
nonlinear spring stiffness, 821 stranded source conductor body, 1021
pinball region property, 823 strength factor - fatigue simulations, 1332
preload, 822 stress intensity result
results, 1301 description, 1231
scoping, 822 object reference, 1804
using, 818 stress intensity result object reference, 1804
stabilization analysis setting, 900 stress ratio
stabilization energy result for maximum equivalent stress safety tool result,
description, 1237 1255
standard earth gravity for maximum shear stress safety tool result, 1256
description, 929 for maximum tensile stress safety tool result, 1260
standard earth gravity load for Mohr-Coulomb stress safety tool result, 1258
object reference, 1746 object reference, 1826
standard earth gravity object reference, 1746 stress ratio result object reference, 1826
standard toolbar stress tool result object reference, 1804, 1826
commands and descriptions, 69 stress tools
location in the Mechanical application window, 5 how to add, 1254
startup options, 105 listed, 1254
Static Pressure object reference, 1826
object reference, 1746 stress-life fatigue, 1323
static structural analysis type, 339 stress/strain results - overall description, 1229
status bar, 29 structural error result
status bar - location and description in the Mechanical description, 1232
application window, 5 object reference, 1804
status of variables, 122 structural error result object reference, 1804
status result in contact tool structural loads - listed, 938
description, 1243 structural results, 1224
object reference, 1674 submodeling, 433
status result object reference, 1674 beam, 433, 439

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1976 of ANSYS, Inc. and its subsidiaries and affiliates.
introduction, 433 regions, 622
structural, 435 using, 621
thermal, 441 symmetry object reference, 1830
understanding, 433 Symmetry Plane
substructures (RBD Only), 835 object reference, 1746
support loads - listed, 1077 symmetry region
supported function loads, 1150 object reference, 1831
supported tabular loads, 1150 using, 649
supports symmetry region object reference, 1831
types of supports, 922 symmetry regions
suppress all other bodies, 485 types, 622
suppress body, 485 synchronous solutions, 1376
suppress objects, 13
suppress status symbol, 8 T
suppressed contact region setting, 701 tabs
surface location in the Mechanical application window, 5
object reference, 1828 tabular data window, 50
surface - construction geometry, 666 tagging objects, 1626
surface bodies tags
faces with multiple thicknesses and layers specified, applying to objects, 1626
497 creating, 1626
general description, 487 deleting, 1627
importing , 489 filtering, 14
importing thickness, 489 highlighting tree objects, 1627
offsets, 489 renaming, 1627
specifying layered sections, 494 Tags window, 1626
specifying thickness, 491 target bodies scope contact region setting, 698
thickness, 488 target normal search direction contact region setting,
surface body results, 1210 706
surface coating target scope contact region setting, 698
description, 507 temperature
object reference, 1828 description, 989
surface coating object reference, 1828 Temperature (Acoustic)
surface coating results, 1223 object reference, 1746
surface object reference, 1828 temperature load
surface results, 1173 object reference, 1746
scoping, 1218 temperature object reference, 1746
surface temperatures temperature result
at CFD boundary, 423 description, 1312
surface velocity, 1037 object reference, 1804
Surface Velocity temperature result object reference, 1804
object reference, 1746 thermal boundary condition conflicts, 1472
surfaces transferred as solids - troubleshooting, 1859 thermal capacitance, 509
symmetric behavior contact region setting, 701 thermal condition load
symmetric electromechanical symmetry type, 622 object reference, 1746
symmetric structural cyclic symmetry type, 622 thermal condition object reference, 1746
symmetric structural symmetry type, 622 thermal conductance contact region setting, 706
symmetric thermal symmetry type, 622 thermal conductance value contact region setting,706
symmetry thermal contact results, 1315
defining in DesignModeler, 649 thermal error result
defining in Mechanical, 649 object reference, 1804
object reference, 1830 thermal error result object reference, 1804

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1977
Index

thermal fluid flow rate result topology elemental density result object reference,
thermal result, 1313 1804
thermal fluid flow rate results object reference, 1804 topology optimization
thermal fluid heat conduction rate result objective worksheet, 365
thermal result, 1313 solution methodology, 368
thermal fluid heat conduction rate results object refer- solver methods, 368
ence, 1804 topology density result, 371
thermal loads - listed, 938 topology elemental density result, 373
thermal point mass topology optimization analysis, 352
description, 509 design validation, 378
object reference, 1832 preparation, 354
thermal point mass object reference, 1832 solve and results, 375
thermal results, 1311 torsional moment result
contact results, 1315 object reference, 1804
thermal steady-state analysis type, 344 total acceleration result
thermal strain effects description, 1226
assigning to parts - analysis step, 177 object reference, 1804
thermal strain result, 1234 total acceleration result object reference, 1804
thermal-electric analysis type, 348 total current density result
thermal-stress analyses, 459 object reference, 1804
thermal/structural loads total deformation result
importing, 403 description, 1226
thermal/structural results object reference, 1804
exporting, 410 total deformation result object reference , 1804
Thermo-Viscous BLI Boundary total electric field intensity result
object reference, 1746 object reference, 1804
thickness total field intensity result
object reference, 1834 object reference, 1804
thickness object reference, 1834 total field intensity result object reference , 1804
time total flux density result
role in analysis settings, 914 object reference, 1804
tips working with charts and graphics, 151 total flux density result object reference, 1804
tolerance slider global connection setting, 685 total force electromagnetic result
tolerance type global connection setting, 685 description, 1317
tolerance value global connection setting, 685 object reference, 1804
toolbars total force result object reference, 1804
context - overall description and listing, 77 total heat flux result
edge graphics options, 97 description, 1312
explode view options - screenshot and description, object reference, 1804
99 total heat flux result object reference, 1804
graphics - commands and descriptions, 70 total magnetic field intensity result
graphics option, 94 description, 1317
joint configure - screenshot and description, 100 total magnetic flux density result
main menu - commands and descriptions, 63 description, 1317
named selection, 94 total strain - equivalent, 1235
overall description, 68 total velocity result
standard - commands and descriptions, 69 description, 1226
tree filter - screenshot and description, 100 object reference, 1804
unit conversion, 94 total velocity result object reference, 1804
topics - special analysis, 402 transfer
topology density result object reference, 1804 volumetric temperature, 424
Transfer Admittance Matrix

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1978 of ANSYS, Inc. and its subsidiaries and affiliates.
object reference, 1746 V
transferring coordinate systems to the Mechanical APDL validation
application, 679 object reference, 1838
transient structural analysis linked to modal, 394 validation object reference, 1838
transient structural analysis type, 384 variable
transient thermal analysis type, 397 parameterizing, 26
translational joints, 750 setting, 122
transparency for joints, 814 status, 122
tree varying displacements, 1149
filtering, 14 varying loads, 1149
search, 17 vector heat flux result plots, 1312
tree filter toolbar vector plot result display, 1185
screenshot and description, 100 vector principal elastic strain result object reference,
tree objects 1804
generating from template object, 1621 vector principal stress result object reference, 1804
grouping, 100 vector principal stress/elastic strain result
highlighting tagged objects, 1627 description, 1232
tree outline, 7 object reference, 1804
conventions and status symbols, 8 velocity
go to options, 10 object reference, 1840
location in the Mechanical application window, 5 velocity object reference, 1840
trim contact, 701 velocity support
troubleshooting description, 1091
listing of overall problem situations, 1851 view results during solve, 1404
two vertices direction, 1150 viewing selected columns for contact - worksheet, 48
type contact region setting, 701 viewports
description, 150
U graphics toolbar button, 70
u. s. customary units - in main menu, 63 virtual body
unaveraged contour results , 1200 object reference, 1841
underconstrained parts - troubleshooting, 1862 virtual body group
underdefined status symbol, 8 object reference, 1843
unit conversion toolbar, 94 virtual body group object reference, 1843
location in the Mechanical application window, 5 virtual body object reference, 1841
unit system behavior, 173 virtual cell
units - fatigue user life, 1332 object reference, 1844
units - solving, 1418 virtual cell object reference, 1844
universal joints, 750 virtual hard vertex
unsuppress all bodies, 485 object reference, 1845
unsuppress body, 485 virtual hard vertex object reference, 1845
unsuppress objects, 13 virtual split edge
update status symbol, 8 object reference, 1845
update stiffness contact region setting, 706 virtual split edge object reference, 1845
updating geometry , 174 virtual split face
use range global connection setting, 685 object reference, 1846
user defined result virtual split face object reference, 1846
description, 1340 virtual topology
object reference, 1804 context toolbar - screenshot and description, 77
user interactions - details view, 17 in Mechanical, 183
user preferences file, 105 object reference, 1847
virtual topology object reference, 1847
visibility - analysis settings, 913

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1979
Index

voltage
description, 1010
voltage excitation for solid conductors
voltage object reference, 1746
voltage excitation for solid source conductors
description, 1019
voltage object reference, 1746
volume constraint - topology optimization
description, 362
von Mises stress result, 1230

W
weak springs analysis setting, 877
window
geometry, 26
overall layout and component description, 5
windows manager, 6
wireframe - graphics toolbar button, 70
wizards
description and screen location, 169
options, 105
simulation wizard - features and types, 170
workbench
conflicts with the Mechanical APDL application when
using commands objects, 1479
workflows
fracture analysis, 841
working load result in bolt tool
description, 1274
working with charts and graphics, 151
worksheet
connections, 682
go to selected items, 48
go to selected items in tree, 48
information display, 48
viewing selected columns for contact, 48
writing and reading files, 1468

Z
zoom, 147
zoom - graphics toolbar button, 70

Release 18.2 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1980 of ANSYS, Inc. and its subsidiaries and affiliates.

You might also like