0% found this document useful (0 votes)
56 views4,982 pages

Ansys ACT API Reference Guide

The ACT API Reference Guide for ANSYS Release 2025 R1 provides detailed documentation on various namespaces, classes, and methods available in the API. It includes information on data models, utilities, materials, graphics, and user interfaces, along with legal disclaimers and copyright information. The guide serves as a comprehensive resource for developers using the ANSYS API for customization and integration.

Uploaded by

banimjun
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
56 views4,982 pages

Ansys ACT API Reference Guide

The ACT API Reference Guide for ANSYS Release 2025 R1 provides detailed documentation on various namespaces, classes, and methods available in the API. It includes information on data models, utilities, materials, graphics, and user interfaces, along with legal disclaimers and copyright information. The guide serves as a comprehensive resource for developers using the ANSYS API for customization and integration.

Uploaded by

banimjun
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4982

ACT API Reference Guide

ANSYS, Inc. Release 2025 R1


Southpointe January 2025
2600 Ansys Drive Ansys Customization
Canonsburg, PA 15317 ANSYS, Inc. and
[email protected] ANSYS Europe,
Ltd. are UL
http://www.ansys.com registered ISO
(T) 724-746-3304 9001: 2015
(F) 724-514-9494 companies.
Copyright and Trademark Information

© 2025 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: 2015 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.


Table of Contents
Namespaces ................................................................................................................................................ 1
Ansys.ACT.Core Namespace ................................................................................................................. 3
ExtensionId ...................................................................................................................................... 3
UniqueId .................................................................................................................................... 3
ProcessUtilities ................................................................................................................................. 3
Start(string, params string[]) ........................................................................................................ 4
Start(string, bool, params string[]) ............................................................................................... 4
Ansys.ACT.Core.Application.DataModel Namespace .......................................................................... 5
IDataModelProvider .......................................................................................................................... 5
DataModel ................................................................................................................................. 5
Ansys.ACT.Core.Utilities Namespace .................................................................................................... 7
AttributeCollection ........................................................................................................................... 7
Item(string) ................................................................................................................................ 7
Keys ........................................................................................................................................... 8
Clone() ....................................................................................................................................... 8
Contains(string) .......................................................................................................................... 8
GetStringValue(string) ................................................................................................................ 8
GetValue(string) ......................................................................................................................... 8
GetValue(string, object) .............................................................................................................. 9
Remove(string) ........................................................................................................................... 9
SetValue(string, object) ............................................................................................................... 9
NamedCollection<T> ..................................................................................................................... 10
Item(string) .............................................................................................................................. 10
Names ...................................................................................................................................... 10
Ansys.Mechanical.Selection Namespace ........................................................................................... 11
GeometryRayCastHit ...................................................................................................................... 11
Entity ....................................................................................................................................... 11
HitVector .................................................................................................................................. 11
GeometryRayCastSettings .............................................................................................................. 12
GeometryRayCastSettings() ...................................................................................................... 12
CastLength ............................................................................................................................... 12
CastRadius ............................................................................................................................... 12
HitBodies ................................................................................................................................. 13
HitEdges ................................................................................................................................... 13
HitFaces ................................................................................................................................... 13
HitVertices ................................................................................................................................ 13
MaxHits .................................................................................................................................... 13
SelectionHelper .............................................................................................................................. 13
CastRayOnGeometry(BoundVector, GeometryRayCastSettings) ................................................. 14
CreateVector3D(ISelectionInfo, bool) ......................................................................................... 14
Ansys.Mechanical.Math Namespace .................................................................................................. 17
BoundVector .................................................................................................................................. 17
BoundVector(Point, Vector3D) ................................................................................................... 17
Origin ....................................................................................................................................... 18
Vector ...................................................................................................................................... 18
Ansys.Mechanical.UI.Enums Namespace ........................................................................................... 19
ThemeName ................................................................................................................................... 19
Ansys.Mechanical.UI.Interfaces Namespace ...................................................................................... 21
IMechanicalTheme ......................................................................................................................... 21

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
ACT API Reference Guide

ColorPalette ............................................................................................................................. 21
HexadecimalPalette .................................................................................................................. 22
IntPalette .................................................................................................................................. 22
Name ....................................................................................................................................... 22
IMechanicalUserInterface ................................................................................................................ 22
Theme ...................................................................................................................................... 22
Ansys.Mechanical.Table Namespace .................................................................................................. 23
ColumnarDataImportDefinition ...................................................................................................... 23
ColumnarDataImportDefinition(int, VariableType, VariableClassification, string, string) ................ 24
Index ........................................................................................................................................ 24
Name ....................................................................................................................................... 24
Unit .......................................................................................................................................... 25
VariableClassification ................................................................................................................ 25
VariableType ............................................................................................................................. 25
DelimitedImportSettings ................................................................................................................ 25
Delimiter .................................................................................................................................. 25
FixedWidthImportSettings .............................................................................................................. 26
ColumnWidths ......................................................................................................................... 26
ImportHelpers ................................................................................................................................ 27
ImportSettingsBase ........................................................................................................................ 27
Format ..................................................................................................................................... 27
PathType .................................................................................................................................. 27
ImportSettingsFactory .................................................................................................................... 28
GetSettingsForFormat(ImportFormat) ....................................................................................... 28
Ansys.Mechanical.Application Namespace ........................................................................................ 29
Message ......................................................................................................................................... 29
DisplayString ............................................................................................................................ 29
Location ................................................................................................................................... 30
RelatedObjects ......................................................................................................................... 30
Severity .................................................................................................................................... 30
Source ...................................................................................................................................... 30
StringID .................................................................................................................................... 30
TimeStamp ............................................................................................................................... 30
Messages ....................................................................................................................................... 31
Count ....................................................................................................................................... 31
Add(Message) .......................................................................................................................... 31
Clear() ...................................................................................................................................... 31
Contains(Message) ................................................................................................................... 32
Remove(Message) .................................................................................................................... 32
ShowErrors() ............................................................................................................................. 32
ObjectTag ....................................................................................................................................... 32
ObjectTag(string) ...................................................................................................................... 33
Name ....................................................................................................................................... 33
Objects .................................................................................................................................... 33
AddObject(IDataModelObject) ................................................................................................. 33
ClearObjects() ........................................................................................................................... 34
RemoveObject(IDataModelObject) ........................................................................................... 34
ObjectTags ..................................................................................................................................... 34
Count ....................................................................................................................................... 35
Item(int) ................................................................................................................................... 35
Item(string) .............................................................................................................................. 35

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
iv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

TagNames ................................................................................................................................ 35
Add(ObjectTag) ........................................................................................................................ 35
Clear() ...................................................................................................................................... 36
Contains(ObjectTag) ................................................................................................................. 36
GetTag(string) .......................................................................................................................... 36
IndexOf(ObjectTag) .................................................................................................................. 36
Remove(ObjectTag) .................................................................................................................. 37
RemoveAt(int) .......................................................................................................................... 37
Progress ......................................................................................................................................... 37
SetProgress(uint, string, uint, string) ........................................................................................... 38
Ansys.Mechanical.Materials Namespace ........................................................................................... 39
ImportSettings ............................................................................................................................... 39
Operation ................................................................................................................................. 39
PrimaryIdentifierType ............................................................................................................... 39
Filter ......................................................................................................................................... 40
Ansys.Mechanical.ExternalData Namespace ..................................................................................... 41
AXDTImportSettings ....................................................................................................................... 41
Dimension ................................................................................................................................ 42
ColumnarDataImportDefinition ...................................................................................................... 42
ColumnarDataImportDefinition(int, VariableType, string, string, string) ....................................... 42
Index ........................................................................................................................................ 43
Name ....................................................................................................................................... 43
Unit .......................................................................................................................................... 43
UserFieldVariable ...................................................................................................................... 44
VariableType ............................................................................................................................. 44
ColumnarDataSourceBase .............................................................................................................. 44
Count ....................................................................................................................................... 45
Item(int) ................................................................................................................................... 45
SkipFooter ................................................................................................................................ 45
SkipRows .................................................................................................................................. 45
Clear() ...................................................................................................................................... 45
GetEnumerator() ....................................................................................................................... 46
RemoveAt(int) .......................................................................................................................... 46
UseColumn(int, VariableType, string, string) ............................................................................... 46
DelimitedImportSettings ................................................................................................................ 47
AverageCornerNodesToMidsideNodes ...................................................................................... 48
Delimiter .................................................................................................................................. 48
ECADImportSettings ....................................................................................................................... 48
UseDummyNetData .................................................................................................................. 48
ExternalDataFile ............................................................................................................................. 49
ExternalDataFile(ImportSettingsBase, string, string, string, bool, bool) ......................................... 50
Description ............................................................................................................................... 50
FilePath .................................................................................................................................... 51
Identifier .................................................................................................................................. 51
ImportSettings ......................................................................................................................... 51
IsMainFile ................................................................................................................................. 51
ExternalDataFileCollection .............................................................................................................. 51
ExternalDataFileCollection(bool) ............................................................................................... 52
Count ....................................................................................................................................... 52
Item(int) ................................................................................................................................... 53
SaveFilesWithProject ................................................................................................................ 53

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. v
ACT API Reference Guide

Add(ExternalDataFile) ............................................................................................................... 53
Clear() ...................................................................................................................................... 53
Contains(ExternalDataFile) ........................................................................................................ 53
CopyTo(ExternalDataFile[], int) .................................................................................................. 54
GetEnumerator() ....................................................................................................................... 54
IndexOf(ExternalDataFile) ......................................................................................................... 54
Insert(int, ExternalDataFile) ....................................................................................................... 55
Remove(ExternalDataFile) ......................................................................................................... 55
RemoveAt(int) .......................................................................................................................... 55
FixedWidthImportSettings .............................................................................................................. 56
AverageCornerNodesToMidsideNodes ...................................................................................... 57
ColumnWidths ......................................................................................................................... 57
ICEPAKImportSettings ..................................................................................................................... 58
SupportingFileDescription ........................................................................................................ 58
SupportingFileIdentifier ............................................................................................................ 58
SupportingFilePath ................................................................................................................... 58
ImportSettingsBase ........................................................................................................................ 59
Format ..................................................................................................................................... 59
ImportSettingsFactory .................................................................................................................... 59
GetSettingsForFormat(ImportFormat) ....................................................................................... 59
MAPDLImportSettings .................................................................................................................... 60
Dimension ................................................................................................................................ 60
LengthUnit ............................................................................................................................... 60
Ansys.Mechanical.Graphics Namespace ............................................................................................ 61
AnalysisSettingsGraph .................................................................................................................... 61
BoundaryConditionVisibility ..................................................................................................... 62
AnimationExportSettings ................................................................................................................ 62
AnimationExportSettings(int, int) .............................................................................................. 62
Height ...................................................................................................................................... 62
Width ....................................................................................................................................... 63
AnnotationPreferences ................................................................................................................... 63
PointMassSize ........................................................................................................................... 64
ShowAllAnnotations ................................................................................................................. 64
ShowBeams .............................................................................................................................. 64
ShowBearings .......................................................................................................................... 64
ShowBodyScopings .................................................................................................................. 64
ShowCracks .............................................................................................................................. 64
ShowCustomAnnotations ......................................................................................................... 65
ShowElementNumbers ............................................................................................................. 65
ShowForceArrows ..................................................................................................................... 65
ShowLabels .............................................................................................................................. 65
ShowMeshAnnotations ............................................................................................................. 65
ShowNamedSelectionElements ................................................................................................ 65
ShowNodeNumbers ................................................................................................................. 66
ShowPointMasses ..................................................................................................................... 66
ShowSprings ............................................................................................................................ 66
SpringSize ................................................................................................................................ 66
SetElementNumbering(int, int, int) ............................................................................................ 66
SetNodeNumbering(int, int, int) ................................................................................................. 67
GlobalLegendSettings .................................................................................................................... 67
LegendOrientation ................................................................................................................... 67

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
vi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

ShowDateAndTime ................................................................................................................... 68
ShowDeformingScaling ............................................................................................................ 68
ShowMinMax ........................................................................................................................... 68
Graphics3DExportSettings .............................................................................................................. 68
Graphics3DExportSettings() ...................................................................................................... 68
Background .............................................................................................................................. 69
GraphicsImageExportSettings ......................................................................................................... 69
GraphicsImageExportSettings() ................................................................................................. 70
AppendGraph .......................................................................................................................... 70
Background .............................................................................................................................. 70
Capture .................................................................................................................................... 70
CurrentGraphicsDisplay ............................................................................................................ 70
FontMagnification .................................................................................................................... 70
Height ...................................................................................................................................... 71
Resolution ................................................................................................................................ 71
Width ....................................................................................................................................... 71
GraphicsViewportsExportSettings ................................................................................................... 71
GraphicsViewportsExportSettings() ........................................................................................... 73
BorderStyle .............................................................................................................................. 73
Point .............................................................................................................................................. 73
Point(IList<object>, string) ........................................................................................................ 73
Location ................................................................................................................................... 74
Unit .......................................................................................................................................... 74
ConvertUnit(Point, string) ......................................................................................................... 74
Equals(object) .......................................................................................................................... 74
GetHashCode() ......................................................................................................................... 75
op_Equality(Point, Point) ........................................................................................................... 75
op_Inequality(Point, Point) ........................................................................................................ 75
ResultAnimationOptions ................................................................................................................. 76
DisplacementTraces .................................................................................................................. 76
Duration ................................................................................................................................... 76
FitDeformationScalingToAnimation .......................................................................................... 77
NumberOfFrames ..................................................................................................................... 77
RangeType ............................................................................................................................... 77
TimeDecay ............................................................................................................................... 77
TimeDecayCycles ...................................................................................................................... 77
UpdateContourRangeAtEachFrame .......................................................................................... 77
ResultPreference ............................................................................................................................. 78
CappingType ............................................................................................................................ 78
ContourView ............................................................................................................................ 78
DeformationScaleMultiplier ...................................................................................................... 78
DeformationScaling .................................................................................................................. 79
ExtraModelDisplay .................................................................................................................... 79
GeometryView ......................................................................................................................... 79
IsoSurfaceValue ........................................................................................................................ 79
ScopingDisplay ......................................................................................................................... 79
ShowMaximum ........................................................................................................................ 79
ShowMinimum ......................................................................................................................... 80
SectionPlane .................................................................................................................................. 80
SectionPlane() .......................................................................................................................... 80
SectionPlane(Point, Vector3D, string, SectionPlaneType, bool) .................................................... 80

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. vii
ACT API Reference Guide

Active ....................................................................................................................................... 81
Center ...................................................................................................................................... 81
Direction .................................................................................................................................. 81
Name ....................................................................................................................................... 82
Type ......................................................................................................................................... 82
Equals(SectionPlane) ................................................................................................................ 82
SectionPlanes ................................................................................................................................. 82
Capping ................................................................................................................................... 83
Count ....................................................................................................................................... 83
ShowWholeElement ................................................................................................................. 83
Add(SectionPlane) .................................................................................................................... 83
Clear() ...................................................................................................................................... 83
Remove(SectionPlane) .............................................................................................................. 84
RemoveAt(int) .......................................................................................................................... 84
VectorDisplay ................................................................................................................................. 84
ControlDisplayDensity .............................................................................................................. 85
DisplayDensity ......................................................................................................................... 85
DisplayType .............................................................................................................................. 85
LengthMultiplier ....................................................................................................................... 85
LengthType .............................................................................................................................. 85
ShowTriadXAxis ........................................................................................................................ 86
ShowTriadYAxis ........................................................................................................................ 86
ShowTriadZAxis ........................................................................................................................ 86
ViewOptions ................................................................................................................................... 86
AnnotationPreferences ............................................................................................................. 87
ClusteredVertexTolerance ......................................................................................................... 87
DisplayGraphOverlay ................................................................................................................ 87
ModelColoring ......................................................................................................................... 87
ModelDisplay ........................................................................................................................... 88
ResultPreference ....................................................................................................................... 88
ShowBeamThickness ................................................................................................................ 88
ShowClusteredVertices ............................................................................................................. 88
ShowCoordinateSystems .......................................................................................................... 88
ShowEdgeDirection .................................................................................................................. 88
ShowLegend ............................................................................................................................ 89
ShowMesh ............................................................................................................................... 89
ShowMeshConnection .............................................................................................................. 89
ShowRandomColors ................................................................................................................. 89
ShowRemotePointConnections ................................................................................................. 89
ShowResultVectors ................................................................................................................... 89
ShowRuler ................................................................................................................................ 90
ShowShellThickness ................................................................................................................. 90
ShowSPHExpansion .................................................................................................................. 90
ShowThickEdgeScoping ........................................................................................................... 90
ShowTriad ................................................................................................................................ 90
ShowVertices ............................................................................................................................ 90
VectorDisplay ........................................................................................................................... 91
RescaleAnnotations() ................................................................................................................ 91
Ansys.Mechanical.Graphics.Tools Namespace ................................................................................... 93
CurrentLegendSettings ................................................................................................................... 93
AllScientificNotation ................................................................................................................. 94

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
viii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

ColorScheme ............................................................................................................................ 94
Digits ....................................................................................................................................... 94
HighFidelity .............................................................................................................................. 94
LogarithmicScale ...................................................................................................................... 95
NumberOfBands ....................................................................................................................... 95
SemiTransparency .................................................................................................................... 95
GetBandColor(int) ..................................................................................................................... 95
GetBandColorAuto(int) ............................................................................................................. 95
GetLowerBandValueAuto(int) ................................................................................................... 96
GetLowerBound(int) ................................................................................................................. 96
GetUpperBandValueAuto(int) ................................................................................................... 96
GetUpperBound(int) ................................................................................................................. 97
MakeCopy() .............................................................................................................................. 97
Reset() ...................................................................................................................................... 97
ResetColors() ............................................................................................................................ 97
SetBandColor(int, uint) .............................................................................................................. 97
SetBandColorAuto(int, bool) ..................................................................................................... 98
SetLowerBound(int, Quantity) ................................................................................................... 98
SetUpperBound(int, Quantity) ................................................................................................... 98
LegendSettings .............................................................................................................................. 99
AllScientificNotation ............................................................................................................... 100
ColorScheme .......................................................................................................................... 100
Digits ..................................................................................................................................... 100
HighFidelity ............................................................................................................................ 100
LogarithmicScale .................................................................................................................... 100
NumberOfBands ..................................................................................................................... 101
SemiTransparency .................................................................................................................. 101
Unit ........................................................................................................................................ 101
GetBandColor(int) ................................................................................................................... 101
GetBandColorAuto(int) ........................................................................................................... 101
GetLowerBandValueAuto(int) .................................................................................................. 102
GetLowerBound(int) ............................................................................................................... 102
GetUpperBandValueAuto(int) ................................................................................................. 102
GetUpperBound(int) ............................................................................................................... 103
Reset() .................................................................................................................................... 103
ResetColors() .......................................................................................................................... 103
SetBandColor(int, uint) ............................................................................................................ 103
SetBandColorAuto(int, bool) .................................................................................................... 104
SetLowerBound(int, Quantity) ................................................................................................. 104
SetUpperBound(int, Quantity) ................................................................................................. 104
Ansys.Mechanical.DataModel.ConstructionLines Namespace ........................................................ 107
ConstructionLineHelper ................................................................................................................ 107
ClearExistingDataAndImportFromXML(ConstructionLine, string) ............................................. 108
ExportToXML(ConstructionLine, string) ................................................................................... 108
GetContainedEdges(Plane) ..................................................................................................... 109
GetEdgesById(ConstructionLine, IEnumerable<int>) ................................................................ 109
GetEdgesUsingPoint(Point) ..................................................................................................... 109
GetEdgeVerticesById(ConstructionLine, IEnumerable<int>) ..................................................... 109
GetPlanesById(ConstructionLine, IEnumerable<int>) ............................................................... 110
GetRelatedEdges(Plane) .......................................................................................................... 110
Plane ............................................................................................................................................ 111

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. ix
ACT API Reference Guide

Definition ............................................................................................................................... 111


Normal ................................................................................................................................... 111
Origin ..................................................................................................................................... 111
PrimaryAxisDirection .............................................................................................................. 112
SecondaryAxisDirection .......................................................................................................... 112
Type ....................................................................................................................................... 112
Equivalent(Plane) .................................................................................................................... 112
PlaneType ..................................................................................................................................... 112
Point ............................................................................................................................................ 113
Definition ............................................................................................................................... 113
Location ................................................................................................................................. 113
Type ....................................................................................................................................... 113
Equivalent(Point) .................................................................................................................... 113
Point2DPlanar .............................................................................................................................. 114
Point2DPlanar(Point2DPlanar) ................................................................................................. 114
Point2DPlanar(Point2D, Plane) ................................................................................................. 114
Location ................................................................................................................................. 115
Plane ...................................................................................................................................... 115
GetGlobalLocation(Point2DPlanar) .......................................................................................... 115
PointType ..................................................................................................................................... 115
Ansys.Mechanical.DataModel.ConstructionLines.Edges Namespace ............................................. 117
IEdge ............................................................................................................................................ 117
Length ................................................................................................................................... 117
StraightLineEdge .......................................................................................................................... 117
EndPoint ................................................................................................................................ 118
Length ................................................................................................................................... 118
StartPoint ............................................................................................................................... 118
Ansys.ACT.DesignModeler.Primitives.Sheet Namespace ................................................................. 119
Cylinder ........................................................................................................................................ 119
Cylinder(GeometryBuilder, IEnumerable<double>, IEnumerable<double>, double) .................. 119
Center .................................................................................................................................... 120
Direction ................................................................................................................................ 120
Radius .................................................................................................................................... 120
Generate() .............................................................................................................................. 120
Ansys.ACT.Mechanical Namespace ................................................................................................... 121
Transaction ................................................................................................................................... 121
UnitsHelper .................................................................................................................................. 121
ConvertMechanicalUnitToCoreUnit(string, string) .................................................................... 121
GetValidQuantityNamesAndUnits() ......................................................................................... 122
Ansys.ACT.Mechanical.Fields Namespace ........................................................................................ 123
Field ............................................................................................................................................. 123
Inputs ..................................................................................................................................... 123
Name ..................................................................................................................................... 124
Output ................................................................................................................................... 124
Range ........................................................................................................................................... 124
Maximum ............................................................................................................................... 124
Minimum ............................................................................................................................... 124
Variable ........................................................................................................................................ 125
DefinitionType ........................................................................................................................ 125
DiscreteValueCount ................................................................................................................ 126
DiscreteValues ........................................................................................................................ 126

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
x of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Field ....................................................................................................................................... 126


Formula .................................................................................................................................. 126
Index ...................................................................................................................................... 126
IsInput .................................................................................................................................... 127
IsOutput ................................................................................................................................. 127
MinMaxDiscreteValues ............................................................................................................ 127
Name ..................................................................................................................................... 127
QuantityName ........................................................................................................................ 127
Range ..................................................................................................................................... 127
Unit ........................................................................................................................................ 128
GetDiscreteValue(int) .............................................................................................................. 128
SetDiscreteValue(int, Quantity) ................................................................................................ 128
VariableDefinitionType ................................................................................................................. 128
Ansys.ACT.Mechanical.Fields.Adapters Namespace ........................................................................ 131
FieldAdapter ................................................................................................................................. 131
FieldAdapter(IDSBCInformation) ............................................................................................. 131
FieldProvider .......................................................................................................................... 132
ChangeFieldDefinitionType(AnsBCLVType, kEDDataType) ........................................................ 132
IDefinition .............................................................................................................................. 132
Adapt(IDSBCInformation) .................................................................................................. 133
Keywords ............................................................................................................................... 133
Constant ........................................................................................................................... 133
ConstantRamped .............................................................................................................. 133
Free .................................................................................................................................. 134
Function ........................................................................................................................... 134
Table ................................................................................................................................ 134
Get(kEDDataType) ............................................................................................................ 134
FieldAdapterManager ................................................................................................................... 134
AdapterDefinitions ................................................................................................................. 135
RegisterNewAdapter(IDefinition) ............................................................................................ 135
UnregisterAdapter(int) ............................................................................................................ 135
Ansys.ACT.Mechanical.Utilities Namespace ..................................................................................... 137
GeometryImportPreferences ......................................................................................................... 137
AnalysisType ........................................................................................................................... 139
AttributeKey ........................................................................................................................... 139
CADAssociativity .................................................................................................................... 139
Clean ...................................................................................................................................... 139
ComparePartsOnUpdate ......................................................................................................... 139
ComparePartsTolerance .......................................................................................................... 139
CoordinateSystemKey ............................................................................................................. 140
DecomposeDisjointGeometry ................................................................................................. 140
DoSmartUpdate ..................................................................................................................... 140
EnclosureSymmetryProcessing ............................................................................................... 140
FacetQuality ........................................................................................................................... 140
MixedImportResolution .......................................................................................................... 141
NamedSelectionKey ............................................................................................................... 141
ProcessAttributes .................................................................................................................... 141
ProcessCoordinateSystems ..................................................................................................... 141
ProcessInstances ..................................................................................................................... 141
ProcessLines ........................................................................................................................... 141
ProcessMaterialProperties ....................................................................................................... 142

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xi
ACT API Reference Guide

ProcessNamedSelections ........................................................................................................ 142


ProcessSolids .......................................................................................................................... 142
ProcessSurfaces ...................................................................................................................... 142
ProcessWorkPoints .................................................................................................................. 142
ReaderSaveFile ....................................................................................................................... 142
StitchTolerance ....................................................................................................................... 143
StitchType .............................................................................................................................. 143
Ansys.ACT.Mechanical.Application.SolveProcessSettings Namespace ........................................... 145
ILinuxSettings ............................................................................................................................... 145
Active ..................................................................................................................................... 146
UserName .............................................................................................................................. 146
WorkingFolder ........................................................................................................................ 146
IQueueSettings ............................................................................................................................. 146
DCSPassword ......................................................................................................................... 146
DCSUrl ................................................................................................................................... 147
DCSUsername ........................................................................................................................ 147
JobName ................................................................................................................................ 147
License ................................................................................................................................... 147
Name ..................................................................................................................................... 147
SolutionExecutionTarget ......................................................................................................... 147
ISolveConfiguration ...................................................................................................................... 148
Default ................................................................................................................................... 148
Name ..................................................................................................................................... 148
Settings .................................................................................................................................. 148
SolveProcessSettings .............................................................................................................. 149
SetAsDefault() ........................................................................................................................ 149
ISolveProcessSettings ................................................................................................................... 149
AdditionalCommandLineArguments ....................................................................................... 150
CustomExecutablePath ........................................................................................................... 150
DCSAutoDownloadResults ...................................................................................................... 150
DistributeSolution .................................................................................................................. 150
GPUAccelerationDevice .......................................................................................................... 150
HybridParallel ......................................................................................................................... 151
LicenseQueuing ...................................................................................................................... 151
ManualLinuxSettings .............................................................................................................. 151
ManualSolverMemorySettings ................................................................................................ 151
MaxNumberOfCores ............................................................................................................... 151
NumberOfGPUDevices ............................................................................................................ 151
NumberOfProcesses ............................................................................................................... 152
SolveInSynchronousMode ...................................................................................................... 152
ThreadsPerProcess .................................................................................................................. 152
UserString .............................................................................................................................. 152
UseSharedLicense ................................................................................................................... 152
ISolverMemorySettings ................................................................................................................. 152
Active ..................................................................................................................................... 153
Database ................................................................................................................................ 153
Workspace .............................................................................................................................. 153
LinuxSettings ............................................................................................................................... 153
LinuxSettings() ....................................................................................................................... 154
Active ..................................................................................................................................... 154
UserName .............................................................................................................................. 154

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

WorkingFolder ........................................................................................................................ 154


QueueSettings .............................................................................................................................. 154
QueueSettings() ..................................................................................................................... 155
JobName ................................................................................................................................ 155
License ................................................................................................................................... 155
Name ..................................................................................................................................... 155
RSMQueue ................................................................................................................................... 155
HPCConfiguration ................................................................................................................... 156
HPCQueue .............................................................................................................................. 156
HPCType ................................................................................................................................. 156
Name ..................................................................................................................................... 156
SolveConfiguration ....................................................................................................................... 156
SolveConfiguration() ............................................................................................................... 157
SolveConfiguration(string) ...................................................................................................... 157
Default ................................................................................................................................... 157
Name ..................................................................................................................................... 158
Settings .................................................................................................................................. 158
SolveProcessSettings .............................................................................................................. 158
SetAsDefault() ........................................................................................................................ 158
SolveProcessSettings .................................................................................................................... 158
SolveProcessSettings() ............................................................................................................ 159
AdditionalCommandLineArguments ....................................................................................... 159
CustomExecutablePath ........................................................................................................... 159
DCSAutoDownloadResults ...................................................................................................... 160
DistributeSolution .................................................................................................................. 160
GPUAccelerationDevice .......................................................................................................... 160
HybridParallel ......................................................................................................................... 160
LicenseQueuing ...................................................................................................................... 160
ManualLinuxSettings .............................................................................................................. 160
ManualSolverMemorySettings ................................................................................................ 161
MaxNumberOfCores ............................................................................................................... 161
NumberOfGPUDevices ............................................................................................................ 161
NumberOfProcesses ............................................................................................................... 161
SolveInSynchronousMode ...................................................................................................... 161
ThreadsPerProcess .................................................................................................................. 161
UseSharedLicense ................................................................................................................... 162
SolverMemorySettings ................................................................................................................. 162
SolverMemorySettings() ......................................................................................................... 162
Active ..................................................................................................................................... 162
Database ................................................................................................................................ 162
Workspace .............................................................................................................................. 163
Ansys.ACT.Mechanical.AdditionalProperties Namespace ............................................................... 165
ApplyCancelProperty .................................................................................................................... 165
OnApply ................................................................................................................................. 165
Control ......................................................................................................................................... 165
DoubleProperty ............................................................................................................................ 166
ValidRange ............................................................................................................................. 166
ExpressionProperty ....................................................................................................................... 166
OptionsProperty ........................................................................................................................... 166
GetOptionsCallback ................................................................................................................ 167
Options .................................................................................................................................. 167

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xiii
ACT API Reference Guide

Ansys.ACT.Interfaces.DesignModeler Namespace ........................................................................... 169


IDesignModelerDataModel ........................................................................................................... 170
Components .......................................................................................................................... 170
GeoData ................................................................................................................................. 170
GeometryBuilder .................................................................................................................... 171
Queries ................................................................................................................................... 171
ComponentById(int) ............................................................................................................... 171
CurrentUnitFromQuantityName(string) ................................................................................... 171
IDesignModelerExtAPI .................................................................................................................. 171
IDesignModelerGeoData ............................................................................................................... 172
Bodies .................................................................................................................................... 172
Parts ....................................................................................................................................... 172
IDesignModelerGeoFeature .......................................................................................................... 172
Bodies .................................................................................................................................... 173
MaterialType ........................................................................................................................... 173
AddProblematicGeometry(IEnumerable<IPSGeoEntity>, string) ............................................... 173
IDesignModelerSelectionInfo ........................................................................................................ 173
Entities ................................................................................................................................... 174
Locations ................................................................................................................................ 174
IExtrude ........................................................................................................................................ 174
Depth ..................................................................................................................................... 174
Direction ................................................................................................................................ 175
Walled .................................................................................................................................... 175
ApplyTo(IPSGeoEntity) ............................................................................................................ 175
IGeometryBuilder ......................................................................................................................... 175
Operations ............................................................................................................................. 176
Primitives ............................................................................................................................... 176
IIntersect ...................................................................................................................................... 176
ApplyTo(IEnumerable<IPSGeoBody>) ..................................................................................... 176
IOperations .................................................................................................................................. 176
Queries ................................................................................................................................... 177
Tools ...................................................................................................................................... 177
CreateExtrudeOperation(IEnumerable<double>, double) ........................................................ 177
CreateIntersectOperation(IEnumerable<IPSGeoBody>) ........................................................... 178
CreateRevolveOperation(IEnumerable<double>, IEnumerable<double>) ................................ 178
CreateSubtractOperation(IEnumerable<IPSGeoBody>) ........................................................... 178
CreateUnionOperation() ......................................................................................................... 179
IOperationTools ............................................................................................................................ 179
CopyBody(IPSGeoBody) .......................................................................................................... 180
CreatePart(IEnumerable<IPSGeoBody>) .................................................................................. 180
DeleteBody(IPSGeoBody) ........................................................................................................ 180
EdgesToWireBody(IEnumerable<IPSGeoEdge>) ...................................................................... 180
FacesToSheetBody(IEnumerable<IPSGeoFace>) ...................................................................... 181
Imprint(IPSGeoBody, IEnumerable<IPSGeoBody>) ................................................................... 181
OffsetFace(IEnumerable<IPSGeoFace>, double) ....................................................................... 181
SheetBodyToSolidBody(IPSGeoBody) ...................................................................................... 182
SimplifyTopology(IPSGeoEntity) .............................................................................................. 182
ThickenBody(IPSGeoBody, IEnumerable<IPSGeoFace>, double, double) ................................... 182
TransformBody(IPSGeoBody, Matrix4D) ................................................................................... 183
WireToSheetBody(IPSGeoBody) .............................................................................................. 183
IPrimitives .................................................................................................................................... 184

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Sheet ...................................................................................................................................... 184


Solid ....................................................................................................................................... 184
Wire ....................................................................................................................................... 184
IPSGeoBody .................................................................................................................................. 184
IPSGeoEdge .................................................................................................................................. 185
IPSGeoEntity ................................................................................................................................. 185
IPSGeoFace ................................................................................................................................... 185
IPSGeoPart ................................................................................................................................... 185
IQueries ........................................................................................................................................ 185
Clash(IEnumerable<IPSGeoEntity>, IEnumerable<IPSGeoEntity>) ............................................ 186
Coincidence(IPSGeoEntity, IPSGeoEntity) ................................................................................. 186
Containment(IPSGeoEntity, IPSGeoEntity) ................................................................................ 187
Distance(IEnumerable<IPSGeoEntity>, IEnumerable<IPSGeoEntity>) ....................................... 187
IRevolve ....................................................................................................................................... 187
Angle ..................................................................................................................................... 188
Axis ........................................................................................................................................ 188
Origin ..................................................................................................................................... 188
Walled .................................................................................................................................... 188
ApplyTo(IPSGeoEntity) ............................................................................................................ 188
ISheetCone ................................................................................................................................... 189
Center .................................................................................................................................... 189
Direction ................................................................................................................................ 189
Radius1 .................................................................................................................................. 189
Radius2 .................................................................................................................................. 190
ISheetCylinder .............................................................................................................................. 190
Center .................................................................................................................................... 190
Direction ................................................................................................................................ 190
Radius .................................................................................................................................... 190
ISheetPolygon .............................................................................................................................. 191
Points ..................................................................................................................................... 191
ISheets ......................................................................................................................................... 191
CreateCylinder(IEnumerable<double>, IEnumerable<double>, double) ................................... 191
CreatePolygon(IEnumerable<double>) ................................................................................... 192
ISheetSphere ................................................................................................................................ 192
Center .................................................................................................................................... 192
Radius .................................................................................................................................... 193
ISolidBox ...................................................................................................................................... 193
Point1 .................................................................................................................................... 193
Point2 .................................................................................................................................... 193
ISolidCone .................................................................................................................................... 193
Center .................................................................................................................................... 194
Direction ................................................................................................................................ 194
Radius1 .................................................................................................................................. 194
Radius2 .................................................................................................................................. 194
ISolidCylinder ............................................................................................................................... 195
Center .................................................................................................................................... 195
Direction ................................................................................................................................ 195
Radius .................................................................................................................................... 195
ISolids .......................................................................................................................................... 195
CreateBox(IEnumerable<double>, IEnumerable<double>) ...................................................... 196
CreateCone(IEnumerable<double>, IEnumerable<double>, double, double) ............................ 196

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xv
ACT API Reference Guide

CreateCylinder(IEnumerable<double>, IEnumerable<double>, double) ................................... 197


CreateSphere(IEnumerable<double>, double) ......................................................................... 197
ISolidSphere ................................................................................................................................. 198
Center .................................................................................................................................... 198
Radius .................................................................................................................................... 198
ISubtract ...................................................................................................................................... 198
ApplyTo(IEnumerable<IPSGeoBody>) ..................................................................................... 198
IUnion .......................................................................................................................................... 199
ApplyTo(IEnumerable<IPSGeoBody>) ..................................................................................... 199
IWireArc ....................................................................................................................................... 199
Center .................................................................................................................................... 200
EndAngle ............................................................................................................................... 200
Normal ................................................................................................................................... 200
Radius .................................................................................................................................... 200
StartAngle .............................................................................................................................. 200
XDir ........................................................................................................................................ 201
IWireBCurve .................................................................................................................................. 201
Closed .................................................................................................................................... 201
Points ..................................................................................................................................... 201
IWireEllipse ................................................................................................................................... 201
Center .................................................................................................................................... 202
LargeRadius ............................................................................................................................ 202
Normal ................................................................................................................................... 202
SmallRadius ............................................................................................................................ 202
XDir ........................................................................................................................................ 203
IWirePolyline ................................................................................................................................ 203
Points ..................................................................................................................................... 203
IWires ........................................................................................................................................... 203
CreateArc(double, IEnumerable<double>, IEnumerable<double>, IEnumerable<double>) ....... 204
CreateBCurve(IEnumerable<double>) ..................................................................................... 204
CreateEllipse(double, double, IEnumerable<double>, IEnumerable<double>, IEnumer-
able<double>) ....................................................................................................................... 204
CreatePolyline(IEnumerable<double>) .................................................................................... 205
Ansys.ACT.Interfaces.Graphics Namespace ...................................................................................... 207
IModelViewManager ..................................................................................................................... 207
NumberOfViews ..................................................................................................................... 208
ApplyModelView(int) .............................................................................................................. 208
ApplyModelView(string) ......................................................................................................... 208
CaptureModelView(int, string) ................................................................................................. 208
CaptureModelView(string, string) ............................................................................................ 209
CreateView() ........................................................................................................................... 209
CreateView(string) .................................................................................................................. 209
DeleteView(int) ....................................................................................................................... 209
DeleteView(string) .................................................................................................................. 210
ExportModelViews(string) ....................................................................................................... 210
ImportModelViews(string) ...................................................................................................... 210
RenameView(int, string) .......................................................................................................... 211
RenameView(string, string) ..................................................................................................... 211
Ansys.ACT.Interfaces.Mechanical Namespace ................................................................................. 213
IMechanicalDataModel ................................................................................................................. 213
ObjectTags ............................................................................................................................. 214

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Project .................................................................................................................................... 214


Tree ........................................................................................................................................ 214
CurrentUnitFromQuantityName(string) ................................................................................... 214
GetUserObjectById(int) ........................................................................................................... 214
IMechanicalExtAPI ........................................................................................................................ 215
LockPrePostLicense() .............................................................................................................. 215
UnlockPrePostLicense() ........................................................................................................... 215
IMechanicalGraphics ..................................................................................................................... 215
ModelViewManager ............................................................................................................... 216
SectionPlanes ......................................................................................................................... 216
IMechanicalSelectionInfo .............................................................................................................. 216
ElementFaceIndices ................................................................................................................ 216
Entities ................................................................................................................................... 217
IMechanicalUserLoad .................................................................................................................... 217
IMechanicalUserObject ................................................................................................................. 217
Analysis .................................................................................................................................. 217
IMechanicalUserResult .................................................................................................................. 217
IMechanicalUserSolver .................................................................................................................. 218
MechanicalPanelEnum .................................................................................................................. 218
Ansys.ACT.Common Namespace ...................................................................................................... 219
CoordinateSystem ........................................................................................................................ 219
CoordinateSystem(CoordinateSystemTypeEnum) .................................................................... 220
CoordinateSystemType ........................................................................................................... 220
Id ........................................................................................................................................... 220
Matrix ..................................................................................................................................... 220
Name ..................................................................................................................................... 220
Origin ..................................................................................................................................... 221
XAxis ...................................................................................................................................... 221
YAxis ...................................................................................................................................... 221
ZAxis ...................................................................................................................................... 221
SimpleTransform .......................................................................................................................... 221
SimpleTransform() .................................................................................................................. 222
IsOrthonormal ........................................................................................................................ 222
TransformationMatrix ............................................................................................................. 222
Translation ............................................................................................................................. 222
XAxis ...................................................................................................................................... 222
YAxis ...................................................................................................................................... 223
ZAxis ...................................................................................................................................... 223
Ansys.ACT.Common.Graphics Namespace ....................................................................................... 225
DMCameraWrapper ...................................................................................................................... 225
DMGraphicsWrapper .................................................................................................................... 225
MechanicalCameraWrapper .......................................................................................................... 225
FocalPoint .............................................................................................................................. 226
SceneHeight ........................................................................................................................... 226
SceneWidth ............................................................................................................................ 227
UpVector ................................................................................................................................ 227
ViewVector ............................................................................................................................. 227
GetAsString(ApplicationType) ................................................................................................. 227
Pan(Quantity, Quantity) ........................................................................................................... 227
Rotate(double, CameraAxisType) ............................................................................................. 228
SetFit(ISelectionInfo) ............................................................................................................... 228

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xvii
ACT API Reference Guide

SetSpecificViewOrientation(ViewOrientationType) .................................................................. 228


Zoom(double) ........................................................................................................................ 229
MechanicalGraphicsWrapper ........................................................................................................ 229
Camera ................................................................................................................................... 230
GlobalLegendSettings ............................................................................................................ 230
KeyframeAnimationUtility ....................................................................................................... 230
ModelViewManager ............................................................................................................... 230
ResultAnimationOptions ......................................................................................................... 230
SectionPlanes ......................................................................................................................... 230
Unit ........................................................................................................................................ 231
ViewOptions ........................................................................................................................... 231
Export3D(string, Graphics3DExportFormat, Graphics3DExportSettings) ................................... 231
ExportImage(string, GraphicsImageExportFormat, GraphicsImageExportSettings) .................... 231
ExportViewports(string, GraphicsImageExportFormat, GraphicsViewportsExportSettings) ........ 232
ModelViewManager ..................................................................................................................... 232
ActiveViewPort ....................................................................................................................... 233
NumberOfViews ..................................................................................................................... 233
ApplyModelView(int) .............................................................................................................. 233
ApplyModelView(string) ......................................................................................................... 234
CreateView() ........................................................................................................................... 234
CreateView(string) .................................................................................................................. 234
DeleteView(int) ....................................................................................................................... 234
DeleteView(string) .................................................................................................................. 235
ExportModelViews(string) ....................................................................................................... 235
ImportModelViews(string) ...................................................................................................... 235
RenameView(int, string) .......................................................................................................... 236
RenameView(string, string) ..................................................................................................... 236
SetActiveViewPort(int) ............................................................................................................ 236
SetActiveViewPort(int, int) ....................................................................................................... 237
SetViewPorts(int, bool) ............................................................................................................ 237
Ansys.ACT.Automation.DesignModeler Namespace ....................................................................... 239
Extrusion ...................................................................................................................................... 239
Depth ..................................................................................................................................... 240
Depth2 ................................................................................................................................... 240
Thin1 ...................................................................................................................................... 240
Thin2 ...................................................................................................................................... 240
Walled .................................................................................................................................... 240
Feature ......................................................................................................................................... 240
Id ........................................................................................................................................... 241
Name ..................................................................................................................................... 241
FeatureManager ........................................................................................................................... 241
Count ..................................................................................................................................... 241
Item(int) ................................................................................................................................. 242
CreateNamedSelection() ......................................................................................................... 242
Generate() .............................................................................................................................. 242
NamedSelection ........................................................................................................................... 242
ExportNamedSelection ........................................................................................................... 243
IncludeInLegend ..................................................................................................................... 243
NumGeometry ....................................................................................................................... 243
PropagateNamedSelection ..................................................................................................... 243
Ansys.ACT.Automation.Mechanical Namespace .............................................................................. 245

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AcousticsFarFieldResultWorksheet ................................................................................................ 251


RowCount .............................................................................................................................. 251
AddRow() ............................................................................................................................... 251
DeleteRow(int) ....................................................................................................................... 251
DuplicateRow(int, int) ............................................................................................................. 252
GetCoordinateSystemSelection(int) ........................................................................................ 252
GetXCoordinate(int) ................................................................................................................ 252
GetYCoordinate(int) ................................................................................................................ 253
GetZCoordinate(int) ................................................................................................................ 253
InsertRow(int) ......................................................................................................................... 253
SetCoordinateSystemSelection(int, uint) .................................................................................. 254
SetXCoordinate(int, double) .................................................................................................... 254
SetYCoordinate(int, double) .................................................................................................... 254
SetZCoordinate(int, double) .................................................................................................... 255
AMOverhangConstraint ................................................................................................................ 255
BuildDirection ........................................................................................................................ 256
CoordinateSystem .................................................................................................................. 256
DataModelObjectCategory ..................................................................................................... 256
InternalObject ........................................................................................................................ 256
OverhangAngle ...................................................................................................................... 256
ScopingMethod ...................................................................................................................... 256
Analysis ........................................................................................................................................ 257
Acoustics ................................................................................................................................ 262
AMProcessSimulation ............................................................................................................. 262
AnalysisSettings ..................................................................................................................... 262
AnalysisType ........................................................................................................................... 263
CellId ...................................................................................................................................... 263
Children ................................................................................................................................. 263
Comments .............................................................................................................................. 263
DataModelObjectCategory ..................................................................................................... 263
Electric ................................................................................................................................... 263
EnvironmentTemperature ....................................................................................................... 264
Figures ................................................................................................................................... 264
GenerateInputOnly ................................................................................................................. 264
Images ................................................................................................................................... 264
InitialConditions ..................................................................................................................... 264
InternalObject ........................................................................................................................ 264
PhysicsType ............................................................................................................................ 265
ResultFileName ....................................................................................................................... 265
Solution ................................................................................................................................. 265
Structural ............................................................................................................................... 265
SystemCaption ....................................................................................................................... 265
Thermal .................................................................................................................................. 265
AddAcceleration() ................................................................................................................... 266
AddAcousticAbsorptionElement() ........................................................................................... 266
AddAcousticAbsorptionSurface() ............................................................................................ 266
AddAcousticDiffuseSoundField() ............................................................................................. 266
AddAcousticFarFieldRadationSurface() .................................................................................... 266
AddAcousticFreeSurface() ....................................................................................................... 266
AddAcousticImpedanceBoundary() ......................................................................................... 267
AddAcousticImpedanceSheet() ............................................................................................... 267

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xix
ACT API Reference Guide

AddAcousticIncidentWaveSource() .......................................................................................... 267


AddAcousticLowReducedFrequency() ..................................................................................... 267
AddAcousticMassSource() ....................................................................................................... 267
AddAcousticMassSourceRate() ................................................................................................ 267
AddAcousticPort() .................................................................................................................. 268
AddAcousticPortInDuct() ........................................................................................................ 268
AddAcousticPressure() ............................................................................................................ 268
AddAcousticRadiationBoundary() ........................................................................................... 268
AddAcousticRigidWall() ........................................................................................................... 268
AddAcousticStaticPressure() .................................................................................................... 268
AddAcousticSurfaceAcceleration() .......................................................................................... 269
AddAcousticSurfaceVelocity() ................................................................................................. 269
AddAcousticSymmetryPlane() ................................................................................................. 269
AddAcousticTemperature() ..................................................................................................... 269
AddAcousticThermoViscousBLIBoundary() .............................................................................. 269
AddAcousticTransferAdmittanceMatrix() ................................................................................. 269
AddAMOverhangConstraint() .................................................................................................. 270
AddBearingLoad() ................................................................................................................... 270
AddBodyControl() ................................................................................................................... 270
AddBoltPretension() ............................................................................................................... 270
AddCenterOfGravityConstraint() ............................................................................................. 270
AddCommandSnippet() .......................................................................................................... 270
AddComment() ....................................................................................................................... 271
AddComplexityIndexConstraint() ............................................................................................ 271
AddComplianceConstraint() .................................................................................................... 271
AddCompressionOnlySupport() .............................................................................................. 271
AddConstraintEquation() ........................................................................................................ 271
AddContactStepControl() ........................................................................................................ 271
AddConvection(DataRepresentation) ...................................................................................... 272
AddCoupling() ........................................................................................................................ 272
AddCriterionConstraint() ......................................................................................................... 272
AddCurrent() .......................................................................................................................... 272
AddCyclicManufacturingConstraint() ....................................................................................... 273
AddCylindricalSupport() ......................................................................................................... 273
AddDetonationPoint() ............................................................................................................. 273
AddDisplacement() ................................................................................................................. 273
AddDisplacementConstraint() ................................................................................................. 273
AddDynamicComplianceConstraint() ...................................................................................... 273
AddEarthGravity() ................................................................................................................... 274
AddElasticSupport() ................................................................................................................ 274
AddElectricCharge() ................................................................................................................ 274
AddElementBirthAndDeath() .................................................................................................. 274
AddEMTransducer() ................................................................................................................ 274
AddExtrusionManufacturingConstraint() ................................................................................. 274
AddFigure() ............................................................................................................................ 275
AddFixedRotation() ................................................................................................................. 275
AddFixedSupport() ................................................................................................................. 275
AddFluidPenetrationPressure() ................................................................................................ 275
AddFluidSolidInterface() ......................................................................................................... 275
AddForce() .............................................................................................................................. 275
AddFrictionlessSupport() ........................................................................................................ 276

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddGeneralizedPlaneStrain() .................................................................................................. 276


AddGeometryBasedAdaptivity() .............................................................................................. 276
AddGlobalVonMisesStressConstraint() ..................................................................................... 276
AddHeatFlow() ....................................................................................................................... 276
AddHeatFlux() ........................................................................................................................ 276
AddHousingConstraint() ......................................................................................................... 277
AddHydrostaticPressure() ........................................................................................................ 277
AddImage(string) ................................................................................................................... 277
AddImpedanceBoundary() ...................................................................................................... 277
AddImportedCFDPressure() .................................................................................................... 277
AddImportedLoadExternalData() ............................................................................................ 278
AddImportedLoadFluidsResultsFile() ....................................................................................... 278
AddImportedLoadMAPDLResultsFile() ..................................................................................... 278
AddImportedRemoteLoadsGroup() ......................................................................................... 278
AddInitialVelocity() ................................................................................................................. 278
AddInternalHeatGeneration() .................................................................................................. 278
AddJointLoad() ....................................................................................................................... 279
AddLimitBoundary() ............................................................................................................... 279
AddLinePressure() ................................................................................................................... 279
AddLocalVonMisesStressConstraint() ....................................................................................... 279
AddMagneticFluxParallel() ...................................................................................................... 279
AddMassConstraint() .............................................................................................................. 279
AddMassFlowRate() ................................................................................................................ 280
AddMemberSizeManufacturingConstraint() ............................................................................ 280
AddMoment() ......................................................................................................................... 280
AddMomentOfInertiaConstraint() ........................................................................................... 280
AddMorphingRegion() ............................................................................................................ 280
AddNaturalFrequencyConstraint() ........................................................................................... 280
AddNodalDisplacement() ........................................................................................................ 281
AddNodalForce() .................................................................................................................... 281
AddNodalOrientation() ........................................................................................................... 281
AddNodalPressure() ................................................................................................................ 281
AddNodalRotation() ................................................................................................................ 281
AddNonlinearAdaptiveRegion() .............................................................................................. 281
AddObjective() ....................................................................................................................... 282
AddOptimizationRegion() ....................................................................................................... 282
AddPatternRepetitionConstraint() ........................................................................................... 282
AddPerfectlyInsulated() .......................................................................................................... 282
AddPhysicsRegion() ................................................................................................................ 282
AddPipeIdealization() ............................................................................................................. 282
AddPipePressure() .................................................................................................................. 283
AddPipeTemperature() ............................................................................................................ 283
AddPlasticHeating() ................................................................................................................ 283
AddPressure(DataRepresentation) ........................................................................................... 283
AddPSDAcceleration() ............................................................................................................. 283
AddPSDDisplacement() ........................................................................................................... 284
AddPSDGAcceleration() .......................................................................................................... 284
AddPSDVelocity() .................................................................................................................... 284
AddPullOutDirectionManufacturingConstraint() ...................................................................... 284
AddPythonCodeEventBased() ................................................................................................. 284
AddRadiation() ....................................................................................................................... 284

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxi
ACT API Reference Guide

AddReactionForceConstraint() ................................................................................................ 285


AddRemoteDisplacement() ..................................................................................................... 285
AddRemoteForce() .................................................................................................................. 285
AddRotatingForce() ................................................................................................................ 285
AddRotationalAcceleration() ................................................................................................... 285
AddRotationalVelocity() .......................................................................................................... 285
AddRSAcceleration() ............................................................................................................... 286
AddRSDisplacement() ............................................................................................................. 286
AddRSVelocity() ...................................................................................................................... 286
AddSimplySupported() ........................................................................................................... 286
AddSourceConductor() ........................................................................................................... 286
AddSubstructureGenerationCondensedPart() ......................................................................... 286
AddSurfaceChargeDensity() .................................................................................................... 287
AddSymmetryManufacturingConstraint() ................................................................................ 287
AddSystemCouplingRegion() .................................................................................................. 287
AddTemperature(DataRepresentation) .................................................................................... 287
AddTemperatureConstraint() .................................................................................................. 288
AddThermalComplianceConstraint() ....................................................................................... 288
AddThermalCondition() .......................................................................................................... 288
AddThermalCondition(DataRepresentation) ............................................................................ 288
AddUniformConstraint() ......................................................................................................... 288
AddVelocity() .......................................................................................................................... 289
AddViscoelasticHeating() ........................................................................................................ 289
AddVoltage() .......................................................................................................................... 289
AddVoltageCoupling() ............................................................................................................ 289
AddVoltageGround() ............................................................................................................... 289
AddVolumeChargeDensity() .................................................................................................... 289
AddVolumeConstraint() .......................................................................................................... 290
ClearGeneratedData() ............................................................................................................. 290
CreateAutomaticFarFieldRadiationSurfaces() ........................................................................... 290
CreateAutomaticFSI() .............................................................................................................. 290
CreateAutomaticFSIandFarFieldRadiationSurfaces() ................................................................. 290
Delete() .................................................................................................................................. 290
Duplicate() .............................................................................................................................. 291
ExportNastranFile(NastranExportOptions) ............................................................................... 291
FilterBasedOnEnvironment() ................................................................................................... 291
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 291
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 292
ImportLoad(Analysis) .............................................................................................................. 292
OpenSolverFilesDirectory() ..................................................................................................... 292
SelectBodiesWithMultiplePhysicsRegion() ............................................................................... 293
SelectBodiesWithoutPhysicsRegion() ...................................................................................... 293
Solve(bool) ............................................................................................................................. 293
Solve(bool, string) ................................................................................................................... 293
TransferDataFrom(Analysis) ..................................................................................................... 294
UnlinkDataFrom(Analysis) ....................................................................................................... 294
WriteSystemCouplingFiles(string) ............................................................................................ 294
AnalysisPly ................................................................................................................................... 295
Angle ..................................................................................................................................... 295
Children ................................................................................................................................. 295
Comments .............................................................................................................................. 296

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

DataModelObjectCategory ..................................................................................................... 296


Figures ................................................................................................................................... 296
IDInSource .............................................................................................................................. 296
Images ................................................................................................................................... 296
InternalObject ........................................................................................................................ 296
Material .................................................................................................................................. 297
NameInSource ........................................................................................................................ 297
NumberOfElements ................................................................................................................ 297
Thickness ............................................................................................................................... 297
AddComment() ....................................................................................................................... 297
AddFigure() ............................................................................................................................ 297
AddImage(string) ................................................................................................................... 298
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 298
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 298
ArbitraryCrack .............................................................................................................................. 299
BottomFaceNodes .................................................................................................................. 300
CircumferentialDivisions ......................................................................................................... 300
Contact1Nodes ....................................................................................................................... 300
ContactPairsNodes ................................................................................................................. 301
CoordinateSystem .................................................................................................................. 301
CrackFacesNodes .................................................................................................................... 301
CrackFrontNodes .................................................................................................................... 301
CrackMeshMethod ................................................................................................................. 301
CrackShape ............................................................................................................................ 301
CrackSourceType .................................................................................................................... 302
CrackSurfaceLocation ............................................................................................................. 302
DataModelObjectCategory ..................................................................................................... 302
FrontElementSize .................................................................................................................... 302
GrowthRate ............................................................................................................................ 302
InternalObject ........................................................................................................................ 302
LargestContourRadius ............................................................................................................ 303
Location ................................................................................................................................. 303
MeshContours ........................................................................................................................ 303
SolutionContours ................................................................................................................... 303
Suppressed ............................................................................................................................ 303
Target1Nodes ......................................................................................................................... 303
TopFaceNodes ........................................................................................................................ 304
XScaleFactor ........................................................................................................................... 304
YScaleFactor ........................................................................................................................... 304
ZScaleFactor ........................................................................................................................... 304
ArchiveSettings ............................................................................................................................ 304
ArchiveSettings(bool, bool) ..................................................................................................... 305
IncludeResultAndSolutionFiles ................................................................................................ 305
IncludeUserFiles ..................................................................................................................... 305
BatchConnectionsWorksheet ........................................................................................................ 305
RowCount .............................................................................................................................. 306
AddRow() ............................................................................................................................... 306
ClearGenerateMesh() .............................................................................................................. 306
DeleteAllRows() ...................................................................................................................... 307
DeleteRow(int) ....................................................................................................................... 307
GenerateAtRow(int) ................................................................................................................ 307

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxiii
ACT API Reference Guide

GenerateMesh() ...................................................................................................................... 307


GetActiveState(int) ................................................................................................................. 307
GetConnectionOption(int) ...................................................................................................... 308
GetConnectionTolerances(int) ................................................................................................. 308
GetNamedSelection(int) ......................................................................................................... 308
GetNamedSelectionId(int) ...................................................................................................... 309
SetActiveState(int, bool) .......................................................................................................... 309
SetConnectionOption(int, int) ................................................................................................. 309
SetConnectionTolerances(int, string) ....................................................................................... 310
SetNamedSelection(int, NamedSelection) ............................................................................... 310
SetNamedSelectionId(int, uint) ................................................................................................ 310
Body ............................................................................................................................................ 311
Assignment ***OBSOLETE*** Use 'Material' property instead. .................................................. 314
Average .................................................................................................................................. 314
BeamSection .......................................................................................................................... 314
Behavior ................................................................................................................................. 314
BrickIntegrationScheme .......................................................................................................... 314
CentroidX ............................................................................................................................... 315
CentroidY ............................................................................................................................... 315
CentroidZ ............................................................................................................................... 315
Children ................................................................................................................................. 315
Color ...................................................................................................................................... 315
Comments .............................................................................................................................. 315
ConfigurationId ...................................................................................................................... 316
CoordinateSystem .................................................................................................................. 316
CrossSectionArea .................................................................................................................... 316
CrossSectionIYY ...................................................................................................................... 316
CrossSectionIZZ ...................................................................................................................... 316
CrossSectionName .................................................................................................................. 316
CrossSectionSelection ............................................................................................................ 317
DataModelObjectCategory ..................................................................................................... 317
Dimension .............................................................................................................................. 317
Elements ................................................................................................................................ 317
FiberAngle .............................................................................................................................. 317
FiberCrossSectionArea ............................................................................................................ 317
FiberSpacing .......................................................................................................................... 318
Figures ................................................................................................................................... 318
FluidCrossArea ........................................................................................................................ 318
FluidDiscretization .................................................................................................................. 318
FluidSolidPhase ...................................................................................................................... 318
GeometryType ........................................................................................................................ 318
Hidden ................................................................................................................................... 319
HomogeneousMembrane ....................................................................................................... 319
Images ................................................................................................................................... 319
InternalObject ........................................................................................................................ 319
IsWindingBody ....................................................................................................................... 319
Length ................................................................................................................................... 319
LengthX ................................................................................................................................. 320
LengthY ................................................................................................................................. 320
LengthZ ................................................................................................................................. 320
LinkTrussBehavior ................................................................................................................... 320

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

ManualThicknessMode ........................................................................................................... 320


Mass ....................................................................................................................................... 320
Material .................................................................................................................................. 321
MaterialPolarizationDirection .................................................................................................. 321
Maximum ............................................................................................................................... 321
MeshMetric ............................................................................................................................ 321
MeshVersion ........................................................................................................................... 321
Minimum ............................................................................................................................... 321
ModelType ............................................................................................................................. 322
MomentOfInertiaIp1 ............................................................................................................... 322
MomentOfInertiaIp2 ............................................................................................................... 322
MomentOfInertiaIp3 ............................................................................................................... 322
Nodes ..................................................................................................................................... 322
NonlinearEffects ..................................................................................................................... 322
NumberOfTurns ...................................................................................................................... 323
OffsetMode ............................................................................................................................ 323
OffsetType .............................................................................................................................. 323
OffsetX ................................................................................................................................... 323
OffsetY ................................................................................................................................... 323
PipeExternalDiameter ............................................................................................................. 323
PipeInternalDiameter .............................................................................................................. 324
PipeThickness ......................................................................................................................... 324
ReferenceFrame ...................................................................................................................... 324
ReferenceTemperature ***OBSOLETE*** Use 'UseReferenceTemperatureByBody' property in-
stead. ..................................................................................................................................... 324
ReferenceTemperatureValue ................................................................................................... 324
ReinforcingStressState ............................................................................................................ 324
ResultMeshId .......................................................................................................................... 325
ShellOffsetType ...................................................................................................................... 325
StandardDeviation .................................................................................................................. 325
StiffnessBehavior .................................................................................................................... 325
StiffnessOption ....................................................................................................................... 325
Suppressed ............................................................................................................................ 325
SuppressedParameterized ...................................................................................................... 326
SurfaceArea ............................................................................................................................ 326
ThermalStrainEffects ............................................................................................................... 326
Thickness ............................................................................................................................... 326
ThicknessMode ***OBSOLETE*** Use 'ManualThicknessMode' property instead. ...................... 326
Transparency .......................................................................................................................... 326
Treatment ............................................................................................................................... 327
UseReferenceTemperatureByBody .......................................................................................... 327
UserNameChange ................................................................................................................... 327
Visible .................................................................................................................................... 327
Volume ................................................................................................................................... 327
AddCommandSnippet() .......................................................................................................... 327
AddComment() ....................................................................................................................... 328
AddFigure() ............................................................................................................................ 328
AddImage(string) ................................................................................................................... 328
AddPythonCodeEventBased() ................................................................................................. 328
ClearGeneratedData() ............................................................................................................. 328
GenerateMesh() ...................................................................................................................... 329

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxv
ACT API Reference Guide

GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 329


GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 329
GetGeoBody() ......................................................................................................................... 330
PreviewInflation() ................................................................................................................... 330
PreviewSurfaceMesh() ............................................................................................................ 330
ShowBody() ............................................................................................................................ 330
Update() ................................................................................................................................. 330
CenterOfGravityConstraint ............................................................................................................ 330
Axis ........................................................................................................................................ 331
DataModelObjectCategory ..................................................................................................... 331
InternalObject ........................................................................................................................ 331
Location ................................................................................................................................. 332
MaximumPosition ................................................................................................................... 332
MinimumPosition ................................................................................................................... 332
ScopingMethod ...................................................................................................................... 332
Selection ................................................................................................................................ 332
ChannelCrossSection .................................................................................................................... 332
Area ....................................................................................................................................... 333
DataModelObjectCategory ..................................................................................................... 333
InternalObject ........................................................................................................................ 334
IYY ......................................................................................................................................... 334
IZZ ......................................................................................................................................... 334
Thick1 .................................................................................................................................... 334
Thick2 .................................................................................................................................... 334
Thick3 .................................................................................................................................... 334
Width1 ................................................................................................................................... 335
Width2 ................................................................................................................................... 335
Width3 ................................................................................................................................... 335
Chart ............................................................................................................................................ 335
Caption .................................................................................................................................. 336
Children ................................................................................................................................. 336
Comments .............................................................................................................................. 336
Content .................................................................................................................................. 336
DataModelObjectCategory ..................................................................................................... 337
Gridlines ................................................................................................................................. 337
Images ................................................................................................................................... 337
InternalObject ........................................................................................................................ 337
ModalDisplayType .................................................................................................................. 337
OutlineSelection ..................................................................................................................... 337
PlotStyle ................................................................................................................................. 338
Scale ...................................................................................................................................... 338
XAxis ...................................................................................................................................... 338
XAxisLabel .............................................................................................................................. 338
YAxisLabel .............................................................................................................................. 338
AddComment() ....................................................................................................................... 338
AddImage(string) ................................................................................................................... 339
Delete() .................................................................................................................................. 339
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 339
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 340
ChartXAxis .................................................................................................................................... 340
ComponentIndex ................................................................................................................... 340

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

ObjectSelection ...................................................................................................................... 341


CircularCrossSection ..................................................................................................................... 341
Area ....................................................................................................................................... 341
DataModelObjectCategory ..................................................................................................... 342
InternalObject ........................................................................................................................ 342
IYY ......................................................................................................................................... 342
IZZ ......................................................................................................................................... 342
Radius .................................................................................................................................... 342
CircularTubeCrossSection ............................................................................................................. 342
Area ....................................................................................................................................... 343
DataModelObjectCategory ..................................................................................................... 343
InnerRadius ............................................................................................................................ 343
InternalObject ........................................................................................................................ 344
IYY ......................................................................................................................................... 344
IZZ ......................................................................................................................................... 344
OuterRadius ........................................................................................................................... 344
CommandSnippet ........................................................................................................................ 344
Children ................................................................................................................................. 346
Comments .............................................................................................................................. 346
DataModelObjectCategory ..................................................................................................... 346
Figures ................................................................................................................................... 346
FileName ................................................................................................................................ 346
Images ................................................................................................................................... 346
Input ...................................................................................................................................... 347
InputArgument1 ..................................................................................................................... 347
InputArgument2 ..................................................................................................................... 347
InputArgument3 ..................................................................................................................... 347
InputArgument4 ..................................................................................................................... 347
InputArgument5 ..................................................................................................................... 347
InputArgument6 ..................................................................................................................... 348
InputArgument7 ..................................................................................................................... 348
InputArgument8 ..................................................................................................................... 348
InputArgument9 ..................................................................................................................... 348
InternalObject ........................................................................................................................ 348
InvalidateSolution ................................................................................................................... 348
IssueSolveCommand .............................................................................................................. 349
OutputParameters .................................................................................................................. 349
OutputSearchPrefix ................................................................................................................ 349
SnippetFileStatus .................................................................................................................... 349
SolverTarget ........................................................................................................................... 349
StepNumber ........................................................................................................................... 349
StepSelectionMode ................................................................................................................ 350
Suppressed ............................................................................................................................ 350
AddComment() ....................................................................................................................... 350
AddFigure() ............................................................................................................................ 350
AddImage(string) ................................................................................................................... 350
AppendText(string) ................................................................................................................. 351
Delete() .................................................................................................................................. 351
ExportTextFile(string) .............................................................................................................. 351
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 351
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 352

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxvii
ACT API Reference Guide

ImportTextFile(string) ............................................................................................................. 352


RenameBasedOnDefinition() ................................................................................................... 353
Comment ..................................................................................................................................... 353
Author .................................................................................................................................... 353
Children ................................................................................................................................. 353
DataModelObjectCategory ..................................................................................................... 354
InternalObject ........................................................................................................................ 354
Text ........................................................................................................................................ 354
Delete() .................................................................................................................................. 354
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 354
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 355
ComplexityIndexConstraint ........................................................................................................... 355
DataModelObjectCategory ..................................................................................................... 356
InternalObject ........................................................................................................................ 356
ComplianceConstraint .................................................................................................................. 356
ComplianceLimit .................................................................................................................... 357
DataModelObjectCategory ..................................................................................................... 357
InternalObject ........................................................................................................................ 357
CompositeCriterion ...................................................................................................................... 357
DataModelObjectCategory ..................................................................................................... 358
InternalObject ........................................................................................................................ 358
Value ...................................................................................................................................... 358
ClearGeneratedData() ............................................................................................................. 358
EvaluateAllResults() ................................................................................................................. 358
GetDefinition() ........................................................................................................................ 359
CompositeCriterionDefinition ....................................................................................................... 359
Count ..................................................................................................................................... 359
Item(int) ................................................................................................................................. 360
Add(CompositeCriterionTerm) ................................................................................................ 360
Clear() .................................................................................................................................... 360
IndexOf(CompositeCriterionTerm) .......................................................................................... 360
Insert(int, CompositeCriterionTerm) ......................................................................................... 361
RemoveAt(int) ........................................................................................................................ 361
CompositeCriterionTerm ............................................................................................................... 361
CompositeCriterionTerm() ....................................................................................................... 362
CompositeCriterionTerm(PrimaryCriterion, double) ................................................................. 362
Coefficient .............................................................................................................................. 362
PrimaryCriterion ..................................................................................................................... 362
CondensedGeometry .................................................................................................................... 363
Children ................................................................................................................................. 363
Comments .............................................................................................................................. 364
DataModelObjectCategory ..................................................................................................... 364
Figures ................................................................................................................................... 364
Images ................................................................................................................................... 364
InternalObject ........................................................................................................................ 364
SolverFilesDirectory ................................................................................................................ 364
TransparencyEnabled ............................................................................................................. 365
AddComment() ....................................................................................................................... 365
AddCondensedPart() .............................................................................................................. 365
AddCondensedPartInfoTool() .................................................................................................. 365
AddFigure() ............................................................................................................................ 365

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddImage(string) ................................................................................................................... 365


AddImportedCondensedPart() ................................................................................................ 366
ClearGeneratedData() ............................................................................................................. 366
CreateAutomaticCondensedParts() ......................................................................................... 366
Delete() .................................................................................................................................. 366
GenerateCondensedParts() ..................................................................................................... 366
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 367
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 367
CondensedPart ............................................................................................................................. 367
AttachmentMethod ................................................................................................................ 369
DataModelObjectCategory ..................................................................................................... 369
FutureExpansion ..................................................................................................................... 370
FutureIntent ........................................................................................................................... 370
GenerateDampingMatrix ........................................................................................................ 370
InterfaceMethod ..................................................................................................................... 370
Interfaces ............................................................................................................................... 370
InternalObject ........................................................................................................................ 370
KeepFilesFor ........................................................................................................................... 371
LumpedMassFormulation ....................................................................................................... 371
MaximumFrequency ............................................................................................................... 371
MinimumFrequency ............................................................................................................... 371
NumberOfModes .................................................................................................................... 371
PointMassTreatment ............................................................................................................... 371
RangeSearch .......................................................................................................................... 372
ReductionMethod .................................................................................................................. 372
SolverType .............................................................................................................................. 372
StoreBasisResults .................................................................................................................... 372
DetectCondensedPartInterface() ............................................................................................. 372
Export(string, ExportFormat, ExportSettings) ........................................................................... 372
GenerateCondensedParts() ..................................................................................................... 373
CondensedPartBase ...................................................................................................................... 373
Children ................................................................................................................................. 374
Comments .............................................................................................................................. 374
DataModelObjectCategory ..................................................................................................... 374
Figures ................................................................................................................................... 375
GeometrySelection ................................................................................................................. 375
Images ................................................................................................................................... 375
InternalObject ........................................................................................................................ 375
NumberInterfaceEntries .......................................................................................................... 375
NumberMasterNodes ............................................................................................................. 375
Physics ................................................................................................................................... 376
ReferenceTemperature ............................................................................................................ 376
SolutionName ........................................................................................................................ 376
SolutionNameMode ................................................................................................................ 376
SolverFilesDirectory ................................................................................................................ 376
SolverUnits ............................................................................................................................. 376
SolverUnitSystem ................................................................................................................... 377
Suppressed ............................................................................................................................ 377
TemperatureUnits ................................................................................................................... 377
AddCommandSnippet() .......................................................................................................... 377
AddComment() ....................................................................................................................... 377

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxix
ACT API Reference Guide

AddFigure() ............................................................................................................................ 377


AddImage(string) ................................................................................................................... 378
ClearGeneratedData() ............................................................................................................. 378
Delete() .................................................................................................................................. 378
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 378
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 379
CondensedPartExpansionState ..................................................................................................... 379
CondensedPartExpansionState() ............................................................................................. 379
Displacement ......................................................................................................................... 380
Stress ..................................................................................................................................... 380
CondensedPartInfoTool ................................................................................................................ 380
Children ................................................................................................................................. 381
Comments .............................................................................................................................. 381
DataModelObjectCategory ..................................................................................................... 381
Images ................................................................................................................................... 381
InternalObject ........................................................................................................................ 381
Text ........................................................................................................................................ 381
UpdateInterval ....................................................................................................................... 382
AddComment() ....................................................................................................................... 382
AddImage(string) ................................................................................................................... 382
Delete() .................................................................................................................................. 382
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 382
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 383
CondensedPartInterface ............................................................................................................... 383
AllSelection ............................................................................................................................ 384
NamedSelection ..................................................................................................................... 384
RemotePointSelection ............................................................................................................ 384
Type ....................................................................................................................................... 384
CondensedPartInterfaces .............................................................................................................. 384
Item(int) ................................................................................................................................. 385
Add() ...................................................................................................................................... 385
Clear() .................................................................................................................................... 385
RemoveAt(int) ........................................................................................................................ 385
ConstructionGeometry ................................................................................................................. 386
Children ................................................................................................................................. 387
Comments .............................................................................................................................. 387
DataModelObjectCategory ..................................................................................................... 387
Figures ................................................................................................................................... 387
Images ................................................................................................................................... 387
InternalObject ........................................................................................................................ 387
ShowMesh ............................................................................................................................. 388
AddComment() ....................................................................................................................... 388
AddConstructionLine() ............................................................................................................ 388
AddConstructionPoint() .......................................................................................................... 388
AddFigure() ............................................................................................................................ 388
AddImage(string) ................................................................................................................... 388
AddPath() ............................................................................................................................... 389
AddSolid() .............................................................................................................................. 389
AddSTL() ................................................................................................................................. 389
AddSurface() .......................................................................................................................... 389
Delete() .................................................................................................................................. 389

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 390


GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 390
UpdateAllSolids() .................................................................................................................... 390
UpdateSolids() ........................................................................................................................ 391
ConstructionPoint ......................................................................................................................... 391
Children ................................................................................................................................. 391
Comments .............................................................................................................................. 392
DataModelObjectCategory ..................................................................................................... 392
Figures ................................................................................................................................... 392
Images ................................................................................................................................... 392
InternalObject ........................................................................................................................ 392
LocationX ............................................................................................................................... 392
LocationY ............................................................................................................................... 393
LocationZ ............................................................................................................................... 393
SetLocation ............................................................................................................................ 393
AddComment() ....................................................................................................................... 393
AddFigure() ............................................................................................................................ 393
AddImage(string) ................................................................................................................... 393
Delete() .................................................................................................................................. 394
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 394
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 394
ContactDebonding ....................................................................................................................... 395
ContactRegion ........................................................................................................................ 395
CriticalRate ............................................................................................................................. 396
DataModelObjectCategory ..................................................................................................... 396
GenerationMethod ................................................................................................................. 396
InitialCrack ............................................................................................................................. 396
InitialTimeStep ....................................................................................................................... 396
InternalObject ........................................................................................................................ 396
Material .................................................................................................................................. 397
MaximumTimeStep ................................................................................................................ 397
Method .................................................................................................................................. 397
MinimumTimeStep ................................................................................................................. 397
Suppressed ............................................................................................................................ 397
Type ....................................................................................................................................... 397
AddCommandSnippet() .......................................................................................................... 398
Delete() .................................................................................................................................. 398
ContactMatch ............................................................................................................................... 398
DataModelObjectCategory ..................................................................................................... 400
InternalObject ........................................................................................................................ 400
ToleranceValue ....................................................................................................................... 400
ContactMatchGroup ..................................................................................................................... 400
DataModelObjectCategory ..................................................................................................... 402
InternalObject ........................................................................................................................ 402
ContactSolutionInformation ......................................................................................................... 403
Children ................................................................................................................................. 403
Comments .............................................................................................................................. 403
DataModelObjectCategory ..................................................................................................... 404
Images ................................................................................................................................... 404
InternalObject ........................................................................................................................ 404
UpdateInterval ....................................................................................................................... 404

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxxi
ACT API Reference Guide

AddComment() ....................................................................................................................... 404


AddImage(string) ................................................................................................................... 404
Delete() .................................................................................................................................. 405
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 405
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 405
CoordinateSystem ........................................................................................................................ 406
APDLName ............................................................................................................................. 409
Children ................................................................................................................................. 409
Comments .............................................................................................................................. 410
CoordinateSystemID ............................................................................................................... 410
CoordinateSystemIDGeneration .............................................................................................. 410
CoordinateSystemType ........................................................................................................... 410
DataModelObjectCategory ..................................................................................................... 410
Figures ................................................................................................................................... 410
GloballyAvailable .................................................................................................................... 411
Images ................................................................................................................................... 411
InternalObject ........................................................................................................................ 411
IsGlobal .................................................................................................................................. 411
OriginDefineBy ....................................................................................................................... 411
OriginLocation ........................................................................................................................ 411
OriginX ................................................................................................................................... 412
OriginY ................................................................................................................................... 412
OriginZ ................................................................................................................................... 412
PrimaryAxis ............................................................................................................................ 412
PrimaryAxisDefineBy .............................................................................................................. 412
PrimaryAxisDirection .............................................................................................................. 412
PrimaryAxisLocation ............................................................................................................... 413
SecondaryAxis ........................................................................................................................ 413
SecondaryAxisDefineBy .......................................................................................................... 413
SecondaryAxisDirection .......................................................................................................... 413
SecondaryAxisLocation ........................................................................................................... 413
Suppressed ............................................................................................................................ 413
TransformationCount .............................................................................................................. 414
TransformedConfiguration ...................................................................................................... 414
XAxisData ............................................................................................................................... 414
YAxisData ............................................................................................................................... 414
ZAxisData ............................................................................................................................... 414
AddComment() ....................................................................................................................... 414
AddFigure() ............................................................................................................................ 415
AddImage(string) ................................................................................................................... 415
AddTransformation(TransformationType, CoordinateSystemAxisType) ..................................... 415
CreateConstructionSurface() ................................................................................................... 415
CreateSectionPlane() .............................................................................................................. 416
Delete() .................................................................................................................................. 416
FlipX() ..................................................................................................................................... 416
FlipY() ..................................................................................................................................... 416
FlipZ() ..................................................................................................................................... 416
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 416
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 417
GetTransformationValue(uint) ................................................................................................. 417
MoveTransformationDown(uint) ............................................................................................. 418

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

MoveTransformationUp(uint) .................................................................................................. 418


OffsetX() ................................................................................................................................. 418
OffsetX(object) ....................................................................................................................... 418
OffsetY() ................................................................................................................................. 419
OffsetY(object) ....................................................................................................................... 419
OffsetZ() ................................................................................................................................. 419
OffsetZ(object) ....................................................................................................................... 419
RemoveTransformation(uint) .................................................................................................. 419
RotateX() ................................................................................................................................ 420
RotateX(object) ...................................................................................................................... 420
RotateY() ................................................................................................................................ 420
RotateY(object) ....................................................................................................................... 420
RotateZ() ................................................................................................................................ 421
RotateZ(object) ...................................................................................................................... 421
SetCoordinateSystemOriginAtCenterOfMass(IList<IBaseGeoBody>, IList<PointMass>, IList<Dis-
tributedMass>) ....................................................................................................................... 421
SetOriginLocation(Quantity, Quantity, Quantity) ...................................................................... 422
SetPrimaryAxisUsingCenterOfMass() ....................................................................................... 422
SetTransformationValue(uint, object) ....................................................................................... 422
CoordinateSystems ....................................................................................................................... 423
Children ................................................................................................................................. 423
Comments .............................................................................................................................. 424
DataModelObjectCategory ..................................................................................................... 424
Figures ................................................................................................................................... 424
Images ................................................................................................................................... 424
InternalObject ........................................................................................................................ 424
AddComment() ....................................................................................................................... 424
AddCoordinateSystem() .......................................................................................................... 425
AddCoordinateSystemAtCenterOfMass(IList<IBaseGeoBody>, IList<PointMass>, IList<Distrib-
utedMass>) ............................................................................................................................ 425
AddFigure() ............................................................................................................................ 425
AddImage(string) ................................................................................................................... 425
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 426
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 426
CornerCrack ................................................................................................................................. 427
BottomFaceNodes .................................................................................................................. 428
CircumferentialDivisions ......................................................................................................... 428
Contact1Nodes ....................................................................................................................... 428
ContactPairsNodes ................................................................................................................. 428
CoordinateSystem .................................................................................................................. 429
CrackFacesNodes .................................................................................................................... 429
CrackFrontDivisions ................................................................................................................ 429
CrackFrontNodes .................................................................................................................... 429
CrackMeshMethod ................................................................................................................. 429
CrackShape ............................................................................................................................ 429
CrackSourceType .................................................................................................................... 430
DataModelObjectCategory ..................................................................................................... 430
FractureAffectedZone ............................................................................................................. 430
FractureAffectedZoneHeight ................................................................................................... 430
FrontElementSize .................................................................................................................... 430
GrowthRate ............................................................................................................................ 430

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxxiii
ACT API Reference Guide

InternalObject ........................................................................................................................ 431


LargestContourRadius ............................................................................................................ 431
Location ................................................................................................................................. 431
MajorRadius ........................................................................................................................... 431
MeshContours ........................................................................................................................ 431
MinorRadius ........................................................................................................................... 431
SolutionContours ................................................................................................................... 432
Suppressed ............................................................................................................................ 432
Target1Nodes ......................................................................................................................... 432
TopFaceNodes ........................................................................................................................ 432
XScaleFactor ........................................................................................................................... 432
YScaleFactor ........................................................................................................................... 432
ZScaleFactor ........................................................................................................................... 433
CoSimulationPin ........................................................................................................................... 433
Children ................................................................................................................................. 433
DataModelObjectCategory ..................................................................................................... 433
DOF ........................................................................................................................................ 434
InternalObject ........................................................................................................................ 434
JointType ................................................................................................................................ 434
PinBehavior ............................................................................................................................ 434
PinNature ............................................................................................................................... 434
Scope ..................................................................................................................................... 434
Suppressed ............................................................................................................................ 435
Delete() .................................................................................................................................. 435
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 435
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 435
Crack ***OBSOLETE*** Deprecated class. Use ArbitraryCrack or SemiEllipticalCrack instead. ........... 436
AlignWithFaceNormal ............................................................................................................. 437
BottomFaceNodes .................................................................................................................. 437
CircumferentialDivisions ......................................................................................................... 438
Contact1Nodes ....................................................................................................................... 438
ContactPairsNodes ................................................................................................................. 438
CoordinateSystem .................................................................................................................. 438
CrackFacesNodes .................................................................................................................... 438
CrackFrontDivisions ................................................................................................................ 438
CrackFrontNodes .................................................................................................................... 439
CrackShape ............................................................................................................................ 439
CrackSourceType .................................................................................................................... 439
FaceTopNodes ........................................................................................................................ 439
FractureAffectedZone ............................................................................................................. 439
FractureAffectedZoneHeight ................................................................................................... 439
InternalObject ........................................................................................................................ 440
LargestContourRadius ............................................................................................................ 440
Location ................................................................................................................................. 440
MajorRadius ........................................................................................................................... 440
MeshContours ........................................................................................................................ 440
MinorRadius ........................................................................................................................... 440
ProjectToNearestSurface ......................................................................................................... 441
SolutionContours ................................................................................................................... 441
Suppressed ............................................................................................................................ 441
Target1Nodes ......................................................................................................................... 441

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

XScaleFactor ........................................................................................................................... 441


YScaleFactor ........................................................................................................................... 441
ZScaleFactor ........................................................................................................................... 442
CrackInitiation .............................................................................................................................. 442
BottomFaceNodes .................................................................................................................. 443
CenterXCoordinate ................................................................................................................. 443
CenterYCoordinate ................................................................................................................. 443
CenterZCoordinate ................................................................................................................. 443
CoordinateSystem .................................................................................................................. 443
CrackCenter ............................................................................................................................ 444
CrackOrientation .................................................................................................................... 444
CrackShape ............................................................................................................................ 444
CrackSourceType .................................................................................................................... 444
CriterionValue ......................................................................................................................... 444
DataModelObjectCategory ..................................................................................................... 444
InitiationCriterion ................................................................................................................... 445
InternalObject ........................................................................................................................ 445
Location ................................................................................................................................. 445
MajorRadius ........................................................................................................................... 445
MinorRadius ........................................................................................................................... 445
NamedSelection ..................................................................................................................... 445
ScopingMethod ...................................................................................................................... 446
SolutionContours ................................................................................................................... 446
Suppressed ............................................................................................................................ 446
TopFaceNodes ........................................................................................................................ 446
Criterion ....................................................................................................................................... 446
Children ................................................................................................................................. 447
Comments .............................................................................................................................. 447
DataModelObjectCategory ..................................................................................................... 447
Figures ................................................................................................................................... 447
Images ................................................................................................................................... 448
InternalObject ........................................................................................................................ 448
Suppressed ............................................................................................................................ 448
AddComment() ....................................................................................................................... 448
AddFigure() ............................................................................................................................ 448
AddImage(string) ................................................................................................................... 448
Delete() .................................................................................................................................. 449
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 449
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 449
CriterionConstraint ....................................................................................................................... 450
Criterion ................................................................................................................................. 450
DataModelObjectCategory ..................................................................................................... 451
InitialValue ............................................................................................................................. 451
InternalObject ........................................................................................................................ 451
LowerBound ........................................................................................................................... 451
UpperBound ........................................................................................................................... 451
CrossSection ................................................................................................................................. 451
Children ................................................................................................................................. 452
Comments .............................................................................................................................. 452
DataModelObjectCategory ..................................................................................................... 452
Figures ................................................................................................................................... 453

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxxv
ACT API Reference Guide

Images ................................................................................................................................... 453


InternalObject ........................................................................................................................ 453
AddComment() ....................................................................................................................... 453
AddFigure() ............................................................................................................................ 453
AddImage(string) ................................................................................................................... 453
Delete() .................................................................................................................................. 454
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 454
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 454
CrossSections ............................................................................................................................... 455
Children ................................................................................................................................. 456
Comments .............................................................................................................................. 456
DataModelObjectCategory ..................................................................................................... 456
Figures ................................................................................................................................... 456
Images ................................................................................................................................... 456
InternalObject ........................................................................................................................ 457
AddChannelCrossSection() ...................................................................................................... 457
AddCircularCrossSection() ....................................................................................................... 457
AddCircularTubeCrossSection() ............................................................................................... 457
AddComment() ....................................................................................................................... 457
AddFigure() ............................................................................................................................ 457
AddHatCrossSection() ............................................................................................................. 458
AddHollowRectangularCrossSection() ..................................................................................... 458
AddICrossSection() ................................................................................................................. 458
AddImage(string) ................................................................................................................... 458
AddLCrossSection() ................................................................................................................. 458
AddRectangularCrossSection() ................................................................................................ 459
AddTCrossSection() ................................................................................................................ 459
AddUserDefinedCrossSection() ............................................................................................... 459
AddZCrossSection() ................................................................................................................ 459
Delete() .................................................................................................................................. 459
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 459
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 460
NameCrossSectionsUniquely() ................................................................................................ 460
CyclicManufacturingConstraint ..................................................................................................... 461
Axis ........................................................................................................................................ 461
CoordinateSystem .................................................................................................................. 461
DataModelObjectCategory ..................................................................................................... 462
InternalObject ........................................................................................................................ 462
Location ................................................................................................................................. 462
NumberofSectors ................................................................................................................... 462
ScopingMethod ...................................................................................................................... 462
CyclicRegion ................................................................................................................................. 462
DataModelObjectCategory ..................................................................................................... 463
InternalObject ........................................................................................................................ 464
CylindricalCrack ............................................................................................................................ 464
BottomFaceNodes .................................................................................................................. 465
CircumferentialDivisions ......................................................................................................... 465
Contact1Nodes ....................................................................................................................... 465
ContactPairsNodes ................................................................................................................. 466
CoordinateSystem .................................................................................................................. 466
CrackFacesNodes .................................................................................................................... 466

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

CrackFrontDivisions ................................................................................................................ 466


CrackFrontNodes .................................................................................................................... 466
CrackMeshMethod ................................................................................................................. 466
CrackShape ............................................................................................................................ 467
CrackSourceType .................................................................................................................... 467
DataModelObjectCategory ..................................................................................................... 467
FractureAffectedZone ............................................................................................................. 467
FractureAffectedZoneHeight ................................................................................................... 467
FrontElementSize .................................................................................................................... 467
GrowthRate ............................................................................................................................ 468
Height .................................................................................................................................... 468
InternalObject ........................................................................................................................ 468
LargestContourRadius ............................................................................................................ 468
Location ................................................................................................................................. 468
MajorRadius ........................................................................................................................... 468
MeshContours ........................................................................................................................ 469
MinorRadius ........................................................................................................................... 469
SolutionContours ................................................................................................................... 469
Suppressed ............................................................................................................................ 469
Target1Nodes ......................................................................................................................... 469
TopFaceNodes ........................................................................................................................ 469
XScaleFactor ........................................................................................................................... 470
YScaleFactor ........................................................................................................................... 470
ZScaleFactor ........................................................................................................................... 470
DirectMorph ................................................................................................................................. 470
Children ................................................................................................................................. 471
DataModelObjectCategory ..................................................................................................... 471
DisplacementFile .................................................................................................................... 471
InternalObject ........................................................................................................................ 471
Location ................................................................................................................................. 471
ScaleFactor ............................................................................................................................. 472
Suppressed ............................................................................................................................ 472
Clear() .................................................................................................................................... 472
Delete() .................................................................................................................................. 472
Generate() .............................................................................................................................. 472
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 472
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 473
DisplacementConstraint ............................................................................................................... 473
DataModelObjectCategory ..................................................................................................... 474
InternalObject ........................................................................................................................ 474
Location ................................................................................................................................. 474
ScopingMethod ...................................................................................................................... 474
XComponentMax .................................................................................................................... 475
YComponentMax .................................................................................................................... 475
ZComponentMax .................................................................................................................... 475
DistributedMass ........................................................................................................................... 475
DataModelObjectCategory ..................................................................................................... 476
ElementAPDLName ................................................................................................................ 476
InternalObject ........................................................................................................................ 476
MassPerUnitArea .................................................................................................................... 476
MassType ............................................................................................................................... 477

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxxvii
ACT API Reference Guide

Suppressed ............................................................................................................................ 477


TotalMass ............................................................................................................................... 477
DynamicComplianceConstraint ..................................................................................................... 477
ComplianceLimit .................................................................................................................... 478
DataModelObjectCategory ..................................................................................................... 478
InternalObject ........................................................................................................................ 478
MaximumValue ...................................................................................................................... 478
MinimumValue ....................................................................................................................... 478
EdgeCrack .................................................................................................................................... 479
BottomFaceNodes .................................................................................................................. 480
CircumferentialDivisions ......................................................................................................... 480
Contact1Nodes ....................................................................................................................... 480
ContactPairsNodes ................................................................................................................. 480
CoordinateSystem .................................................................................................................. 481
CrackFacesNodes .................................................................................................................... 481
CrackFrontDivisions ................................................................................................................ 481
CrackFrontNodes .................................................................................................................... 481
CrackMeshMethod ................................................................................................................. 481
CrackShape ............................................................................................................................ 481
CrackSourceType .................................................................................................................... 482
DataModelObjectCategory ..................................................................................................... 482
Depth ..................................................................................................................................... 482
EndWidth ............................................................................................................................... 482
FractureAffectedZone ............................................................................................................. 482
FractureAffectedZoneHeight ................................................................................................... 482
FrontElementSize .................................................................................................................... 483
GrowthRate ............................................................................................................................ 483
InternalObject ........................................................................................................................ 483
LargestContourRadius ............................................................................................................ 483
Location ................................................................................................................................. 483
MeshContours ........................................................................................................................ 483
MidWidth ............................................................................................................................... 484
SolutionContours ................................................................................................................... 484
StartWidth .............................................................................................................................. 484
Suppressed ............................................................................................................................ 484
Target1Nodes ......................................................................................................................... 484
TopFaceNodes ........................................................................................................................ 484
XScaleFactor ........................................................................................................................... 485
YScaleFactor ........................................................................................................................... 485
ZScaleFactor ........................................................................................................................... 485
ElementOrientation ...................................................................................................................... 485
AxisEdgeOrientation ............................................................................................................... 486
AxisSurfaceOrientation ........................................................................................................... 486
BodyLocation ......................................................................................................................... 486
Children ................................................................................................................................. 487
Comments .............................................................................................................................. 487
CoordinateSystem .................................................................................................................. 487
DataModelObjectCategory ..................................................................................................... 487
EdgeLocation ......................................................................................................................... 487
Figures ................................................................................................................................... 487
Images ................................................................................................................................... 488

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

InternalObject ........................................................................................................................ 488


OrientationGuideDefinedBy .................................................................................................... 488
Suppressed ............................................................................................................................ 488
SurfaceLocation ...................................................................................................................... 488
AddComment() ....................................................................................................................... 488
AddFigure() ............................................................................................................................ 489
AddImage(string) ................................................................................................................... 489
Delete() .................................................................................................................................. 489
GenerateOrientations() ........................................................................................................... 489
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 489
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 490
EllipticalCrack ............................................................................................................................... 490
BottomFaceNodes .................................................................................................................. 492
CircumferentialDivisions ......................................................................................................... 492
Contact1Nodes ....................................................................................................................... 492
ContactPairsNodes ................................................................................................................. 492
CoordinateSystem .................................................................................................................. 492
CrackFacesNodes .................................................................................................................... 492
CrackFrontDivisions ................................................................................................................ 493
CrackFrontNodes .................................................................................................................... 493
CrackMeshMethod ................................................................................................................. 493
CrackShape ............................................................................................................................ 493
CrackSourceType .................................................................................................................... 493
DataModelObjectCategory ..................................................................................................... 493
FractureAffectedZone ............................................................................................................. 494
FractureAffectedZoneHeight ................................................................................................... 494
FrontElementSize .................................................................................................................... 494
GrowthRate ............................................................................................................................ 494
InternalObject ........................................................................................................................ 494
LargestContourRadius ............................................................................................................ 494
Location ................................................................................................................................. 495
MajorRadius ........................................................................................................................... 495
MeshContours ........................................................................................................................ 495
MinorRadius ........................................................................................................................... 495
SolutionContours ................................................................................................................... 495
Suppressed ............................................................................................................................ 495
Target1Nodes ......................................................................................................................... 496
TopFaceNodes ........................................................................................................................ 496
XScaleFactor ........................................................................................................................... 496
YScaleFactor ........................................................................................................................... 496
ZScaleFactor ........................................................................................................................... 496
EndRelease ................................................................................................................................... 496
Behavior ................................................................................................................................. 497
Children ................................................................................................................................. 498
Comments .............................................................................................................................. 498
CoordinateSystem .................................................................................................................. 498
DataModelObjectCategory ..................................................................................................... 498
EdgeLocation ......................................................................................................................... 498
Figures ................................................................................................................................... 498
Images ................................................................................................................................... 499
IndependentEdges ................................................................................................................. 499

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxxix
ACT API Reference Guide

InternalObject ........................................................................................................................ 499


RotationX ............................................................................................................................... 499
RotationY ............................................................................................................................... 499
RotationZ ............................................................................................................................... 499
Suppressed ............................................................................................................................ 500
TranslationX ........................................................................................................................... 500
TranslationY ........................................................................................................................... 500
TranslationZ ........................................................................................................................... 500
VertexLocation ....................................................................................................................... 500
AddComment() ....................................................................................................................... 500
AddFigure() ............................................................................................................................ 501
AddImage(string) ................................................................................................................... 501
Delete() .................................................................................................................................. 501
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 501
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 502
ExpansionSettings ........................................................................................................................ 502
Children ................................................................................................................................. 503
CleanupOptionalFiles .............................................................................................................. 503
Comments .............................................................................................................................. 504
CondensedPartExpansionType ................................................................................................ 504
DataModelObjectCategory ..................................................................................................... 504
ExpandAfterUsePassFailure ..................................................................................................... 504
Figures ................................................................................................................................... 504
GeneralMiscellaneous ............................................................................................................. 504
Images ................................................................................................................................... 505
InternalObject ........................................................................................................................ 505
NodalForces ........................................................................................................................... 505
Strain ..................................................................................................................................... 505
Stress ..................................................................................................................................... 505
Suppressed ............................................................................................................................ 505
AddComment() ....................................................................................................................... 506
AddFigure() ............................................................................................................................ 506
AddImage(string) ................................................................................................................... 506
ClearGeneratedData() ............................................................................................................. 506
Delete() .................................................................................................................................. 506
EvaluateAllResults() ................................................................................................................. 507
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 507
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 507
GetCompletedExpansionState(CondensedPart) ....................................................................... 508
GetExpansionState(CondensedPart) ........................................................................................ 508
PerformExpansionPass() .......................................................................................................... 508
SetExpansionState(CondensedPart, CondensedPartExpansionState) ........................................ 508
ExternalEnhancedModel ............................................................................................................... 509
Children ................................................................................................................................. 510
Comments .............................................................................................................................. 510
DataModelObjectCategory ..................................................................................................... 510
Figures ................................................................................................................................... 510
Images ................................................................................................................................... 510
InternalObject ........................................................................................................................ 510
LayerToDisplay ....................................................................................................................... 511
MaximumNumberOfLayers ..................................................................................................... 511

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xl of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

NonlinearEffects ..................................................................................................................... 511


Suppressed ............................................................................................................................ 511
ThermalStrainEffects ............................................................................................................... 511
Type ....................................................................................................................................... 511
AddComment() ....................................................................................................................... 512
AddFigure() ............................................................................................................................ 512
AddImage(string) ................................................................................................................... 512
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 512
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 513
RegroupToDefault() ................................................................................................................ 513
ExternalModelDataColl ................................................................................................................. 513
Children ................................................................................................................................. 514
Comments .............................................................................................................................. 514
Count ..................................................................................................................................... 514
DataModelObjectCategory ..................................................................................................... 514
Figures ................................................................................................................................... 515
Images ................................................................................................................................... 515
InternalObject ........................................................................................................................ 515
Suppressed ............................................................................................................................ 515
AddComment() ....................................................................................................................... 515
AddFigure() ............................................................................................................................ 515
AddImage(string) ................................................................................................................... 516
Delete() .................................................................................................................................. 516
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 516
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 517
ExtrusionManufacturingConstraint ............................................................................................... 517
Axis ........................................................................................................................................ 518
CoordinateSystem .................................................................................................................. 518
DataModelObjectCategory ..................................................................................................... 518
InternalObject ........................................................................................................................ 518
Location ................................................................................................................................. 518
ScopingMethod ...................................................................................................................... 519
FatigueCombination ..................................................................................................................... 519
Children ................................................................................................................................. 519
Comments .............................................................................................................................. 520
DataModelObjectCategory ..................................................................................................... 520
Images ................................................................................................................................... 520
InternalObject ........................................................................................................................ 520
AddComment() ....................................................................................................................... 520
AddDamage() ......................................................................................................................... 520
AddImage(string) ................................................................................................................... 521
Delete() .................................................................................................................................. 521
EvaluateAllResults() ................................................................................................................. 521
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 521
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 522
FatigueTool .................................................................................................................................. 522
AnalysisType ........................................................................................................................... 524
BinSize ................................................................................................................................... 524
Children ................................................................................................................................. 524
Comments .............................................................................................................................. 524
CustomUnitsName ................................................................................................................. 524

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xli
ACT API Reference Guide

DataModelObjectCategory ..................................................................................................... 524


DisplayTime ............................................................................................................................ 525
ExposureDuration ................................................................................................................... 525
FatigueStrengthFactor ............................................................................................................ 525
Frequency .............................................................................................................................. 525
FrequencySelection ................................................................................................................ 525
HistoryDataLocation ............................................................................................................... 525
Images ................................................................................................................................... 526
InfiniteLife .............................................................................................................................. 526
InternalObject ........................................................................................................................ 526
LoadingRatio .......................................................................................................................... 526
LoadingType ........................................................................................................................... 526
MaximumDataPointsToPlot ..................................................................................................... 526
MeanStressTheory .................................................................................................................. 527
MethodSelection .................................................................................................................... 527
OneCycleIsEqualTo ................................................................................................................. 527
ResultsInput ........................................................................................................................... 527
ScaleFactor ............................................................................................................................. 527
StressComponent ................................................................................................................... 527
UnitsName ............................................................................................................................. 528
UseQuickRainflowCounting .................................................................................................... 528
AddBiaxialityIndication() ......................................................................................................... 528
AddComment() ....................................................................................................................... 528
AddDamage() ......................................................................................................................... 528
AddDamageMatrix() ............................................................................................................... 528
AddEquivalentAlternativeStress() ............................................................................................ 529
AddFatigueSensitivity() ........................................................................................................... 529
AddHysteresis() ....................................................................................................................... 529
AddImage(string) ................................................................................................................... 529
AddLife() ................................................................................................................................ 529
AddRainflowMatrix() ............................................................................................................... 530
AddSafetyFactor() ................................................................................................................... 530
ClearGeneratedData() ............................................................................................................. 530
Delete() .................................................................................................................................. 530
DuplicateWithoutResults() ...................................................................................................... 530
EvaluateAllResults() ................................................................................................................. 530
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 531
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 531
FeatureDetection .......................................................................................................................... 531
Children ................................................................................................................................. 532
Comments .............................................................................................................................. 532
DataModelObjectCategory ..................................................................................................... 533
Definition ............................................................................................................................... 533
Images ................................................................................................................................... 533
InternalObject ........................................................................................................................ 533
Location ................................................................................................................................. 533
NamedSelection ..................................................................................................................... 533
ScopingMethod ...................................................................................................................... 534
AddComment() ....................................................................................................................... 534
AddImage(string) ................................................................................................................... 534
ClearGeneratedData() ............................................................................................................. 534

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xlii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Delete() .................................................................................................................................. 534


DetectFeatures() ..................................................................................................................... 535
EvaluateAllResults() ................................................................................................................. 535
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 535
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 535
FeatureDetectionDefinition .......................................................................................................... 536
FeatureDetectionCount .......................................................................................................... 537
AddFeatureDetection(string, int, int, int, double, double, double, double, int) ............................. 537
DeleteFeatureDetection(uint) ................................................................................................. 538
ExecuteDetectFeatures() ......................................................................................................... 539
Export(string) ......................................................................................................................... 539
GetFeatureCriteriaAngle(uint) ................................................................................................. 539
GetFeatureCriteriaMaxBound(uint) .......................................................................................... 539
GetFeatureCriteriaMinBound(uint) .......................................................................................... 540
GetFeatureCriteriaValue(uint) .................................................................................................. 540
GetFeatureDetectionCriteria(uint) ........................................................................................... 540
GetFeatureDetectionName(uint) ............................................................................................. 541
GetFeatureDetectionOperator(uint) ........................................................................................ 541
GetFeatureDetectionTreatment(uint) ...................................................................................... 541
GetFeatureDetectionType(uint) ............................................................................................... 541
Import(string) ......................................................................................................................... 542
SetFeatureCriteriaAngle(uint, double) ...................................................................................... 542
SetFeatureCriteriaMaxBound(uint, double) .............................................................................. 542
SetFeatureCriteriaMinBound(uint, double) .............................................................................. 543
SetFeatureCriteriaValue(uint, double) ...................................................................................... 543
SetFeatureDetectionCriteria(uint, FeatureDetectionCriteria) ..................................................... 543
SetFeatureDetectionName(uint, string) ................................................................................... 544
SetFeatureDetectionOperator(uint, FeatureDetectionOperator) ............................................... 544
SetFeatureDetectionOptions(bool, bool, bool) ......................................................................... 545
SetFeatureDetectionTreatment(uint, FeatureDetectionTreatment) ........................................... 545
SetFeatureDetectionType(uint, FeatureDetectionType) ............................................................ 545
Figure ........................................................................................................................................... 546
Children ................................................................................................................................. 546
Comments .............................................................................................................................. 547
DataModelObjectCategory ..................................................................................................... 547
InternalObject ........................................................................................................................ 547
Text ........................................................................................................................................ 547
AddComment() ....................................................................................................................... 547
Delete() .................................................................................................................................. 547
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 548
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 548
Fracture ........................................................................................................................................ 549
Children ................................................................................................................................. 550
Comments .............................................................................................................................. 550
DataModelObjectCategory ..................................................................................................... 550
Figures ................................................................................................................................... 550
Images ................................................................................................................................... 550
InternalObject ........................................................................................................................ 551
RemeshHexDominantToTetrahedralType ................................................................................. 551
AddArbitraryCrack() ................................................................................................................ 551
AddComment() ....................................................................................................................... 551

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xliii
ACT API Reference Guide

AddContactDebonding() ........................................................................................................ 551


AddCornerCrack() ................................................................................................................... 552
AddCrack() ***OBSOLETE*** Use the method AddArbitraryCrack or AddSemiEllipticalCrack in-
stead. ..................................................................................................................................... 552
AddCrackInitiation() ................................................................................................................ 552
AddCylindricalCrack() .............................................................................................................. 552
AddEdgeCrack() ...................................................................................................................... 552
AddEllipticalCrack() ................................................................................................................. 552
AddFigure() ............................................................................................................................ 553
AddImage(string) ................................................................................................................... 553
AddInterfaceDelamination() .................................................................................................... 553
AddPreMeshedCrack() ............................................................................................................ 553
AddRingCrack() ....................................................................................................................... 553
AddSemiEllipticalCrack() ......................................................................................................... 554
AddSMARTCrackGrowth() ....................................................................................................... 554
AddThroughCrack() ................................................................................................................ 554
Delete() .................................................................................................................................. 554
GenerateAllCrackMesh() ......................................................................................................... 554
GenerateAllInterfaceDelamination() ........................................................................................ 554
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 555
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 555
GeneralAxisymmetric .................................................................................................................... 555
Axis ........................................................................................................................................ 556
Children ................................................................................................................................. 556
Comments .............................................................................................................................. 557
CoordinateSystem .................................................................................................................. 557
DataModelObjectCategory ..................................................................................................... 557
EndPlane ................................................................................................................................ 557
Figures ................................................................................................................................... 557
Images ................................................................................................................................... 557
InternalObject ........................................................................................................................ 558
Location ................................................................................................................................. 558
NodalPlanes ........................................................................................................................... 558
NodalPlanesVisible ................................................................................................................. 558
StartPlane ............................................................................................................................... 558
Suppressed ............................................................................................................................ 558
AddComment() ....................................................................................................................... 559
AddFigure() ............................................................................................................................ 559
AddImage(string) ................................................................................................................... 559
Delete() .................................................................................................................................. 559
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 559
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 560
GenericCrack ................................................................................................................................ 560
Children ................................................................................................................................. 561
Comments .............................................................................................................................. 561
CrackID ................................................................................................................................... 561
DataModelObjectCategory ..................................................................................................... 562
Figures ................................................................................................................................... 562
Images ................................................................................................................................... 562
InternalObject ........................................................................................................................ 562
AddCommandSnippet() .......................................................................................................... 562

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xliv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddComment() ....................................................................................................................... 562


AddFigure() ............................................................................................................................ 563
AddImage(string) ................................................................................................................... 563
Delete() .................................................................................................................................. 563
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 563
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 564
GenericDelamination .................................................................................................................... 564
Children ................................................................................................................................. 565
Comments .............................................................................................................................. 565
DataModelObjectCategory ..................................................................................................... 565
Figures ................................................................................................................................... 565
Images ................................................................................................................................... 565
InternalObject ........................................................................................................................ 566
AddCommandSnippet() .......................................................................................................... 566
AddComment() ....................................................................................................................... 566
AddFigure() ............................................................................................................................ 566
AddImage(string) ................................................................................................................... 566
Delete() .................................................................................................................................. 567
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 567
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 567
GenericPointMass ......................................................................................................................... 568
Children ................................................................................................................................. 568
Comments .............................................................................................................................. 569
DataModelObjectCategory ..................................................................................................... 569
Figures ................................................................................................................................... 569
Images ................................................................................................................................... 569
InternalObject ........................................................................................................................ 569
IsDistributedMass ................................................................................................................... 569
Location ................................................................................................................................. 570
RemotePoint .......................................................................................................................... 570
AddCommandSnippet() .......................................................................................................... 570
AddComment() ....................................................................................................................... 570
AddFigure() ............................................................................................................................ 570
AddImage(string) ................................................................................................................... 570
Delete() .................................................................................................................................. 571
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 571
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 571
Geometry ..................................................................................................................................... 572
ActiveBodies ........................................................................................................................... 575
AnalysisType ........................................................................................................................... 575
AssignMaterialOnUpdate ........................................................................................................ 575
AttachFileViaTempFile ............................................................................................................ 575
AttributeKey ........................................................................................................................... 576
Attributes ............................................................................................................................... 576
Average .................................................................................................................................. 576
Bodies .................................................................................................................................... 576
CanChangeCADUnits .............................................................................................................. 576
Children ................................................................................................................................. 576
Comments .............................................................................................................................. 577
ComparePartsOnUpdate ......................................................................................................... 577
ComparePartsTolerance .......................................................................................................... 577

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xlv
ACT API Reference Guide

DataModelObjectCategory ..................................................................................................... 577


DecomposeDisjointGeometry ................................................................................................. 577
DisplayStyle ............................................................................................................................ 577
ElementControl ...................................................................................................................... 578
Elements ................................................................................................................................ 578
EnclosureAndSymmetryProcessing ......................................................................................... 578
EndPlaneRotationAboutX ....................................................................................................... 578
EndPlaneRotationAboutY ....................................................................................................... 578
FiberLength ............................................................................................................................ 578
Figures ................................................................................................................................... 579
GeometryPreferencesReadOnly .............................................................................................. 579
Images ................................................................................................................................... 579
ImportCoordinateSystems ...................................................................................................... 579
InternalObject ........................................................................................................................ 579
LengthUnit ............................................................................................................................. 579
LengthX ................................................................................................................................. 580
LengthY ................................................................................................................................. 580
LengthZ ................................................................................................................................. 580
LineBodies .............................................................................................................................. 580
Mass ....................................................................................................................................... 580
MaterialProperties .................................................................................................................. 580
Maximum ............................................................................................................................... 581
MeshMetric ............................................................................................................................ 581
MeshVolume .......................................................................................................................... 581
Minimum ............................................................................................................................... 581
MixedImportResolution .......................................................................................................... 581
Model2DBehavior ................................................................................................................... 581
NamedSelectionKey ............................................................................................................... 582
NamedSelections .................................................................................................................... 582
Nodes ..................................................................................................................................... 582
ParameterKey ......................................................................................................................... 582
Parameters ............................................................................................................................. 582
ReaderModeSavesUpdatedFile ................................................................................................ 582
ScaleFactorValue ..................................................................................................................... 583
SheetSurfaceArea ................................................................................................................... 583
SmartCADUpdate ................................................................................................................... 583
SolidBodies ............................................................................................................................ 583
Source .................................................................................................................................... 583
StandardDeviation .................................................................................................................. 583
SurfaceArea ............................................................................................................................ 584
SurfaceBodies ......................................................................................................................... 584
TemporaryDirectory ................................................................................................................ 584
Tolerance2D ........................................................................................................................... 584
Type ....................................................................................................................................... 584
UseAssociativity ...................................................................................................................... 584
UseInstances .......................................................................................................................... 585
Volume ................................................................................................................................... 585
XCentroid ............................................................................................................................... 585
YCentroid ............................................................................................................................... 585
ZCentroid ............................................................................................................................... 585
AddComment() ....................................................................................................................... 585

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xlvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddDistributedMass() ............................................................................................................. 586


AddElementOrientation() ........................................................................................................ 586
AddFigure() ............................................................................................................................ 586
AddImage(string) ................................................................................................................... 586
AddImportedElementOrientationExternalData() ...................................................................... 586
AddImportedThicknessExternalData() ..................................................................................... 587
AddLayeredSection() .............................................................................................................. 587
AddPointMass() ...................................................................................................................... 587
AddSurfaceCoating() .............................................................................................................. 587
AddThermalPointMass() .......................................................................................................... 587
AddThickness() ....................................................................................................................... 587
CenterOfMass(IList<IBaseGeoBody>, IList<PointMass>, IList<DistributedMass>) ...................... 588
ExportParts(string, IList<int>) .................................................................................................. 588
FreezeMeshOnAllParts() .......................................................................................................... 588
GetBody(IBaseGeoBody) ......................................................................................................... 589
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 589
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 589
GetPart(IBaseGeoPart) ............................................................................................................ 590
InvertSuppressedBodySet() ..................................................................................................... 590
ResetBodyColors() .................................................................................................................. 590
UnfreezeMeshOnAllParts() ...................................................................................................... 590
UnsuppressAllBodies() ............................................................................................................ 591
UpdateGeometryFromSource() ............................................................................................... 591
GeometryFileContainer ................................................................................................................. 591
Children ................................................................................................................................. 592
Comments .............................................................................................................................. 592
DataModelObjectCategory ..................................................................................................... 592
Figures ................................................................................................................................... 592
Images ................................................................................................................................... 592
InternalObject ........................................................................................................................ 592
LengthUnits ............................................................................................................................ 593
ShowAlways ........................................................................................................................... 593
Statistics ................................................................................................................................. 593
Suppressed ............................................................................................................................ 593
AddComment() ....................................................................................................................... 593
AddFigure() ............................................................................................................................ 593
AddImage(string) ................................................................................................................... 594
Delete() .................................................................................................................................. 594
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 594
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 595
ImportSTL() ............................................................................................................................ 595
GeometryImport .......................................................................................................................... 595
Children ................................................................................................................................. 596
Comments .............................................................................................................................. 596
DataModelObjectCategory ..................................................................................................... 597
Figures ................................................................................................................................... 597
Images ................................................................................................................................... 597
InternalObject ........................................................................................................................ 597
Parts ....................................................................................................................................... 597
AddComment() ....................................................................................................................... 597
AddFigure() ............................................................................................................................ 598

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xlvii
ACT API Reference Guide

AddImage(string) ................................................................................................................... 598


GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 598
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 598
GetFormat() ............................................................................................................................ 599
GetGeometryURI() .................................................................................................................. 599
GetPreferences() ..................................................................................................................... 599
Import(string, Format, GeometryImportPreferences) ................................................................ 599
GeometryImportGroup ................................................................................................................. 600
Children ................................................................................................................................. 601
Comments .............................................................................................................................. 601
Count ..................................................................................................................................... 601
DataModelObjectCategory ..................................................................................................... 601
Figures ................................................................................................................................... 601
Images ................................................................................................................................... 602
InternalObject ........................................................................................................................ 602
Item(int) ................................................................................................................................. 602
AddComment() ....................................................................................................................... 602
AddFigure() ............................................................................................................................ 602
AddGeometryImport() ............................................................................................................ 603
AddImage(string) ................................................................................................................... 603
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 603
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 603
GlobalVonMisesStressConstraint ................................................................................................... 604
DataModelObjectCategory ..................................................................................................... 605
InternalObject ........................................................................................................................ 605
Maximum ............................................................................................................................... 605
ScopingMethod ...................................................................................................................... 605
StressType .............................................................................................................................. 605
HatCrossSection ........................................................................................................................... 605
Area ....................................................................................................................................... 606
DataModelObjectCategory ..................................................................................................... 606
InternalObject ........................................................................................................................ 607
IYY ......................................................................................................................................... 607
IZZ ......................................................................................................................................... 607
Thick1 .................................................................................................................................... 607
Thick2 .................................................................................................................................... 607
Thick3 .................................................................................................................................... 607
Thick4 .................................................................................................................................... 608
Thick5 .................................................................................................................................... 608
Width1 ................................................................................................................................... 608
Width2 ................................................................................................................................... 608
Width3 ................................................................................................................................... 608
Width4 ................................................................................................................................... 608
HollowRectangularCrossSection ................................................................................................... 609
Area ....................................................................................................................................... 609
DataModelObjectCategory ..................................................................................................... 610
InternalObject ........................................................................................................................ 610
IYY ......................................................................................................................................... 610
IZZ ......................................................................................................................................... 610
Thick1 .................................................................................................................................... 610
Thick2 .................................................................................................................................... 610

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xlviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Thick3 .................................................................................................................................... 611


Thick4 .................................................................................................................................... 611
Width1 ................................................................................................................................... 611
Width2 ................................................................................................................................... 611
HousingConstraint ........................................................................................................................ 611
DataModelObjectCategory ..................................................................................................... 612
HousingLocation .................................................................................................................... 612
HousingScopingMethod ......................................................................................................... 612
InternalObject ........................................................................................................................ 613
Location ................................................................................................................................. 613
ScopingMethod ...................................................................................................................... 613
ICrossSection ................................................................................................................................ 613
Area ....................................................................................................................................... 614
DataModelObjectCategory ..................................................................................................... 614
InternalObject ........................................................................................................................ 614
IYY ......................................................................................................................................... 614
IZZ ......................................................................................................................................... 615
Thick1 .................................................................................................................................... 615
Thick2 .................................................................................................................................... 615
Thick3 .................................................................................................................................... 615
Width1 ................................................................................................................................... 615
Width2 ................................................................................................................................... 615
Width3 ................................................................................................................................... 616
Image ........................................................................................................................................... 616
Children ................................................................................................................................. 616
Comments .............................................................................................................................. 616
DataModelObjectCategory ..................................................................................................... 617
Images ................................................................................................................................... 617
InternalObject ........................................................................................................................ 617
AddComment() ....................................................................................................................... 617
AddImage(string) ................................................................................................................... 617
Delete() .................................................................................................................................. 618
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 618
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 618
ImagePlane .................................................................................................................................. 619
Children ................................................................................................................................. 620
Comments .............................................................................................................................. 620
CoordinateSystem .................................................................................................................. 620
CoordinateSystemVisible ........................................................................................................ 620
DataModelObjectCategory ..................................................................................................... 621
FlipHorizontally ...................................................................................................................... 621
FlipVertically ........................................................................................................................... 621
Height .................................................................................................................................... 621
ImageFilePath ......................................................................................................................... 621
Images ................................................................................................................................... 621
InternalObject ........................................................................................................................ 622
PixelHeight ............................................................................................................................. 622
PixelWidth .............................................................................................................................. 622
ShowAlways ........................................................................................................................... 622
Translucency .......................................................................................................................... 622
Width ..................................................................................................................................... 622

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xlix
ACT API Reference Guide

AddComment() ....................................................................................................................... 623


Delete() .................................................................................................................................. 623
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 623
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 623
Import(string) ......................................................................................................................... 624
ImportedBoltPretensions .............................................................................................................. 624
DataModelObjectCategory ..................................................................................................... 625
InternalObject ........................................................................................................................ 625
ImportedCondensedPart .............................................................................................................. 625
ActualNodeOffset ................................................................................................................... 629
CondensedPartFileName ........................................................................................................ 629
CondensedPartUnitSystem ..................................................................................................... 629
CoordinateSystem .................................................................................................................. 629
DataModelObjectCategory ..................................................................................................... 630
ExpansionStatus ..................................................................................................................... 630
FutureIntent ........................................................................................................................... 630
ImportFileFormat .................................................................................................................... 630
ImportStatus .......................................................................................................................... 630
InternalObject ........................................................................................................................ 630
NodeOffset ............................................................................................................................. 631
CreateJointFromNodeIds(IEnumerable<int>) .......................................................................... 631
CreateJoints(IEnumerable<int>) .............................................................................................. 631
CreateNodalNamedSelectionFromNodeIds(IEnumerable<int>) ............................................... 631
CreateNodalNamedSelections(IEnumerable<int>) ................................................................... 632
CreateRemotePointFromNodeIds(IEnumerable<int>) .............................................................. 632
CreateRemotePoints(IEnumerable<int>) ................................................................................. 632
GetOriginalNodeCoordinates() ................................................................................................ 633
GetTransformedNodeCoordinates() ......................................................................................... 633
ImportCondensedPart() .......................................................................................................... 633
ReadInterfaceData() ................................................................................................................ 633
UpdateNodeLocation(int, Quantity, Quantity, Quantity, Quantity, Quantity, Quantity) ................ 633
ImportedConstraintEquations ....................................................................................................... 634
DataModelObjectCategory ..................................................................................................... 635
InternalObject ........................................................................................................................ 635
ImportedContacts ........................................................................................................................ 635
DataModelObjectCategory ..................................................................................................... 636
InternalObject ........................................................................................................................ 636
ImportedCoordinateSystems ........................................................................................................ 636
DataModelObjectCategory ..................................................................................................... 637
InternalObject ........................................................................................................................ 637
ImportedElementOrientations ...................................................................................................... 637
DataModelObjectCategory ..................................................................................................... 638
InternalObject ........................................................................................................................ 638
ImportedFlexibleRemoteConnectors ............................................................................................. 639
DataModelObjectCategory ..................................................................................................... 639
InternalObject ........................................................................................................................ 640
ImportedLayeredSection .............................................................................................................. 640
DataModelObjectCategory ..................................................................................................... 641
InternalObject ........................................................................................................................ 641
ImportedNodalOrientations .......................................................................................................... 641
DataModelObjectCategory ..................................................................................................... 642

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
l of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

InternalObject ........................................................................................................................ 642


ImportedObject ............................................................................................................................ 642
Active ..................................................................................................................................... 643
InternalObject ........................................................................................................................ 643
GetPropertyNames() ............................................................................................................... 643
GetPropertyValueAsString(string) ........................................................................................... 643
SetPropertyValue(string, object) .............................................................................................. 644
ImportedPlies ............................................................................................................................... 644
DataModelObjectCategory ..................................................................................................... 645
InternalObject ........................................................................................................................ 645
ImportedPliesCollection ............................................................................................................... 645
Children ................................................................................................................................. 646
Comments .............................................................................................................................. 646
DataModelObjectCategory ..................................................................................................... 646
Figures ................................................................................................................................... 647
Images ................................................................................................................................... 647
InternalObject ........................................................................................................................ 647
AddComment() ....................................................................................................................... 647
AddFigure() ............................................................................................................................ 647
AddImage(string) ................................................................................................................... 647
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 648
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 648
ImportedPointMasses ................................................................................................................... 649
DataModelObjectCategory ..................................................................................................... 649
InternalObject ........................................................................................................................ 650
ImportedPremeshedBoltPretensions ............................................................................................. 650
DataModelObjectCategory ..................................................................................................... 651
InternalObject ........................................................................................................................ 651
ImportedRigidRemoteConnectors ................................................................................................. 651
DataModelObjectCategory ..................................................................................................... 652
InternalObject ........................................................................................................................ 652
ImportedShellThicknesses ............................................................................................................ 652
DataModelObjectCategory ..................................................................................................... 653
InternalObject ........................................................................................................................ 653
ImportedSpringConnectors .......................................................................................................... 653
DataModelObjectCategory ..................................................................................................... 654
InternalObject ........................................................................................................................ 654
ImportedStresses .......................................................................................................................... 654
DataModelObjectCategory ..................................................................................................... 655
InternalObject ........................................................................................................................ 655
InitialCondition ............................................................................................................................. 655
Children ................................................................................................................................. 658
Comments .............................................................................................................................. 658
ContactStatus ......................................................................................................................... 658
CoordinateSystem .................................................................................................................. 658
DataModelObjectCategory ..................................................................................................... 658
DefineBy ................................................................................................................................ 658
Direction ................................................................................................................................ 659
DropDirection ........................................................................................................................ 659
DropHeight ............................................................................................................................ 659
DropTestDefineBy ................................................................................................................... 659

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. li
ACT API Reference Guide

ExplicitPreStressTime .............................................................................................................. 659


Figures ................................................................................................................................... 659
Images ................................................................................................................................... 660
ImpactVelocity ........................................................................................................................ 660
InitialEnvironment .................................................................................................................. 660
InitialTemperature .................................................................................................................. 660
InitialTemperatureValue .......................................................................................................... 660
InputType ............................................................................................................................... 660
InternalObject ........................................................................................................................ 661
LoadControl ........................................................................................................................... 661
Location ................................................................................................................................. 661
ModalEnvironmentHarmonicIC ***OBSOLETE*** Use 'ModalICEnvironment' property in-
stead. ..................................................................................................................................... 661
ModalEnvironmentPSDIC ***OBSOLETE*** Use 'ModalICEnvironment' property instead. .......... 661
ModalEnvironmentRSIC ***OBSOLETE*** Use 'ModalICEnvironment' property instead. ............ 662
ModalEnvironmentTransientMSUPIC ***OBSOLETE*** Use 'ModalICEnvironment' property in-
stead. ..................................................................................................................................... 662
ModalICEnvironment .............................................................................................................. 662
Mode ..................................................................................................................................... 662
NewtonRaphsonOption .......................................................................................................... 662
PressureInitialization ............................................................................................................... 662
PreStressDefineBy ................................................................................................................... 663
PreStressEnvironmentHarmonicIC ***OBSOLETE*** Use 'PreStressICEnvironment' property in-
stead. ..................................................................................................................................... 663
PreStressEnvironmentHarmonicMSUPModal ........................................................................... 663
PreStressEnvironmentModalIC ***OBSOLETE*** Use 'PreStressICEnvironment' property in-
stead. ..................................................................................................................................... 663
PreStressEnvironmentTransientIC ***OBSOLETE*** Use 'PreStressICEnvironment' property in-
stead. ..................................................................................................................................... 663
PreStressEnvironmentTransientMSUPModal ............................................................................ 664
PreStressICEnvironment .......................................................................................................... 664
PreStressLoadStep .................................................................................................................. 664
PreStressTime ......................................................................................................................... 664
ReferenceTemperature ............................................................................................................ 664
ReportedLoadStep .................................................................................................................. 664
ReportedSubStep ................................................................................................................... 665
ReportedTime ........................................................................................................................ 665
Suppressed ............................................................................................................................ 665
Time ....................................................................................................................................... 665
TimeStepFactor ...................................................................................................................... 665
TotalMagnitude ...................................................................................................................... 665
XComponent .......................................................................................................................... 666
YComponent .......................................................................................................................... 666
ZComponent .......................................................................................................................... 666
AddCommandSnippet() .......................................................................................................... 666
AddComment() ....................................................................................................................... 666
AddFigure() ............................................................................................................................ 666
AddImage(string) ................................................................................................................... 667
Delete() .................................................................................................................................. 667
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 667
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 667

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

InitialConditions ........................................................................................................................... 668


Children ................................................................................................................................. 669
Comments .............................................................................................................................. 669
DataModelObjectCategory ..................................................................................................... 669
Figures ................................................................................................................................... 669
Images ................................................................................................................................... 669
InternalObject ........................................................................................................................ 669
AddComment() ....................................................................................................................... 670
AddFigure() ............................................................................................................................ 670
AddImage(string) ................................................................................................................... 670
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 670
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 671
InsertAngularVelocity() ........................................................................................................... 671
InsertDropHeight() ................................................................................................................. 671
InsertVelocity() ....................................................................................................................... 671
InterfaceDelamination .................................................................................................................. 672
AutomaticTimeStepping ......................................................................................................... 673
CriticalRate ............................................................................................................................. 673
DataModelObjectCategory ..................................................................................................... 673
DistanceTolerance .................................................................................................................. 673
FailureCriteriaOption .............................................................................................................. 673
GenerationMethod ................................................................................................................. 673
InitialCrack ............................................................................................................................. 674
InitialTimeStep ....................................................................................................................... 674
InternalObject ........................................................................................................................ 674
MatchControl ......................................................................................................................... 674
Material .................................................................................................................................. 674
MaximumTimeStep ................................................................................................................ 674
Method .................................................................................................................................. 675
MinimumTimeStep ................................................................................................................. 675
SourceLocation ....................................................................................................................... 675
Suppressed ............................................................................................................................ 675
TargetLocation ....................................................................................................................... 675
ToleranceType ........................................................................................................................ 675
Type ....................................................................................................................................... 676
JointBushingWorksheet ................................................................................................................ 676
GetBushingDampingPerThetaUnitX(int) .................................................................................. 677
GetBushingDampingPerThetaUnitY(int) .................................................................................. 677
GetBushingDampingPerThetaUnitZ(int) .................................................................................. 678
GetBushingDampingPerUnitX(int) .......................................................................................... 678
GetBushingDampingPerUnitY(int) ........................................................................................... 678
GetBushingDampingPerUnitZ(int) ........................................................................................... 679
GetBushingStiffnessPerThetaUnitX(int) ................................................................................... 679
GetBushingStiffnessPerThetaUnitY(int) ................................................................................... 679
GetBushingStiffnessPerThetaUnitZ(int) ................................................................................... 679
GetBushingStiffnessPerUnitX(int) ............................................................................................ 680
GetBushingStiffnessPerUnitY(int) ............................................................................................ 680
GetBushingStiffnessPerUnitZ(int) ............................................................................................ 680
SetBushingDampingPerThetaUnitX(int, double) ...................................................................... 681
SetBushingDampingPerThetaUnitY(int, double) ...................................................................... 681
SetBushingDampingPerThetaUnitZ(int, double) ...................................................................... 681

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. liii
ACT API Reference Guide

SetBushingDampingPerUnitX(int, double) ............................................................................... 682


SetBushingDampingPerUnitY(int, double) ............................................................................... 682
SetBushingDampingPerUnitZ(int, double) ............................................................................... 682
SetBushingStiffnessPerThetaUnitX(int, double) ........................................................................ 683
SetBushingStiffnessPerThetaUnitY(int, double) ........................................................................ 683
SetBushingStiffnessPerThetaUnitZ(int, double) ........................................................................ 683
SetBushingStiffnessPerUnitX(int, double) ................................................................................ 684
SetBushingStiffnessPerUnitY(int, double) ................................................................................. 684
SetBushingStiffnessPerUnitZ(int, double) ................................................................................ 685
LayeredSection ............................................................................................................................. 685
Children ................................................................................................................................. 686
Comments .............................................................................................................................. 686
CoordinateSystem .................................................................................................................. 686
DataModelObjectCategory ..................................................................................................... 686
Figures ................................................................................................................................... 687
Images ................................................................................................................................... 687
InternalObject ........................................................................................................................ 687
LayeredSectionMembraneOffset ............................................................................................. 687
Layers ..................................................................................................................................... 687
LayerToDisplay ....................................................................................................................... 687
Location ................................................................................................................................. 688
NonlinearEffects ..................................................................................................................... 688
OffsetType .............................................................................................................................. 688
Suppressed ............................................................................................................................ 688
ThermalStrainEffects ............................................................................................................... 688
TotalMass ............................................................................................................................... 688
TotalThickness ........................................................................................................................ 689
AddComment() ....................................................................................................................... 689
AddFigure() ............................................................................................................................ 689
AddImage(string) ................................................................................................................... 689
Delete() .................................................................................................................................. 689
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 690
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 690
LayeredSectionWorksheet ............................................................................................................ 690
RowCount .............................................................................................................................. 691
AddThicknessLayer(string, double, double) .............................................................................. 692
DeleteRow(int) ....................................................................................................................... 692
GetAngle(int) .......................................................................................................................... 692
GetMaterial(int) ...................................................................................................................... 693
GetThickness(int) .................................................................................................................... 693
InsertThicknessLayerAbove(string, double, double, int) ............................................................ 693
InsertThicknessLayerBelow(string, double, double, int) ............................................................. 694
SetAngle(int, double) .............................................................................................................. 694
SetMaterial(int, string) ............................................................................................................. 695
SetThickness(int, double) ........................................................................................................ 695
LCrossSection ............................................................................................................................... 696
Area ....................................................................................................................................... 696
DataModelObjectCategory ..................................................................................................... 696
InternalObject ........................................................................................................................ 697
IYY ......................................................................................................................................... 697
IZZ ......................................................................................................................................... 697

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
liv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Thick1 .................................................................................................................................... 697


Thick2 .................................................................................................................................... 697
Width1 ................................................................................................................................... 697
Width2 ................................................................................................................................... 698
LineChart2D ................................................................................................................................. 698
Children ................................................................................................................................. 698
DataModelObjectCategory ..................................................................................................... 698
InternalObject ........................................................................................................................ 699
Suppressed ............................................................................................................................ 699
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 699
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 699
LoadHelper ................................................................................................................................... 700
SwitchAmbientTemperatureToTabular(Convection) ................................................................. 700
SwitchFilmCoefficientToTabular(Convection) ........................................................................... 700
SwitchToTabular(GenericBoundaryCondition) ......................................................................... 701
LocalVonMisesStressConstraint ..................................................................................................... 701
DataModelObjectCategory ..................................................................................................... 702
InternalObject ........................................................................................................................ 702
Location ................................................................................................................................. 702
Maximum ............................................................................................................................... 702
ScopingMethod ...................................................................................................................... 702
ManufacturingConstraint .............................................................................................................. 702
Children ................................................................................................................................. 703
DataModelObjectCategory ..................................................................................................... 703
InternalObject ........................................................................................................................ 703
Selection ................................................................................................................................ 703
Suppressed ............................................................................................................................ 704
Delete() .................................................................................................................................. 704
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 704
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 704
RenameBasedOnDefinition() ................................................................................................... 705
MappingValidation ....................................................................................................................... 705
ActiveSequence ...................................................................................................................... 706
ActiveSequenceByValue .......................................................................................................... 706
BoundingTolerance ................................................................................................................ 706
Children ................................................................................................................................. 707
Comments .............................................................................................................................. 707
ComplexComponent .............................................................................................................. 707
Component ............................................................................................................................ 707
DataModelObjectCategory ..................................................................................................... 707
DefineActiveSequenceBy ........................................................................................................ 707
Display ................................................................................................................................... 708
DisplayDataType ..................................................................................................................... 708
Figures ................................................................................................................................... 708
FileIdentifierIndex ................................................................................................................... 708
Images ................................................................................................................................... 708
InternalObject ........................................................................................................................ 708
IsolineThickness ..................................................................................................................... 709
IsolineType ............................................................................................................................. 709
Layer ...................................................................................................................................... 709
LegendDivisions ..................................................................................................................... 709

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lv
ACT API Reference Guide

Scale ...................................................................................................................................... 709


ShellFace ................................................................................................................................ 709
Type ....................................................................................................................................... 710
AddComment() ....................................................................................................................... 710
AddFigure() ............................................................................................................................ 710
AddImage(string) ................................................................................................................... 710
Delete() .................................................................................................................................. 710
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 711
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 711
MassConstraint ............................................................................................................................. 711
DataModelObjectCategory ..................................................................................................... 712
DefineBy ................................................................................................................................ 712
InternalObject ........................................................................................................................ 713
Location ................................................................................................................................. 713
MaximumAbsoluteValue ......................................................................................................... 713
MinimumAbsoluteValue ......................................................................................................... 713
PercentageToRetain ................................................................................................................ 713
PercentageToRetainMax ......................................................................................................... 713
PercentageToRetainMin .......................................................................................................... 714
ScopingMethod ...................................................................................................................... 714
Selection ................................................................................................................................ 714
Material ........................................................................................................................................ 714
AssignedBodies ...................................................................................................................... 715
Children ................................................................................................................................. 715
Comments .............................................................................................................................. 715
DataModelObjectCategory ..................................................................................................... 715
Figures ................................................................................................................................... 716
Images ................................................................................................................................... 716
InternalObject ........................................................................................................................ 716
MaterialModels ....................................................................................................................... 716
AddComment() ....................................................................................................................... 716
AddFigure() ............................................................................................................................ 716
AddImage(string) ................................................................................................................... 717
AddMaterialAssignment() ....................................................................................................... 717
CreateMaterialAssignment() ***OBSOLETE*** Use 'AddMaterialAssignment' instead ................ 717
GetAsDictionary() ................................................................................................................... 717
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 717
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 718
MaterialAssignment ...................................................................................................................... 718
Children ................................................................................................................................. 719
Comments .............................................................................................................................. 719
DataModelObjectCategory ..................................................................................................... 720
FieldCoordinateSystem ........................................................................................................... 720
Figures ................................................................................................................................... 720
Images ................................................................................................................................... 720
InternalObject ........................................................................................................................ 720
Location ................................................................................................................................. 720
Material .................................................................................................................................. 721
MaterialName ***OBSOLETE*** Use 'Material' property instead. ............................................... 721
MaterialPolarizationDirection .................................................................................................. 721
NonlinearEffects ..................................................................................................................... 721

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

ReferenceTemperatureValue ................................................................................................... 721


Suppressed ............................................................................................................................ 721
ThermalStrainEffects ............................................................................................................... 722
UseReferenceTemperatureByBody .......................................................................................... 722
AddCommandSnippet() .......................................................................................................... 722
AddComment() ....................................................................................................................... 722
AddFigure() ............................................................................................................................ 722
AddImage(string) ................................................................................................................... 722
CreateMaterialPlot() ................................................................................................................ 723
Delete() .................................................................................................................................. 723
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 723
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 723
MaterialPlot .................................................................................................................................. 724
Children ................................................................................................................................. 725
DataModelObjectCategory ..................................................................................................... 725
InternalObject ........................................................................................................................ 725
Location ................................................................................................................................. 725
MaterialProperty ..................................................................................................................... 725
MaterialPropertyComponent .................................................................................................. 725
Suppressed ............................................................................................................................ 726
Clear() .................................................................................................................................... 726
Delete() .................................................................................................................................. 726
Generate() .............................................................................................................................. 726
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 726
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 727
Materials ...................................................................................................................................... 727
Children ................................................................................................................................. 728
Comments .............................................................................................................................. 728
DataModelObjectCategory ..................................................................................................... 728
Figures ................................................................................................................................... 728
Images ................................................................................................................................... 729
InternalObject ........................................................................................................................ 729
MaterialAssignments .............................................................................................................. 729
MaterialCount ......................................................................................................................... 729
AddComment() ....................................................................................................................... 729
AddFigure() ............................................................................................................................ 729
AddImage(string) ................................................................................................................... 730
AddImportedTraceExternalData() ............................................................................................ 730
AddMaterialAssignment() ....................................................................................................... 730
AddMaterialCombination() ..................................................................................................... 730
AddMaterialPlot() ................................................................................................................... 730
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 731
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 731
Import(string, ImportFormat, ImportSettings) .......................................................................... 731
RefreshMaterials() ................................................................................................................... 732
Measures ...................................................................................................................................... 732
Children ................................................................................................................................. 733
Comments .............................................................................................................................. 733
DataModelObjectCategory ..................................................................................................... 733
Figures ................................................................................................................................... 733
Images ................................................................................................................................... 733

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lvii
ACT API Reference Guide

InternalObject ........................................................................................................................ 734


AddComment() ....................................................................................................................... 734
AddCompositeCriterion() ........................................................................................................ 734
AddFigure() ............................................................................................................................ 734
AddImage(string) ................................................................................................................... 734
AddPrimaryCriterion() ............................................................................................................. 735
Delete() .................................................................................................................................. 735
EvaluateAllResults() ................................................................................................................. 735
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 735
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 736
MemberSizeManufacturingConstraint ........................................................................................... 736
DataModelObjectCategory ..................................................................................................... 737
GapSize .................................................................................................................................. 737
GapSizeControlledType ........................................................................................................... 737
InternalObject ........................................................................................................................ 737
Location ................................................................................................................................. 737
Maximum ............................................................................................................................... 738
MaxSize .................................................................................................................................. 738
Minimum ............................................................................................................................... 738
MinSize .................................................................................................................................. 738
ScopingMethod ...................................................................................................................... 738
MeshConnection .......................................................................................................................... 738
ContactRegion ........................................................................................................................ 740
DataModelObjectCategory ..................................................................................................... 740
InternalObject ........................................................................................................................ 741
MasterElementSizeFactor ........................................................................................................ 741
ThicknessScaleFactor .............................................................................................................. 741
ToleranceValue ....................................................................................................................... 741
CreateNamedSelection() ......................................................................................................... 741
FlipMasterSlave() .................................................................................................................... 741
MeshConnectionBase ................................................................................................................... 742
Children ................................................................................................................................. 743
Comments .............................................................................................................................. 743
DataModelObjectCategory ..................................................................................................... 743
Figures ................................................................................................................................... 743
Images ................................................................................................................................... 743
InternalObject ........................................................................................................................ 743
MasterBodies .......................................................................................................................... 744
MasterLocation ....................................................................................................................... 744
ScopeMode ............................................................................................................................ 744
ScopingMethod ...................................................................................................................... 744
SlaveBodies ............................................................................................................................ 744
SlaveLocation ......................................................................................................................... 744
SnapToBoundary .................................................................................................................... 745
SnapTolerance ........................................................................................................................ 745
SnapType ............................................................................................................................... 745
Suppressed ............................................................................................................................ 745
ToleranceSlider ....................................................................................................................... 745
ToleranceType ........................................................................................................................ 745
AddComment() ....................................................................................................................... 746
AddFigure() ............................................................................................................................ 746

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddImage(string) ................................................................................................................... 746


Delete() .................................................................................................................................. 746
Generate() .............................................................................................................................. 746
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 747
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 747
RenameBasedOnDefinition() ................................................................................................... 747
MeshConnectionGroup ................................................................................................................. 748
DataModelObjectCategory ..................................................................................................... 750
InternalObject ........................................................................................................................ 750
AddManualMeshConnection() ................................................................................................ 750
DetectConnections() ............................................................................................................... 750
Generate() .............................................................................................................................. 750
SearchConnectionsForDuplicatePairs() .................................................................................... 751
MeshControlWorksheet ................................................................................................................ 751
RowCount .............................................................................................................................. 751
AddRow() ............................................................................................................................... 752
ClearGenerateMesh() .............................................................................................................. 752
DeleteAllRows() ...................................................................................................................... 752
DeleteRow(int) ....................................................................................................................... 752
GenerateAtRow(int) ................................................................................................................ 752
GenerateMesh() ...................................................................................................................... 753
GetActiveState(int) ................................................................................................................. 753
GetNamedSelection(int) ......................................................................................................... 753
GetNamedSelectionId(int) ...................................................................................................... 753
SetActiveState(int, bool) .......................................................................................................... 754
SetNamedSelection(int, NamedSelection) ............................................................................... 754
SetNamedSelectionId(int, uint) ................................................................................................ 754
MeshEdit ...................................................................................................................................... 755
AssociateToPullGeometry ....................................................................................................... 756
Children ................................................................................................................................. 756
Comments .............................................................................................................................. 756
DataModelObjectCategory ..................................................................................................... 756
Figures ................................................................................................................................... 757
GenerateAutomaticMeshConnectionsOnRefresh ..................................................................... 757
Images ................................................................................................................................... 757
InternalObject ........................................................................................................................ 757
TransparencyEnabled ............................................................................................................. 757
AddComment() ....................................................................................................................... 757
AddContactMatchGroup() ....................................................................................................... 758
AddDirectMorph() .................................................................................................................. 758
AddFigure() ............................................................................................................................ 758
AddImage(string) ................................................................................................................... 758
AddManualMeshConnection() ................................................................................................ 758
AddMeshConnectionGroup() .................................................................................................. 759
AddNodeMerge() .................................................................................................................... 759
AddNodeMergeGroup() .......................................................................................................... 759
AddNodeMove() ..................................................................................................................... 759
AddPullExtrude() .................................................................................................................... 759
AddPullRevolve() .................................................................................................................... 759
AddPullSurfaceCoating() ......................................................................................................... 760
ClearGeneratedData() ............................................................................................................. 760

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lix
ACT API Reference Guide

CreateNamedSelectionForSharedNodes() ................................................................................ 760


Generate() .............................................................................................................................. 760
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 760
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 761
RenameBasedOnDefinition() ................................................................................................... 761
SearchConnectionsForDuplicatePairs() .................................................................................... 761
MeshExtrude ................................................................................................................................ 762
AxisOfRevolution .................................................................................................................... 764
Children ................................................................................................................................. 764
Comments .............................................................................................................................. 764
CoordinateSystem .................................................................................................................. 764
DataModelObjectCategory ..................................................................................................... 764
ElementOption ....................................................................................................................... 764
ExtrudeBy ............................................................................................................................... 765
FeatureAngle .......................................................................................................................... 765
Figures ................................................................................................................................... 765
Height .................................................................................................................................... 765
Images ................................................................................................................................... 765
InternalObject ........................................................................................................................ 765
Location ................................................................................................................................. 766
Material .................................................................................................................................. 766
MergeProfileNodes ................................................................................................................. 766
Method .................................................................................................................................. 766
NonlinearMaterialEffects ......................................................................................................... 766
NumberOfLayers .................................................................................................................... 767
RevolutionAngle ..................................................................................................................... 767
ScopingMethod ...................................................................................................................... 767
StiffnessOption ....................................................................................................................... 767
Suppressed ............................................................................................................................ 767
ThermalStrainCalculation ........................................................................................................ 767
Thickness ............................................................................................................................... 768
UpTo ...................................................................................................................................... 768
UpToTarget ............................................................................................................................. 768
UseCoordinateSystem ............................................................................................................. 768
UseFeatureAngle .................................................................................................................... 768
AddComment() ....................................................................................................................... 769
AddFigure() ............................................................................................................................ 769
AddImage(string) ................................................................................................................... 769
ClearGeneratedData() ............................................................................................................. 769
Delete() .................................................................................................................................. 769
Generate() .............................................................................................................................. 770
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 770
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 770
MeshNumbering .......................................................................................................................... 771
Children ................................................................................................................................. 771
Comments .............................................................................................................................. 771
CompressNodeNumbers ......................................................................................................... 772
DataModelObjectCategory ..................................................................................................... 772
ElementOffset ........................................................................................................................ 772
Figures ................................................................................................................................... 772
Images ................................................................................................................................... 772

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

InternalObject ........................................................................................................................ 772


NodeOffset ............................................................................................................................. 773
Suppressed ............................................................................................................................ 773
AddComment() ....................................................................................................................... 773
AddFigure() ............................................................................................................................ 773
AddImage(string) ................................................................................................................... 773
AddNumberingControl() ......................................................................................................... 774
Delete() .................................................................................................................................. 774
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 774
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 774
RenumberMesh() .................................................................................................................... 775
Model ........................................................................................................................................... 775
AEDTImportManager .............................................................................................................. 781
Ambient ................................................................................................................................. 781
AMProcess .............................................................................................................................. 782
Analyses ................................................................................................................................. 782
CellId ...................................................................................................................................... 782
Children ................................................................................................................................. 782
Color ...................................................................................................................................... 782
Comments .............................................................................................................................. 782
CondensedGeometry .............................................................................................................. 783
Connections ........................................................................................................................... 783
ConstructionGeometry ........................................................................................................... 783
Control ................................................................................................................................... 783
CoordinateSystems ................................................................................................................. 783
CrossSections ......................................................................................................................... 783
DataModelObjectCategory ..................................................................................................... 784
Diffuse .................................................................................................................................... 784
Environments ***OBSOLETE*** Use 'Analyses' property instead. .............................................. 784
FeatureDetection .................................................................................................................... 784
Figures ................................................................................................................................... 784
Fracture .................................................................................................................................. 784
Geometry ............................................................................................................................... 785
GeometryImportGroup ........................................................................................................... 785
Images ................................................................................................................................... 785
InternalObject ........................................................................................................................ 785
Materials ................................................................................................................................ 785
Measures ................................................................................................................................ 785
Mesh ...................................................................................................................................... 786
MeshEdit ................................................................................................................................ 786
MeshNumbering .................................................................................................................... 786
NamedSelections .................................................................................................................... 786
PartTransformGroup ............................................................................................................... 786
RemotePoints ......................................................................................................................... 786
Specular ................................................................................................................................. 787
Symmetry ............................................................................................................................... 787
SystemCaption ....................................................................................................................... 787
TableGroup ............................................................................................................................ 787
VirtualTopology ...................................................................................................................... 787
AddAMProcess() ..................................................................................................................... 787
AddChart() ............................................................................................................................. 788

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxi
ACT API Reference Guide

AddComment() ....................................................................................................................... 788


AddCompositeFailureCriteria() ................................................................................................ 788
AddCondensedGeometry() ..................................................................................................... 788
AddConnections() ................................................................................................................... 788
AddConstructionGeometry() ................................................................................................... 788
AddCoSimulationPin() ............................................................................................................ 789
AddCoupledFieldHarmonic() ................................................................................................... 789
AddCoupledFieldModal() ........................................................................................................ 789
AddCoupledFieldStatic() ......................................................................................................... 789
AddCoupledFieldTransient() .................................................................................................... 789
AddCrossSections() ................................................................................................................. 789
AddDesignAssessmentAnalysis() ............................................................................................. 790
AddDesignLifeAnalysis() ......................................................................................................... 790
AddEigenvalueBucklingAnalysis() ............................................................................................ 790
AddElectricAnalysis() .............................................................................................................. 790
AddExplicitDynamicsAnalysis() ............................................................................................... 790
AddFatigueCombination() ....................................................................................................... 790
AddFeatureDetection() ........................................................................................................... 791
AddFigure() ............................................................................................................................ 791
AddForcedResponseAnalysis() ................................................................................................ 791
AddFracture() ......................................................................................................................... 791
AddGeometryImportGroup() .................................................................................................. 791
AddHarmonicAcousticAnalysis() .............................................................................................. 792
AddHarmonicResponseAnalysis() ............................................................................................ 792
AddImage(string) ................................................................................................................... 792
AddImagePlane() .................................................................................................................... 792
AddLSDynaAnalysis() .............................................................................................................. 792
AddLSDynaRestartAnalysis() ................................................................................................... 793
AddMagnetostaticAnalysis() .................................................................................................... 793
AddMeasures() ....................................................................................................................... 793
AddMeshEdit() ........................................................................................................................ 793
AddMeshNumbering() ............................................................................................................ 793
AddModalAcousticAnalysis() ................................................................................................... 793
AddModalAnalysis() ................................................................................................................ 794
AddMotionAnalysis() .............................................................................................................. 794
AddNamedSelection() ............................................................................................................. 794
AddNamedSelectionFromSelectedConnections() .................................................................... 794
AddPartTransform() ................................................................................................................ 794
AddPythonCodeEventBased() ................................................................................................. 794
AddPythonResult() .................................................................................................................. 795
AddRandomVibrationAnalysis() .............................................................................................. 795
AddRemotePoint() .................................................................................................................. 795
AddResponseSpectrumAnalysis() ............................................................................................ 795
AddRigidDynamicsAnalysis() ................................................................................................... 795
AddSolutionCombination() ..................................................................................................... 795
AddStaticAcousticAnalysis() .................................................................................................... 796
AddStaticStructuralAnalysis() .................................................................................................. 796
AddSteadyStateThermalAnalysis() ........................................................................................... 796
AddSubstructureGenerationAnalysis() ..................................................................................... 796
AddSymmetry() ...................................................................................................................... 796
AddTableGroup(bool) ............................................................................................................. 796

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddThermalElectricAnalysis() .................................................................................................. 797


AddTopologyOptimizationAnalysis() ....................................................................................... 797
AddTransientStructuralAnalysis() ............................................................................................. 797
AddTransientThermalAnalysis() ............................................................................................... 797
AddTreeGroupingFolder(IDataModelObject) ........................................................................... 797
AddTreeGroupingFolder(IEnumerable) .................................................................................... 798
AddVirtualTopology() ............................................................................................................. 798
AutoFilter() ............................................................................................................................. 798
CenterOfMass() ....................................................................................................................... 798
ClearGeneratedData() ............................................................................................................. 799
CreateCylindricalBolt(object, object, object, object) .................................................................. 799
CreateCylindricalNut(object, object, object) ............................................................................. 799
CreateHexBolt(object, object, object, object) ............................................................................ 800
CreateHexNut(object, object, object) ....................................................................................... 800
CreatePartInstance(IGeoPart) .................................................................................................. 801
DeleteParts(object) ................................................................................................................. 801
DisableFilter() ......................................................................................................................... 801
EvaluateScriptDefinedResults() ............................................................................................... 802
FreezeMeshOnSelectedParts(object) ....................................................................................... 802
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 802
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 802
GetFECommandsRepository(string, string) .............................................................................. 803
GetResults() ............................................................................................................................ 803
GetTransformationOnPart(IGeoPart) ........................................................................................ 803
LoadResultFile(string) ............................................................................................................. 804
RefreshMaterials() ................................................................................................................... 804
SetTransformationOnPart(IGeoPart, RigidBodyTransformationMatrix) ...................................... 804
Solve(bool, SolveConfiguration) .............................................................................................. 805
Solve(bool, string) ................................................................................................................... 805
UnfreezeMeshOnSelectedParts(object) ................................................................................... 805
UpdateGeometryFromSource() ............................................................................................... 806
ModelImport ................................................................................................................................ 806
AnalysisTypeDimensionSetting ............................................................................................... 807
ApplicationSourceSetting ....................................................................................................... 808
BodyGroupByAnsysElmTypeNumber ....................................................................................... 808
BodyGroupByMaterialNumber ................................................................................................ 808
BodyGroupByThickness .......................................................................................................... 808
Children ................................................................................................................................. 808
Comments .............................................................................................................................. 808
CreateGeometry ..................................................................................................................... 809
CreateGeometryEdgeComponents ......................................................................................... 809
CreateGeometryFaceComponents .......................................................................................... 809
CreateGeometryVertexComponent ......................................................................................... 809
DataModelObjectCategory ..................................................................................................... 809
ElementComponentKey .......................................................................................................... 809
ElementOffset ........................................................................................................................ 810
FaceComponentKey ................................................................................................................ 810
Figures ................................................................................................................................... 810
GeometryComponentKey ....................................................................................................... 810
Images ................................................................................................................................... 810
ImportMaterials ...................................................................................................................... 810

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxiii
ACT API Reference Guide

InternalObject ........................................................................................................................ 811


MaterialConsolidation ............................................................................................................. 811
ModelImportSourceFilePath ................................................................................................... 811
NodalComponentKey ............................................................................................................. 811
NodeAndElementRenumberingMethod .................................................................................. 811
NodeOffset ............................................................................................................................. 811
ProcessElementComponents .................................................................................................. 812
ProcessFaceComponents ........................................................................................................ 812
ProcessLineBodies .................................................................................................................. 812
ProcessMesh200Elms .............................................................................................................. 812
ProcessModelData .................................................................................................................. 812
ProcessNodalComponents ...................................................................................................... 812
ProcessValidBlockedCDBFile ................................................................................................... 813
SourceIdentifier ...................................................................................................................... 813
ToleranceAngle ....................................................................................................................... 813
UnitSystemTypeForImport ...................................................................................................... 813
VertexInsertionAngle .............................................................................................................. 813
AddComment() ....................................................................................................................... 813
AddFigure() ............................................................................................................................ 814
AddImage(string) ................................................................................................................... 814
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 814
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 814
MomentOfInertiaConstraint .......................................................................................................... 815
Axis ........................................................................................................................................ 816
CoordinateSystem .................................................................................................................. 816
DataModelObjectCategory ..................................................................................................... 816
DefineBy ................................................................................................................................ 816
InternalObject ........................................................................................................................ 816
Location ................................................................................................................................. 817
MaximumValue ...................................................................................................................... 817
MinimumValue ....................................................................................................................... 817
PercentageToRetain ................................................................................................................ 817
PercentageToRetainMax ......................................................................................................... 817
PercentageToRetainMin .......................................................................................................... 817
ScopingMethod ...................................................................................................................... 818
Selection ................................................................................................................................ 818
MorphingRegion .......................................................................................................................... 818
BaseFrequency ....................................................................................................................... 819
Children ................................................................................................................................. 819
Comments .............................................................................................................................. 819
DataModelObjectCategory ..................................................................................................... 819
DisplayMesh ........................................................................................................................... 820
Figures ................................................................................................................................... 820
FixedLocation ......................................................................................................................... 820
Images ................................................................................................................................... 820
InternalObject ........................................................................................................................ 820
MaximumFrequency ............................................................................................................... 820
MinimumFrequency ............................................................................................................... 821
MorphingFrequency ............................................................................................................... 821
MorphingIntervals .................................................................................................................. 821
MovingLocation ..................................................................................................................... 821

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

RegionLocation ...................................................................................................................... 821


SlidingLocation ....................................................................................................................... 821
Suppressed ............................................................................................................................ 822
Thickness ............................................................................................................................... 822
AddComment() ....................................................................................................................... 822
AddFigure() ............................................................................................................................ 822
AddImage(string) ................................................................................................................... 822
Delete() .................................................................................................................................. 823
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 823
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 823
NamedSelection ........................................................................................................................... 824
Children ................................................................................................................................. 825
Comments .............................................................................................................................. 825
CrackFrontNumber ................................................................................................................. 825
CreatedForCrack ..................................................................................................................... 826
DataModelObjectCategory ..................................................................................................... 826
Figures ................................................................................................................................... 826
GenerationCriteria .................................................................................................................. 826
Images ................................................................................................................................... 826
IncludeProgramControlledInflation ......................................................................................... 826
InternalObject ........................................................................................................................ 827
Location ................................................................................................................................. 827
LSDynaUserId ......................................................................................................................... 827
PreserveDuringSolve .............................................................................................................. 827
RelativeTolerance .................................................................................................................... 827
ScopingMethod ...................................................................................................................... 827
SendAs ................................................................................................................................... 828
SendToSolver ......................................................................................................................... 828
Suppressed ............................................................................................................................ 828
ToleranceType ........................................................................................................................ 828
TotalSelection ......................................................................................................................... 828
Type ....................................................................................................................................... 828
UsedByMeshWorksheet .......................................................................................................... 829
Visible .................................................................................................................................... 829
ZeroTolerance ......................................................................................................................... 829
AddComment() ....................................................................................................................... 829
AddFigure() ............................................................................................................................ 829
AddImage(string) ................................................................................................................... 829
CreateNodalNamedSelection() ................................................................................................ 830
Delete() .................................................................................................................................. 830
ExportNamedSelectionToCDBFile(string) ................................................................................. 830
ExportToTextFile(string) .......................................................................................................... 830
Generate() .............................................................................................................................. 831
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 831
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 831
NamedSelectionCriteria ................................................................................................................ 832
Count ..................................................................................................................................... 832
Item(int) ................................................................................................................................. 832
Add(NamedSelectionCriterion) ............................................................................................... 833
Clear() .................................................................................................................................... 833
Contains(NamedSelectionCriterion) ........................................................................................ 833

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxv
ACT API Reference Guide

IndexOf(NamedSelectionCriterion) ......................................................................................... 833


Insert(int, NamedSelectionCriterion) ........................................................................................ 834
Remove(NamedSelectionCriterion) ......................................................................................... 834
RemoveAt(int) ........................................................................................................................ 834
NamedSelectionCriterion .............................................................................................................. 835
NamedSelectionCriterion(bool, SelectionActionType, SelectionType, SelectionCriterionType,
SelectionOperatorType, object, Quantity, Quantity, CoordinateSystem) ..................................... 835
Action .................................................................................................................................... 836
Active ..................................................................................................................................... 836
CoordinateSystem .................................................................................................................. 837
Criterion ................................................................................................................................. 837
EntityType .............................................................................................................................. 837
LowerBound ........................................................................................................................... 837
Operator ................................................................................................................................. 837
UpperBound ........................................................................................................................... 837
Value ...................................................................................................................................... 838
NamedSelections .......................................................................................................................... 838
Children ................................................................................................................................. 839
Comments .............................................................................................................................. 839
DataModelObjectCategory ..................................................................................................... 839
Figures ................................................................................................................................... 839
GenerateOnRefresh ................................................................................................................ 839
GenerateOnRemesh ............................................................................................................... 840
Images ................................................................................................................................... 840
InternalObject ........................................................................................................................ 840
RandomColors ........................................................................................................................ 840
ShowAnnotations ................................................................................................................... 840
AddComment() ....................................................................................................................... 840
AddFigure() ............................................................................................................................ 841
AddImage(string) ................................................................................................................... 841
AddNamedSelection() ............................................................................................................. 841
Delete() .................................................................................................................................. 841
ExportNamedSelectionToCDBFile(string) ................................................................................. 841
GenerateAllNamedSelections() ............................................................................................... 842
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 842
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 842
GoToNamedSelectionsCommonToSelection() ......................................................................... 843
GoToNamedSelectionsContainingSelection() .......................................................................... 843
NastranExportOptions .................................................................................................................. 843
NastranExportOptions(string, string, int, int, double, double, string, int, double, bool) ................. 844
AnalysisType ........................................................................................................................... 845
GridCS .................................................................................................................................... 845
GroundCheck ......................................................................................................................... 845
JointStiffness .......................................................................................................................... 845
Modes .................................................................................................................................... 845
NastranFilename ..................................................................................................................... 845
Offset ..................................................................................................................................... 846
PyramidElements .................................................................................................................... 846
Time ....................................................................................................................................... 846
WTMass .................................................................................................................................. 846
NaturalFrequencyConstraint ......................................................................................................... 846

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

DataModelObjectCategory ..................................................................................................... 847


InternalObject ........................................................................................................................ 847
MaximumFrequency ............................................................................................................... 847
MinimumFrequency ............................................................................................................... 847
ModeNumber ......................................................................................................................... 847
NodeMerge .................................................................................................................................. 848
Children ................................................................................................................................. 849
Comments .............................................................................................................................. 849
DataModelObjectCategory ..................................................................................................... 849
Figures ................................................................................................................................... 849
Images ................................................................................................................................... 849
InternalObject ........................................................................................................................ 849
MasterBodies .......................................................................................................................... 850
MasterLocation ....................................................................................................................... 850
ScopingMethod ...................................................................................................................... 850
SlaveBodies ............................................................................................................................ 850
SlaveLocation ......................................................................................................................... 850
Suppressed ............................................................................................................................ 850
ToleranceType ........................................................................................................................ 851
ToleranceValue ....................................................................................................................... 851
AddComment() ....................................................................................................................... 851
AddFigure() ............................................................................................................................ 851
AddImage(string) ................................................................................................................... 851
Delete() .................................................................................................................................. 852
Generate() .............................................................................................................................. 852
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 852
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 852
RenameBasedOnDefinition() ................................................................................................... 853
NodeMergeGroup ........................................................................................................................ 853
DataModelObjectCategory ..................................................................................................... 855
InternalObject ........................................................................................................................ 855
AddNodeMerge() .................................................................................................................... 855
GenerateNodeMerge() ............................................................................................................ 856
NodeMove ................................................................................................................................... 856
Children ................................................................................................................................. 857
Comments .............................................................................................................................. 857
DataModelObjectCategory ..................................................................................................... 857
Figures ................................................................................................................................... 857
Images ................................................................................................................................... 857
Information ............................................................................................................................ 858
InternalObject ........................................................................................................................ 858
NumberOfMoves .................................................................................................................... 858
NumberOfNodes .................................................................................................................... 858
AddComment() ....................................................................................................................... 858
AddFigure() ............................................................................................................................ 858
AddImage(string) ................................................................................................................... 859
Delete() .................................................................................................................................. 859
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 859
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 859
MorphNodes() ........................................................................................................................ 860
MoveNode(int, Quantity, Quantity, Quantity) ............................................................................ 860

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxvii
ACT API Reference Guide

UndoAllNodeMoves() ............................................................................................................. 861


UndoLastNodeMove() ............................................................................................................. 861
NumberingControl ....................................................................................................................... 861
BeginElementNumber ............................................................................................................ 862
BeginNodeNumber ................................................................................................................. 862
Children ................................................................................................................................. 862
Comments .............................................................................................................................. 862
DataModelObjectCategory ..................................................................................................... 862
EndElementNumber ............................................................................................................... 863
EndNodeNumber ................................................................................................................... 863
Figures ................................................................................................................................... 863
Images ................................................................................................................................... 863
InternalObject ........................................................................................................................ 863
Location ................................................................................................................................. 863
NodeNumber ......................................................................................................................... 864
Suppressed ............................................................................................................................ 864
AddComment() ....................................................................................................................... 864
AddFigure() ............................................................................................................................ 864
AddImage(string) ................................................................................................................... 864
Delete() .................................................................................................................................. 865
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 865
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 865
Objective ...................................................................................................................................... 866
Children ................................................................................................................................. 866
Comments .............................................................................................................................. 867
DataModelObjectCategory ..................................................................................................... 867
Images ................................................................................................................................... 867
InternalObject ........................................................................................................................ 867
NormalizedSum ...................................................................................................................... 867
Suppressed ............................................................................................................................ 867
Worksheet .............................................................................................................................. 868
AddComment() ....................................................................................................................... 868
AddImage(string) ................................................................................................................... 868
Delete() .................................................................................................................................. 868
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 868
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 869
ObjectiveWorksheet ..................................................................................................................... 869
RowCount .............................................................................................................................. 870
AddRow() ............................................................................................................................... 871
DeleteRow(int) ....................................................................................................................... 871
GetCriterion(int) ..................................................................................................................... 871
GetEnabled(int) ...................................................................................................................... 871
GetEndMode(int) .................................................................................................................... 872
GetEndStep(int) ...................................................................................................................... 872
GetEnvironment(int) ............................................................................................................... 872
GetFormulation(int) ................................................................................................................ 872
GetMode(int) .......................................................................................................................... 873
GetMultipleSets(int) ................................................................................................................ 873
GetObjectiveType(int) ............................................................................................................. 873
GetStartMode(int) ................................................................................................................... 874
GetStartStep(int) .................................................................................................................... 874

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

GetStep(int) ............................................................................................................................ 874


GetWeight(int) ........................................................................................................................ 874
SetCriterion(int, Criterion) ....................................................................................................... 875
SetEnabled(int, bool) ............................................................................................................... 875
SetEndMode(int, int) ............................................................................................................... 875
SetEndStep(int, int) ................................................................................................................. 876
SetEnvironment(int, Analysis) .................................................................................................. 876
SetFormulation(int, TopoObjectiveFormulation) ...................................................................... 876
SetMode(int, int) ..................................................................................................................... 877
SetMultipleSets(int, bool) ........................................................................................................ 877
SetObjectiveType(int, ObjectiveType) ...................................................................................... 878
SetStartMode(int, int) .............................................................................................................. 878
SetStartStep(int, int) ................................................................................................................ 878
SetStep(int, int) ....................................................................................................................... 879
SetWeight(int, double) ............................................................................................................ 879
OptimizationMaterial .................................................................................................................... 879
DensityMaximum ................................................................................................................... 880
DensityMinimum .................................................................................................................... 880
LatticeType ............................................................................................................................. 880
Material .................................................................................................................................. 880
VolumeFillingMethod ............................................................................................................. 881
OptimizationRegion ..................................................................................................................... 881
BoundaryCondition ................................................................................................................ 882
DataModelObjectCategory ..................................................................................................... 882
DesignRegionLocation ............................................................................................................ 883
ExclusionExtension ................................................................................................................. 883
ExclusionThickness ................................................................................................................. 883
HyperbolicProjection .............................................................................................................. 883
InitializationHoleSize .............................................................................................................. 883
InitializationModifierType ....................................................................................................... 883
InitialVolumeFraction .............................................................................................................. 884
InternalObject ........................................................................................................................ 884
LatticeMaxDensity .................................................................................................................. 884
LatticeMinDensity ................................................................................................................... 884
LatticeSize .............................................................................................................................. 884
LatticeType ............................................................................................................................. 884
MeshDeformationToleranceControl ........................................................................................ 885
MorphingIterationMoveLimit .................................................................................................. 885
MorphingTotalMeshDeformationTolerance ............................................................................. 885
OptimizationType ................................................................................................................... 885
PenaltyFactor ......................................................................................................................... 885
ShapeMoveLimitControl ......................................................................................................... 885
AddExclusionRegion() ............................................................................................................. 886
GetDefinition() ........................................................................................................................ 886
RenameBasedOnDefinition() ................................................................................................... 886
OptimizationRegionBaseClass ....................................................................................................... 886
Children ................................................................................................................................. 887
ExclusionRegionLocation ........................................................................................................ 887
ExclusionScopingMethod ....................................................................................................... 887
InternalObject ........................................................................................................................ 887
MaxCumulatedDisplacementControl ....................................................................................... 887

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxix
ACT API Reference Guide

MorphingTotalMoveLimit ....................................................................................................... 887


Delete() .................................................................................................................................. 888
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 888
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 888
ParameterVariable ........................................................................................................................ 889
Children ................................................................................................................................. 889
Comments .............................................................................................................................. 889
DataModelObjectCategory ..................................................................................................... 890
Figures ................................................................................................................................... 890
Images ................................................................................................................................... 890
InternalObject ........................................................................................................................ 890
AddComment() ....................................................................................................................... 890
AddFigure() ............................................................................................................................ 890
AddImage(string) ................................................................................................................... 891
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 891
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 891
ParameterVariableGroup ............................................................................................................... 892
Children ................................................................................................................................. 892
Comments .............................................................................................................................. 893
DataModelObjectCategory ..................................................................................................... 893
Figures ................................................................................................................................... 893
Images ................................................................................................................................... 893
InternalObject ........................................................................................................................ 893
AddComment() ....................................................................................................................... 893
AddFigure() ............................................................................................................................ 894
AddImage(string) ................................................................................................................... 894
AddParameterVariable() .......................................................................................................... 894
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 894
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 895
Part .............................................................................................................................................. 895
ApproximateSurfaceArea ........................................................................................................ 897
Assignment ***OBSOLETE*** Use 'Material' property instead. .................................................. 897
Average .................................................................................................................................. 897
CentroidX ............................................................................................................................... 897
CentroidY ............................................................................................................................... 897
CentroidZ ............................................................................................................................... 897
Children ................................................................................................................................. 898
Comments .............................................................................................................................. 898
ConfigurationId ...................................................................................................................... 898
CoordinateSystem .................................................................................................................. 898
DataModelObjectCategory ..................................................................................................... 898
Elements ................................................................................................................................ 898
Figures ................................................................................................................................... 899
Hidden ................................................................................................................................... 899
Images ................................................................................................................................... 899
InternalObject ........................................................................................................................ 899
LengthX ................................................................................................................................. 899
LengthY ................................................................................................................................. 899
LengthZ ................................................................................................................................. 900
Mass ....................................................................................................................................... 900
Material .................................................................................................................................. 900

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

MaterialName ***OBSOLETE*** Use 'Assignment' property instead. ......................................... 900


Maximum ............................................................................................................................... 900
MeshMetric ............................................................................................................................ 900
Minimum ............................................................................................................................... 901
MomentOfInertiaIp1 ............................................................................................................... 901
MomentOfInertiaIp2 ............................................................................................................... 901
MomentOfInertiaIp3 ............................................................................................................... 901
Nodes ..................................................................................................................................... 901
ResultMeshId .......................................................................................................................... 901
StandardDeviation .................................................................................................................. 902
Suppressed ............................................................................................................................ 902
Visible .................................................................................................................................... 902
Volume ................................................................................................................................... 902
AddComment() ....................................................................................................................... 902
AddFigure() ............................................................................................................................ 902
AddImage(string) ................................................................................................................... 903
ClearGeneratedData() ............................................................................................................. 903
GenerateMesh() ...................................................................................................................... 903
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 903
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 904
PreviewInflation() ................................................................................................................... 904
PreviewSurfaceMesh() ............................................................................................................ 904
Update() ................................................................................................................................. 904
PartTransform ............................................................................................................................... 905
Children ................................................................................................................................. 906
Comments .............................................................................................................................. 906
CoordinateSystem .................................................................................................................. 906
DataModelObjectCategory ..................................................................................................... 906
DefineBy ................................................................................................................................ 906
Figures ................................................................................................................................... 906
Images ................................................................................................................................... 907
InternalObject ........................................................................................................................ 907
Location ................................................................................................................................. 907
RotationX ............................................................................................................................... 907
RotationY ............................................................................................................................... 907
RotationZ ............................................................................................................................... 907
ScopingMethod ...................................................................................................................... 908
SourceCoordinateSystem ........................................................................................................ 908
Suppressed ............................................................................................................................ 908
TargetCoordinateSystem ......................................................................................................... 908
TranslationX ........................................................................................................................... 908
TranslationY ........................................................................................................................... 908
TranslationZ ........................................................................................................................... 909
AddComment() ....................................................................................................................... 909
AddFigure() ............................................................................................................................ 909
AddImage(string) ................................................................................................................... 909
Delete() .................................................................................................................................. 909
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 910
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 910
TransformGeometry() ............................................................................................................. 910
PartTransformGroup ..................................................................................................................... 911

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxxi
ACT API Reference Guide

Children ................................................................................................................................. 911


Comments .............................................................................................................................. 912
DataModelObjectCategory ..................................................................................................... 912
Figures ................................................................................................................................... 912
Images ................................................................................................................................... 912
InternalObject ........................................................................................................................ 912
RegenerateContacts ............................................................................................................... 912
Suppressed ............................................................................................................................ 913
TransformMesh ....................................................................................................................... 913
AddComment() ....................................................................................................................... 913
AddFigure() ............................................................................................................................ 913
AddImage(string) ................................................................................................................... 913
AddPartTransform() ................................................................................................................ 914
Delete() .................................................................................................................................. 914
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 914
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 914
TransformGeometry() ............................................................................................................. 915
Path ............................................................................................................................................. 915
Children ................................................................................................................................. 916
Comments .............................................................................................................................. 916
DataModelObjectCategory ..................................................................................................... 917
DiscretizationPoints ................................................................................................................ 917
EndCoordinateSystem ............................................................................................................ 917
EndXCoordinate ..................................................................................................................... 917
EndYCoordinate ...................................................................................................................... 917
EndZCoordinate ..................................................................................................................... 917
Figures ................................................................................................................................... 918
HasValidGeometrySelection .................................................................................................... 918
Images ................................................................................................................................... 918
InternalObject ........................................................................................................................ 918
Location ................................................................................................................................. 918
NumberOfSamplingPoints ...................................................................................................... 918
NumberOfSubpaths ................................................................................................................ 919
OffsetEdgeLocation ................................................................................................................ 919
PathCoordinateSystem ........................................................................................................... 919
PathType ................................................................................................................................ 919
ShowMesh ............................................................................................................................. 919
SnapToMeshNodes ................................................................................................................. 919
StartCoordinateSystem ........................................................................................................... 920
StartXCoordinate .................................................................................................................... 920
StartYCoordinate .................................................................................................................... 920
StartZCoordinate .................................................................................................................... 920
Suppressed ............................................................................................................................ 920
AddComment() ....................................................................................................................... 920
AddFigure() ............................................................................................................................ 921
AddImage(string) ................................................................................................................... 921
Delete() .................................................................................................................................. 921
FlipPathOrientatation() ........................................................................................................... 921
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 921
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 922
SnapPathToMeshNodes() ........................................................................................................ 922

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

PatternRepetitionConstraint ......................................................................................................... 922


Axis ........................................................................................................................................ 923
CoordinateSystem .................................................................................................................. 923
DataModelObjectCategory ..................................................................................................... 923
InternalObject ........................................................................................................................ 924
Location ................................................................................................................................. 924
Offset ..................................................................................................................................... 924
ScopingMethod ...................................................................................................................... 924
PeriodicRegion ............................................................................................................................. 924
DataModelObjectCategory ..................................................................................................... 925
InternalObject ........................................................................................................................ 925
Type ....................................................................................................................................... 926
PhysicsRegion .............................................................................................................................. 926
Acoustics ................................................................................................................................ 927
ArtificiallyMatchedLayers ........................................................................................................ 928
Children ................................................................................................................................. 928
Comments .............................................................................................................................. 928
DataModelObjectCategory ..................................................................................................... 928
Electric ................................................................................................................................... 928
ElectrostaticForce ................................................................................................................... 928
ElementMorphing .................................................................................................................. 929
EvanescentWaveAttenuation .................................................................................................. 929
Figures ................................................................................................................................... 929
FluidBehavior ......................................................................................................................... 929
Images ................................................................................................................................... 929
InternalObject ........................................................................................................................ 929
Location ................................................................................................................................. 930
Piezoelectric ........................................................................................................................... 930
PMLElementCoordinateSystem ............................................................................................... 930
PMLOptions ............................................................................................................................ 930
ReferencePressure .................................................................................................................. 930
ReferenceStaticPressure .......................................................................................................... 930
ReflectionCoefficient .............................................................................................................. 931
ReflectionCoefficientInNegativeXDirection .............................................................................. 931
ReflectionCoefficientInNegativeYDirection .............................................................................. 931
ReflectionCoefficientInNegativeZDirection .............................................................................. 931
ReflectionCoefficientInPositiveXDirection ............................................................................... 931
ReflectionCoefficientInPositiveYDirection ................................................................................ 931
ReflectionCoefficientInPositiveZDirection ................................................................................ 932
ReflectionCoefficientsType ...................................................................................................... 932
Structural ............................................................................................................................... 932
Suppressed ............................................................................................................................ 932
Thermal .................................................................................................................................. 932
ThermalStrain ......................................................................................................................... 932
ThermoelasticDamping .......................................................................................................... 933
AddComment() ....................................................................................................................... 933
AddFigure() ............................................................................................................................ 933
AddImage(string) ................................................................................................................... 933
Delete() .................................................................................................................................. 933
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 934
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 934

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxxiii
ACT API Reference Guide

RenameBasedOnDefinition() ................................................................................................... 934


SelectInvalidBodiesOnPhysicsRegion() .................................................................................... 935
PipeIdealization ............................................................................................................................ 935
Children ................................................................................................................................. 935
DataModelObjectCategory ..................................................................................................... 936
Extend .................................................................................................................................... 936
Factor ..................................................................................................................................... 936
GeometrySelection ................................................................................................................. 936
InternalObject ........................................................................................................................ 936
Suppressed ............................................................................................................................ 936
Delete() .................................................................................................................................. 937
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 937
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 937
PointMass ..................................................................................................................................... 938
AppliedBy ............................................................................................................................... 939
BeamRadius ........................................................................................................................... 939
Behavior ................................................................................................................................. 939
CoordinateSystem .................................................................................................................. 939
DataModelObjectCategory ..................................................................................................... 939
ElementAPDLName ................................................................................................................ 940
InternalObject ........................................................................................................................ 940
Mass ....................................................................................................................................... 940
MassMomentOfInertiaX .......................................................................................................... 940
MassMomentOfInertiaY .......................................................................................................... 940
MassMomentOfInertiaZ .......................................................................................................... 940
Material .................................................................................................................................. 941
NodalCoordinateSystem ......................................................................................................... 941
PinballRegion ......................................................................................................................... 941
Suppressed ............................................................................................................................ 941
XCoordinate ........................................................................................................................... 941
YCoordinate ........................................................................................................................... 941
ZCoordinate ........................................................................................................................... 942
PromoteToRemotePoint() ........................................................................................................ 942
PostContactTool ........................................................................................................................... 942
DataModelObjectCategory ..................................................................................................... 943
InternalObject ........................................................................................................................ 943
AddFluidPressure() .................................................................................................................. 943
AddFrictionalStress() ............................................................................................................... 943
AddHeatFlux() ........................................................................................................................ 943
AddPressure() ......................................................................................................................... 944
AddSlidingDistance() .............................................................................................................. 944
PreContactTool ............................................................................................................................. 944
DataModelObjectCategory ..................................................................................................... 945
InternalObject ........................................................................................................................ 945
AddGap() ................................................................................................................................ 945
AddInitialInformation() ........................................................................................................... 945
AddPenetration() .................................................................................................................... 945
AddStatus() ............................................................................................................................ 946
PreMeshedCrack ........................................................................................................................... 946
BottomFaceNodes .................................................................................................................. 947
CoordinateSystem .................................................................................................................. 947

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

CrackFacesNodes .................................................................................................................... 947


CrackFront .............................................................................................................................. 947
CrackSourceType .................................................................................................................... 947
CrackSymmetry ...................................................................................................................... 947
DataModelObjectCategory ..................................................................................................... 948
InternalObject ........................................................................................................................ 948
ScopingMethod ...................................................................................................................... 948
SolutionContours ................................................................................................................... 948
Suppressed ............................................................................................................................ 948
TopFaceNodes ........................................................................................................................ 948
PreMeshedCyclicRegion ................................................................................................................ 949
BoundaryDOFOrientation ....................................................................................................... 950
DataModelObjectCategory ..................................................................................................... 950
InternalObject ........................................................................................................................ 950
NumberOfSectors ................................................................................................................... 950
RelativeDistanceTolerance ...................................................................................................... 950
PrimaryCriterion ........................................................................................................................... 950
BaseResult .............................................................................................................................. 952
BoundaryCondition ................................................................................................................ 952
CoordinateSystem .................................................................................................................. 952
DataModelObjectCategory ..................................................................................................... 952
DirectionX .............................................................................................................................. 952
DirectionY .............................................................................................................................. 953
DirectionZ .............................................................................................................................. 953
DiscretizationError .................................................................................................................. 953
FrequencyRangeType ............................................................................................................. 953
FrequencyReduction .............................................................................................................. 953
InternalObject ........................................................................................................................ 953
Location ................................................................................................................................. 954
LocationMethod ..................................................................................................................... 954
MaximumFrequency ............................................................................................................... 954
MinimumFrequency ............................................................................................................... 954
ModeNumber ......................................................................................................................... 954
ReferenceType ........................................................................................................................ 954
RemotePoint .......................................................................................................................... 955
RobustFrequenciesReduction ................................................................................................. 955
SpatialReduction .................................................................................................................... 955
SpatialReductionMethod ........................................................................................................ 955
Step ....................................................................................................................................... 955
Value ...................................................................................................................................... 955
VectorReduction ..................................................................................................................... 956
ClearGeneratedData() ............................................................................................................. 956
EvaluateAllResults() ................................................................................................................. 956
RenameBasedOnDefinition() ................................................................................................... 956
Project .......................................................................................................................................... 956
Author .................................................................................................................................... 958
Children ................................................................................................................................. 958
Comments .............................................................................................................................. 958
CreationDate .......................................................................................................................... 958
CreationTime .......................................................................................................................... 959
DataModelObjectCategory ..................................................................................................... 959

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxxv
ACT API Reference Guide

FilePath .................................................................................................................................. 959


FirstSaved ............................................................................................................................... 959
Images ................................................................................................................................... 959
ImportedSource ..................................................................................................................... 959
ImportedVersion ..................................................................................................................... 960
InternalObject ........................................................................................................................ 960
LastSaved ............................................................................................................................... 960
Model ..................................................................................................................................... 960
Models ***OBSOLETE*** Use 'Model' property instead. ............................................................ 960
PreparedFor ............................................................................................................................ 960
ProductVersion ....................................................................................................................... 961
ProjectDirectory ..................................................................................................................... 961
SaveProjectAfterSolution ........................................................................................................ 961
SaveProjectBeforeSolution ...................................................................................................... 961
Subject ................................................................................................................................... 961
UnitSystem ............................................................................................................................. 961
UserFiles ................................................................................................................................. 962
AddComment() ....................................................................................................................... 962
AddImage(string) ................................................................................................................... 962
Archive(string, bool, ArchiveSettings) ...................................................................................... 962
ClearGeneratedData() ............................................................................................................. 963
CombineTextFiles(string, string) .............................................................................................. 963
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 963
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 964
New() ..................................................................................................................................... 964
Open(string) ........................................................................................................................... 964
Save() ..................................................................................................................................... 965
SaveAs(string, bool) ................................................................................................................ 965
SpecifyMetricTemperatureInCelsius() ...................................................................................... 965
SpecifyMetricTemperatureInKelvin() ........................................................................................ 965
Unarchive(string, string, bool) .................................................................................................. 966
PullOutDirectionManufacturingConstraint .................................................................................... 966
Axis ........................................................................................................................................ 967
CoordinateSystem .................................................................................................................. 967
DataModelObjectCategory ..................................................................................................... 967
Direction ................................................................................................................................ 967
InternalObject ........................................................................................................................ 967
Location ................................................................................................................................. 968
ScopingMethod ...................................................................................................................... 968
Subtype ................................................................................................................................. 968
PythonCode ................................................................................................................................. 968
AllowRecursion ....................................................................................................................... 969
Connected .............................................................................................................................. 969
DataModelObjectCategory ..................................................................................................... 969
InternalObject ........................................................................................................................ 969
PropertyProvider .................................................................................................................... 969
ScriptExecutionScope ............................................................................................................. 970
Text ........................................................................................................................................ 970
Connect() ............................................................................................................................... 970
Delete() .................................................................................................................................. 970
ReloadProperties() .................................................................................................................. 970

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

PythonCodeEventBased ................................................................................................................ 970


DataModelObjectCategory ..................................................................................................... 971
InternalObject ........................................................................................................................ 971
InvalidateSolution ................................................................................................................... 972
SolverTarget ........................................................................................................................... 972
Suppressed ............................................................................................................................ 972
TargetCallback ........................................................................................................................ 972
ReactionForceConstraint ............................................................................................................... 972
AxisSelection .......................................................................................................................... 973
BoundType ............................................................................................................................. 973
DataModelObjectCategory ..................................................................................................... 973
InternalObject ........................................................................................................................ 973
Location ................................................................................................................................. 974
ReactionForceCriteria .............................................................................................................. 974
ScopingMethod ...................................................................................................................... 974
XComponentMax .................................................................................................................... 974
YComponentMax .................................................................................................................... 974
ZComponentMax .................................................................................................................... 974
RectangularCrossSection .............................................................................................................. 975
Area ....................................................................................................................................... 975
DataModelObjectCategory ..................................................................................................... 975
Height .................................................................................................................................... 976
InternalObject ........................................................................................................................ 976
IYY ......................................................................................................................................... 976
IZZ ......................................................................................................................................... 976
Width ..................................................................................................................................... 976
RemotePoint ................................................................................................................................ 976
Behavior ................................................................................................................................. 978
Children ................................................................................................................................. 978
Comments .............................................................................................................................. 978
CoordinateSystem .................................................................................................................. 978
DataModelObjectCategory ..................................................................................................... 978
DOFSelection ......................................................................................................................... 979
Formulation ............................................................................................................................ 979
GloballyAvailable .................................................................................................................... 979
InternalObject ........................................................................................................................ 979
Location ................................................................................................................................. 979
Material .................................................................................................................................. 979
OutlineSelection ..................................................................................................................... 980
PilotNodeAPDLName .............................................................................................................. 980
PilotNodeScopingType ........................................................................................................... 980
PinballRegion ......................................................................................................................... 980
Point ...................................................................................................................................... 980
Radius .................................................................................................................................... 980
RelaxationMethod .................................................................................................................. 981
RotationX ............................................................................................................................... 981
RotationY ............................................................................................................................... 981
RotationZ ............................................................................................................................... 981
ScopingMethod ...................................................................................................................... 981
Suppressed ............................................................................................................................ 981
XComponent .......................................................................................................................... 982

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxxvii
ACT API Reference Guide

XCoordinate ........................................................................................................................... 982


YComponent .......................................................................................................................... 982
YCoordinate ........................................................................................................................... 982
ZComponent .......................................................................................................................... 982
ZCoordinate ........................................................................................................................... 982
AddCommandSnippet() .......................................................................................................... 983
AddComment() ....................................................................................................................... 983
Delete() .................................................................................................................................. 983
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 983
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 983
GetMeshRegion() .................................................................................................................... 984
PromoteToNamedSelection() .................................................................................................. 984
RemotePoints ............................................................................................................................... 984
Children ................................................................................................................................. 985
Comments .............................................................................................................................. 985
DataModelObjectCategory ..................................................................................................... 985
Figures ................................................................................................................................... 985
Images ................................................................................................................................... 986
InternalObject ........................................................................................................................ 986
AddComment() ....................................................................................................................... 986
AddFigure() ............................................................................................................................ 986
AddImage(string) ................................................................................................................... 986
AddRemotePoint() .................................................................................................................. 987
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 987
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 987
ResponseConstraint ...................................................................................................................... 988
Children ................................................................................................................................. 988
DataModelObjectCategory ..................................................................................................... 988
EnvironmentSelection ............................................................................................................ 989
InternalObject ........................................................................................................................ 989
Suppressed ............................................................................................................................ 989
Delete() .................................................................................................................................. 989
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 989
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 990
RenameBasedOnDefinition() ................................................................................................... 990
ResponsePSDTool ......................................................................................................................... 990
Children ................................................................................................................................. 991
ClusteringFrequencyPoints ..................................................................................................... 991
Comments .............................................................................................................................. 992
DataModelObjectCategory ..................................................................................................... 992
Figures ................................................................................................................................... 992
Images ................................................................................................................................... 992
IncludeAllExcitationFrequencies .............................................................................................. 992
IncludeUserDefinedFrequencies .............................................................................................. 992
InternalObject ........................................................................................................................ 993
AddComment() ....................................................................................................................... 993
AddFigure() ............................................................................................................................ 993
AddImage(string) ................................................................................................................... 993
AddResponsePSD() ................................................................................................................. 993
Delete() .................................................................................................................................. 994
EvaluateAllResults() ................................................................................................................. 994

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 994


GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 994
ResultMesh ................................................................................................................................... 995
Children ................................................................................................................................. 996
Comments .............................................................................................................................. 996
ConfigurationId ...................................................................................................................... 996
DataModelObjectCategory ..................................................................................................... 996
Elements ................................................................................................................................ 996
FEBodies ................................................................................................................................ 997
Figures ................................................................................................................................... 997
Images ................................................................................................................................... 997
InternalObject ........................................................................................................................ 997
Nodes ..................................................................................................................................... 997
SourceFile ............................................................................................................................... 997
Suppressed ............................................................................................................................ 998
AddComment() ....................................................................................................................... 998
AddFigure() ............................................................................................................................ 998
AddImage(string) ................................................................................................................... 998
AddNamedSelection() ............................................................................................................. 998
ClearGeneratedData() ............................................................................................................. 999
Generate() .............................................................................................................................. 999
GetChildren<ChildrenType>(bool, IList<ChildrenType>) .......................................................... 999
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ................................. 999
ImportComponentsFromResultFile() ..................................................................................... 1000
RingCrack ................................................................................................................................... 1000
BottomFaceNodes ................................................................................................................ 1001
CircumferentialDivisions ....................................................................................................... 1002
Contact1Nodes ..................................................................................................................... 1002
ContactPairsNodes ................................................................................................................ 1002
CoordinateSystem ................................................................................................................ 1002
CrackFacesNodes .................................................................................................................. 1002
CrackFrontNodes .................................................................................................................. 1002
CrackMeshMethod ................................................................................................................ 1003
CrackShape .......................................................................................................................... 1003
CrackSourceType .................................................................................................................. 1003
DataModelObjectCategory ................................................................................................... 1003
FractureAffectedZone ........................................................................................................... 1003
FractureAffectedZoneHeight ................................................................................................. 1003
GrowthRate .......................................................................................................................... 1004
InnerCrackFrontDivisions ...................................................................................................... 1004
InnerFrontElementSize .......................................................................................................... 1004
InnerMajorRadius ................................................................................................................. 1004
InnerMinorRadius ................................................................................................................. 1004
InternalObject ...................................................................................................................... 1004
LargestContourRadius .......................................................................................................... 1005
Location ............................................................................................................................... 1005
MeshContours ...................................................................................................................... 1005
OuterCrackFrontDivisions ..................................................................................................... 1005
OuterFrontElementSize ......................................................................................................... 1005
OuterMajorRadius ................................................................................................................. 1005
OuterMinorRadius ................................................................................................................ 1006

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxxix
ACT API Reference Guide

SolutionContours .................................................................................................................. 1006


Suppressed ........................................................................................................................... 1006
Target1Nodes ....................................................................................................................... 1006
TopFaceNodes ...................................................................................................................... 1006
XScaleFactor ......................................................................................................................... 1006
YScaleFactor ......................................................................................................................... 1007
ZScaleFactor ......................................................................................................................... 1007
SelectionWorksheet .................................................................................................................... 1007
RowCount ............................................................................................................................ 1009
AddRow() ............................................................................................................................. 1009
DeleteRow(int) ...................................................................................................................... 1009
Generate() ............................................................................................................................ 1009
GetAction(int) ....................................................................................................................... 1010
GetBodyTypeValue(int) ......................................................................................................... 1010
GetCoordinateSystemSelection(int) ....................................................................................... 1010
GetCriterion(int) ................................................................................................................... 1010
GetCriterionActive(int) .......................................................................................................... 1011
GetEdgeTypeValue(int) ......................................................................................................... 1011
GetFaceTypeValue(int) .......................................................................................................... 1011
GetGeometryType(int) .......................................................................................................... 1012
GetLowerBound(int) ............................................................................................................. 1012
GetMeshElementTypeValue(int) ............................................................................................ 1012
GetOperator(int) ................................................................................................................... 1012
GetStringValue(int) ............................................................................................................... 1013
GetTag(uint) ......................................................................................................................... 1013
GetUpperBound(int) ............................................................................................................. 1013
GetValue(int) ........................................................................................................................ 1014
SetAction(int, NamedSelectionWorksheetAction) .................................................................. 1014
SetBodyTypeValue(int, NamedSelectionWorksheetBodyTypeValues) ...................................... 1014
SetCoordinateSystemSelection(int, uint) ................................................................................ 1015
SetCriterion(int, NamedSelectionWorksheetCriterion) ............................................................ 1015
SetCriterionActive(int, bool) .................................................................................................. 1015
SetEdgeTypeValue(int, NamedSelectionWorksheetEdgeTypeValues) ...................................... 1016
SetEntityType(int, NamedSelectionWorksheetEntityType) ...................................................... 1016
SetFaceTypeValue(int, NamedSelectionWorksheetFaceTypeValues) ........................................ 1016
SetLowerBound(int, double) .................................................................................................. 1017
SetMeshElementTypeValue(int, MeshElementShape) ............................................................. 1017
SetOperator(int, NamedSelectionWorksheetOperator) ........................................................... 1017
SetStringValue(int, string) ...................................................................................................... 1018
SetTag(uint, string) ................................................................................................................ 1018
SetUpperBound(int, double) .................................................................................................. 1019
SetValue(int, double) ............................................................................................................. 1019
SemiEllipticalCrack ...................................................................................................................... 1019
AlignWithFaceNormal ........................................................................................................... 1021
BottomFaceNodes ................................................................................................................ 1021
CircumferentialDivisions ....................................................................................................... 1021
Contact1Nodes ..................................................................................................................... 1021
ContactPairsNodes ................................................................................................................ 1021
CoordinateSystem ................................................................................................................ 1021
CrackFacesNodes .................................................................................................................. 1022
CrackFrontDivisions .............................................................................................................. 1022

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxxx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

CrackFrontNodes .................................................................................................................. 1022


CrackMeshMethod ................................................................................................................ 1022
CrackShape .......................................................................................................................... 1022
CrackSourceType .................................................................................................................. 1022
DataModelObjectCategory ................................................................................................... 1023
FractureAffectedZone ........................................................................................................... 1023
FractureAffectedZoneHeight ................................................................................................. 1023
FrontElementSize .................................................................................................................. 1023
GrowthRate .......................................................................................................................... 1023
InternalObject ...................................................................................................................... 1023
LargestContourRadius .......................................................................................................... 1024
Location ............................................................................................................................... 1024
MajorRadius ......................................................................................................................... 1024
MeshContours ...................................................................................................................... 1024
MinorRadius ......................................................................................................................... 1024
ProjectToNearestSurface ....................................................................................................... 1024
SolutionContours .................................................................................................................. 1025
Suppressed ........................................................................................................................... 1025
Target1Nodes ....................................................................................................................... 1025
TopFaceNodes ...................................................................................................................... 1025
XScaleFactor ......................................................................................................................... 1025
YScaleFactor ......................................................................................................................... 1025
ZScaleFactor ......................................................................................................................... 1026
SMARTCrackGrowth .................................................................................................................... 1026
Analysis ................................................................................................................................ 1027
AutomaticTimeStepping ....................................................................................................... 1027
CrackGrowthLaw .................................................................................................................. 1027
CrackGrowthMethodology .................................................................................................... 1028
CrackGrowthOption .............................................................................................................. 1028
CriticalRate ........................................................................................................................... 1028
DataModelObjectCategory ................................................................................................... 1028
FailureCriteriaOption ............................................................................................................ 1028
InitialCrack ............................................................................................................................ 1028
InitialTimeStep ..................................................................................................................... 1029
InternalObject ...................................................................................................................... 1029
Material ................................................................................................................................ 1029
MaximumTimeStep .............................................................................................................. 1029
MaxIncrementOfCrackExtension ........................................................................................... 1029
MaxIncrementValue .............................................................................................................. 1029
MaxIncrementValueTreatment .............................................................................................. 1030
MeshCoarsening ................................................................................................................... 1030
Method ................................................................................................................................ 1030
MinimumTimeStep ............................................................................................................... 1030
MinIncrementControl ........................................................................................................... 1030
MinIncrementOfCrackExtension ............................................................................................ 1030
MinIncrementValue .............................................................................................................. 1031
MinIncrementValueTreatment ............................................................................................... 1031
NumberOfCycles ................................................................................................................... 1031
StopCriterion ........................................................................................................................ 1031
StopValue ............................................................................................................................. 1031
StressRatio ............................................................................................................................ 1031

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxxxi
ACT API Reference Guide

Suppressed ........................................................................................................................... 1032


Solid ........................................................................................................................................... 1032
Children ............................................................................................................................... 1033
Comments ............................................................................................................................ 1033
CoordinateSystem ................................................................................................................ 1033
DataModelObjectCategory ................................................................................................... 1033
InternalObject ...................................................................................................................... 1033
PartName ............................................................................................................................. 1033
X1 ........................................................................................................................................ 1034
X2 ........................................................................................................................................ 1034
Y1 ......................................................................................................................................... 1034
Y2 ......................................................................................................................................... 1034
Z1 ......................................................................................................................................... 1034
Z2 ......................................................................................................................................... 1034
AddComment() ..................................................................................................................... 1035
AddGeometry() ..................................................................................................................... 1035
Delete() ................................................................................................................................ 1035
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1035
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1035
RemoveGeometry() ............................................................................................................... 1036
UpdateGeometry() ................................................................................................................ 1036
Solution ...................................................................................................................................... 1036
AllThreadsCPUTime .............................................................................................................. 1047
CalculateBeamSectionResults ............................................................................................... 1048
CellId .................................................................................................................................... 1048
Children ............................................................................................................................... 1048
Comments ............................................................................................................................ 1048
CyclicSectorDisplayRangeBegin ............................................................................................ 1048
DataModelObjectCategory ................................................................................................... 1048
DateOfRun ............................................................................................................................ 1049
EigenSolverType ................................................................................................................... 1049
ElapsedRunTime ................................................................................................................... 1049
ElapsedTime ......................................................................................................................... 1049
ElementLoadBalRatio ............................................................................................................ 1049
Elements .............................................................................................................................. 1049
ElementSelection .................................................................................................................. 1050
EquationSolverType .............................................................................................................. 1050
ExportTopologyFile ............................................................................................................... 1050
Figures ................................................................................................................................. 1050
GpuAcceleration ................................................................................................................... 1050
GPUType .............................................................................................................................. 1050
Images ................................................................................................................................. 1051
InternalObject ...................................................................................................................... 1051
IOBound ............................................................................................................................... 1051
IORead ................................................................................................................................. 1051
IOWrite ................................................................................................................................. 1051
IsAutoHybridParallel ............................................................................................................. 1051
IsDataExtractionComplete .................................................................................................... 1052
IsDistributedSolution ............................................................................................................ 1052
IsEigenSolver ........................................................................................................................ 1052
IsGPUAccelerationRequested ................................................................................................ 1052

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxxxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

IsHybridParallelSolution ........................................................................................................ 1052


IsUnsymmetricMatrixSolve .................................................................................................... 1052
License ................................................................................................................................. 1053
LicenseCoresAvailable ........................................................................................................... 1053
MainThreadCPUTime ............................................................................................................ 1053
MaximumRefinementLoops .................................................................................................. 1053
MemoryAvailable .................................................................................................................. 1053
MemoryUsed ........................................................................................................................ 1053
MeshSource .......................................................................................................................... 1054
MPIType ............................................................................................................................... 1054
MSUPHarmonicAnalysis ........................................................................................................ 1054
Nodes ................................................................................................................................... 1054
NumberOfDOF ..................................................................................................................... 1054
NumberOfProcessesRequested ............................................................................................. 1054
NumberofSectors .................................................................................................................. 1055
NumCoresAvailable ............................................................................................................... 1055
NumGPURequested .............................................................................................................. 1055
NumMachinesRequested ...................................................................................................... 1055
NumProcRequested .............................................................................................................. 1055
NumVirtualCoresAvailable .................................................................................................... 1055
OperatingSystem .................................................................................................................. 1056
ProcessorModel .................................................................................................................... 1056
RefinementDepth ................................................................................................................. 1056
ResultFileDirectory ................................................................................................................ 1056
ResultFileName ..................................................................................................................... 1056
ResultFilePath ....................................................................................................................... 1056
ResultFileSize ........................................................................................................................ 1057
ResultFileTimestamp ............................................................................................................. 1057
ResultFileUnitSystem ............................................................................................................ 1057
ResultTrackingVectorLength ................................................................................................. 1057
SkipSolveCommand .............................................................................................................. 1057
SolutionInformation ............................................................................................................. 1057
SolutionTrackingVectorLength .............................................................................................. 1058
SolutionUnitSystem .............................................................................................................. 1058
SolverData ............................................................................................................................ 1058
SolverType ............................................................................................................................ 1058
SparseMode ......................................................................................................................... 1058
Status ................................................................................................................................... 1058
ThreadsPerProcessRequested ................................................................................................ 1059
TimeOfRun ........................................................................................................................... 1059
TimeToCombineDistributedFiles ........................................................................................... 1059
TopologyResult ..................................................................................................................... 1059
TotalMemoryUsed ................................................................................................................ 1059
WorkingDir ........................................................................................................................... 1059
AddAccelerationFrequencyResponse() .................................................................................. 1060
AddAccelerationPhaseResponse() ......................................................................................... 1060
AddAccelerationProbe() ........................................................................................................ 1060
AddAccelerationWaterfallDiagram() ...................................................................................... 1060
AddAccumulatedEquivalentPlasticStrain() ............................................................................. 1060
AddAcousticAbsorptionCoefficient() ..................................................................................... 1060
AddAcousticAWeightedSoundPressureLevel() ....................................................................... 1061

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxxxiii
ACT API Reference Guide

AddAcousticAWeightedSPLFrequencyResponse() .................................................................. 1061


AddAcousticDiffuseSoundTransmissionLoss() ........................................................................ 1061
AddAcousticDirectionalVelocityResult() ................................................................................. 1061
AddAcousticFarFieldAWeightedSPL() ..................................................................................... 1061
AddAcousticFarFieldAWeightedSPLMic() ............................................................................... 1061
AddAcousticFarFieldDirectivity() ........................................................................................... 1062
AddAcousticFarFieldMaximumPressure() ............................................................................... 1062
AddAcousticFarFieldMaximumPressureMic() ......................................................................... 1062
AddAcousticFarFieldMaximumScatteredPressure() ................................................................ 1062
AddAcousticFarFieldPhase() .................................................................................................. 1062
AddAcousticFarFieldPhaseMic() ............................................................................................. 1062
AddAcousticFarFieldSoundPowerLevel() ................................................................................ 1063
AddAcousticFarFieldSoundPowerLevelWaterfallDiagram() ..................................................... 1063
AddAcousticFarFieldSPL() ...................................................................................................... 1063
AddAcousticFarFieldSPLMic() ................................................................................................ 1063
AddAcousticFarFieldSPLMicWaterfallDiagram() ..................................................................... 1063
AddAcousticFarFieldTargetStrength() .................................................................................... 1063
AddAcousticFrequencyBandAWeightedSPL() ......................................................................... 1064
AddAcousticFrequencyBandSPL() .......................................................................................... 1064
AddAcousticKineticEnergy() .................................................................................................. 1064
AddAcousticKineticEnergyFrequencyResponse() ................................................................... 1064
AddAcousticPotentialEnergy() ............................................................................................... 1064
AddAcousticPotentialEnergyFrequencyResponse() ................................................................ 1064
AddAcousticPressureFrequencyResponse() ........................................................................... 1065
AddAcousticPressureResult() ................................................................................................. 1065
AddAcousticReturnLoss() ...................................................................................................... 1065
AddAcousticSoundPressureLevel() ........................................................................................ 1065
AddAcousticSPLFrequencyResponse() ................................................................................... 1065
AddAcousticTotalVelocityResult() .......................................................................................... 1065
AddAcousticTransmissionLoss() ............................................................................................. 1066
AddAcousticVelocityFrequencyResponse() ............................................................................ 1066
AddAngularAccelerationProbe() ............................................................................................ 1066
AddAngularVelocityProbe() ................................................................................................... 1066
AddBeamProbe() .................................................................................................................. 1066
AddBeamTool() ..................................................................................................................... 1066
AddBearingProbe() ............................................................................................................... 1067
AddBendingStressEquivalent() .............................................................................................. 1067
AddBendingStressIntensity() ................................................................................................. 1067
AddBoltPretensionProbe() ..................................................................................................... 1067
AddBoltTool() ....................................................................................................................... 1067
AddCampbellDiagram() ........................................................................................................ 1067
AddChargeReactionFrequencyResponse() ............................................................................. 1068
AddChargeReactionProbe() ................................................................................................... 1068
AddCommandSnippet() ........................................................................................................ 1068
AddComment() ..................................................................................................................... 1068
AddCompositeCriterion() ...................................................................................................... 1068
AddCompositeFailureTool() ................................................................................................... 1068
AddCompositeSamplingPointTool() ...................................................................................... 1069
AddContactDistanceProbe() .................................................................................................. 1069
AddContactTool() .................................................................................................................. 1069
AddCurrentDensity() ............................................................................................................. 1069

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxxxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddCurrentDensityProbe() .................................................................................................... 1069


AddDamageStatus() .............................................................................................................. 1069
AddDeformationFrequencyResponse() .................................................................................. 1070
AddDeformationPhaseResponse() ......................................................................................... 1070
AddDeformationProbe() ........................................................................................................ 1070
AddDirectionalAcceleration() ................................................................................................ 1070
AddDirectionalAccelerationPSD() .......................................................................................... 1070
AddDirectionalAccelerationRS() ............................................................................................ 1070
AddDirectionalAxialForce() .................................................................................................... 1071
AddDirectionalBendingMoment() ......................................................................................... 1071
AddDirectionalCurrentDensity() ............................................................................................ 1071
AddDirectionalDeformation() ................................................................................................ 1071
AddDirectionalElectricFieldIntensity() .................................................................................... 1071
AddDirectionalElectricFluxDensity() ...................................................................................... 1071
AddDirectionalElectrostaticForce() ........................................................................................ 1072
AddDirectionalHeatFlux() ...................................................................................................... 1072
AddDirectionalMagneticFieldIntensity() ................................................................................ 1072
AddDirectionalMagneticFluxDensity() ................................................................................... 1072
AddDirectionalShearForce() .................................................................................................. 1072
AddDirectionalTorsionalMoment() ........................................................................................ 1072
AddDirectionalVelocity() ....................................................................................................... 1073
AddDirectionalVelocityPSD() ................................................................................................. 1073
AddDirectionalVelocityRS() ................................................................................................... 1073
AddElasticStrainFrequencyResponse() ................................................................................... 1073
AddElasticStrainIntensity() .................................................................................................... 1073
AddElasticStrainPhaseResponse() .......................................................................................... 1073
AddElectricFieldProbe() ......................................................................................................... 1074
AddElectricPotential() ........................................................................................................... 1074
AddElectricVoltage() ............................................................................................................. 1074
AddElectromechanicalCouplingCoefficient() ......................................................................... 1074
AddElementalEulerXYAngle() ................................................................................................ 1074
AddElementalEulerXZAngle() ................................................................................................ 1074
AddElementalEulerYZAngle() ................................................................................................ 1075
AddElementalStrainEnergy() ................................................................................................. 1075
AddElementalTriads() ............................................................................................................ 1075
AddEmagReactionProbe() ..................................................................................................... 1075
AddEnergyDissipatedPerUnitVolume() .................................................................................. 1075
AddEnergyProbe() ................................................................................................................ 1075
AddEquivalentCreepStrain() .................................................................................................. 1076
AddEquivalentCreepStrainRST() ............................................................................................ 1076
AddEquivalentElasticStrain() ................................................................................................. 1076
AddEquivalentElasticStrainRST() ............................................................................................ 1076
AddEquivalentPlasticStrain() ................................................................................................. 1076
AddEquivalentPlasticStrainRST() ............................................................................................ 1076
AddEquivalentRadiatedPower() ............................................................................................. 1077
AddEquivalentRadiatedPowerLevel() ..................................................................................... 1077
AddEquivalentRadiatedPowerLevelWaterfallDiagram() .......................................................... 1077
AddEquivalentRadiatedPowerWaterfallDiagram() .................................................................. 1077
AddEquivalentStress() ........................................................................................................... 1077
AddEquivalentStressPSD() ..................................................................................................... 1077
AddEquivalentStressRS() ....................................................................................................... 1078

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxxxv
ACT API Reference Guide

AddEquivalentTotalStrain() .................................................................................................... 1078


AddExpansionSettings() ........................................................................................................ 1078
AddFatigueTool() .................................................................................................................. 1078
AddFiberCompressiveDamageVariable() ................................................................................ 1078
AddFiberCompressiveFailureCriterion() ................................................................................. 1078
AddFiberTensileDamageVariable() ......................................................................................... 1079
AddFiberTensileFailureCriterion() .......................................................................................... 1079
AddFieldIntensityProbe() ...................................................................................................... 1079
AddFigure() .......................................................................................................................... 1079
AddFlexibleRotationProbe() .................................................................................................. 1079
AddFluidFlowRate() .............................................................................................................. 1079
AddFluidHeatConductionRate() ............................................................................................ 1080
AddFluidHeatTransportRate() ................................................................................................ 1080
AddFluxDensityProbe() ......................................................................................................... 1080
AddFluxLinkage() .................................................................................................................. 1080
AddForceReaction() .............................................................................................................. 1080
AddForceReactionFrequencyResponse() ............................................................................... 1080
AddForceReactionsForContactRegions(IEnumerable<int>) .................................................... 1081
AddForceSummationProbe() ................................................................................................. 1081
AddFractureTool() ................................................................................................................. 1081
AddGeneralizedPlaneStrainProbe() ........................................................................................ 1081
AddGroupedScopedACPResults(ResultType, IEnumerable<IDataModelObject>) .................... 1081
AddGroupedScopedCustomResult(IEnumerable<IDataModelObject>) .................................. 1082
AddHeatFluxProbe() .............................................................................................................. 1082
AddImage(string) .................................................................................................................. 1082
AddImpedanceFrequencyResponse() .................................................................................... 1083
AddImpedanceProbe() .......................................................................................................... 1083
AddInductance() ................................................................................................................... 1083
AddJointProbe() .................................................................................................................... 1083
AddJouleHeat() ..................................................................................................................... 1083
AddJouleHeatProbe() ............................................................................................................ 1084
AddLatticeDensity() .............................................................................................................. 1084
AddLatticeElementalDensity() ............................................................................................... 1084
AddLinearizedEquivalentStress() ........................................................................................... 1084
AddLinearizedMaximumPrincipalStress() ............................................................................... 1084
AddLinearizedMaximumShearStress() ................................................................................... 1084
AddLinearizedMiddlePrincipalStress() ................................................................................... 1085
AddLinearizedMinimumPrincipalStress() ............................................................................... 1085
AddLinearizedNormalStress() ................................................................................................ 1085
AddLinearizedShearStress() ................................................................................................... 1085
AddLinearizedStressIntensity() .............................................................................................. 1085
AddLineChart2D() ................................................................................................................. 1085
AddLinePressureResult() ....................................................................................................... 1086
AddMagneticCoenergy() ....................................................................................................... 1086
AddMagneticDirectionalForces() ........................................................................................... 1086
AddMagneticError() .............................................................................................................. 1086
AddMagneticFluxProbe() ...................................................................................................... 1086
AddMagneticPotential() ........................................................................................................ 1086
AddMagneticTotalForces() .................................................................................................... 1087
AddMatrixCompressiveDamageVariable() .............................................................................. 1087
AddMatrixCompressiveFailureCriterion() ............................................................................... 1087

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxxxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddMatrixTensileDamageVariable() ....................................................................................... 1087


AddMatrixTensileFailureCriterion() ........................................................................................ 1087
AddMaximumFailureCriteria() ............................................................................................... 1087
AddMaximumPrincipalElasticStrain() ..................................................................................... 1088
AddMaximumPrincipalStress() .............................................................................................. 1088
AddMaximumPrincipalThermalStrain() .................................................................................. 1088
AddMaximumShearElasticStrain() ......................................................................................... 1088
AddMaximumShearStress() ................................................................................................... 1088
AddMCFWaterfallDiagram() .................................................................................................. 1088
AddMembraneStressEquivalent() .......................................................................................... 1089
AddMembraneStressIntensity() ............................................................................................. 1089
AddMiddlePrincipalElasticStrain() .......................................................................................... 1089
AddMiddlePrincipalStress() ................................................................................................... 1089
AddMiddlePrincipalThermalStrain() ....................................................................................... 1089
AddMinimumPrincipalElasticStrain() ..................................................................................... 1089
AddMinimumPrincipalStress() ............................................................................................... 1090
AddMomentReaction() ......................................................................................................... 1090
AddMomentReactionsForContactRegions(IEnumerable<int>) ............................................... 1090
AddMullinsDamageVariable() ................................................................................................ 1090
AddMullinsMaximumPreviousStrainEnergy() ......................................................................... 1090
AddNewtonRaphsonResidualCharge() ................................................................................... 1091
AddNewtonRaphsonResidualForce() ..................................................................................... 1091
AddNewtonRaphsonResidualHeat() ...................................................................................... 1091
AddNewtonRaphsonResidualMoment() ................................................................................ 1091
AddNodalEulerXYAngle() ...................................................................................................... 1091
AddNodalEulerXZAngle() ...................................................................................................... 1091
AddNodalEulerYZAngle() ...................................................................................................... 1092
AddNodalTriads() .................................................................................................................. 1092
AddNormalElasticStrain() ...................................................................................................... 1092
AddNormalGasketPressure() ................................................................................................. 1092
AddNormalGasketTotalClosure() ........................................................................................... 1092
AddNormalStress() ................................................................................................................ 1092
AddPosition() ........................................................................................................................ 1093
AddPrimaryCriterion() ........................................................................................................... 1093
AddPythonCodeEventBased() ............................................................................................... 1093
AddPythonResult() ................................................................................................................ 1093
AddQualityFactor() ................................................................................................................ 1093
AddRadiationProbe() ............................................................................................................ 1093
AddReactionProbe() .............................................................................................................. 1094
AddReactionsForContactRegions(IEnumerable<int>) ............................................................ 1094
AddResponsePSD() ............................................................................................................... 1094
AddResponsePSDTool() ......................................................................................................... 1094
AddResultMesh() .................................................................................................................. 1094
AddRotationProbe() .............................................................................................................. 1095
AddShapeFinder() ................................................................................................................. 1095
AddShapeFinderElemental() .................................................................................................. 1095
AddShearDamageVariable() .................................................................................................. 1095
AddShearElasticStrain() ......................................................................................................... 1095
AddShearGasketPressure() .................................................................................................... 1095
AddShearGasketTotalClosure() .............................................................................................. 1096
AddShearMomentDiagramMSUM() ....................................................................................... 1096

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxxxvii
ACT API Reference Guide

AddShearMomentDiagramMY() ............................................................................................ 1096


AddShearMomentDiagramMZ() ............................................................................................ 1096
AddShearMomentDiagramUSUM() ........................................................................................ 1096
AddShearMomentDiagramUY() ............................................................................................. 1096
AddShearMomentDiagramUZ() ............................................................................................. 1097
AddShearMomentDiagramVSUM() ........................................................................................ 1097
AddShearMomentDiagramVY() ............................................................................................. 1097
AddShearMomentDiagramVZ() ............................................................................................. 1097
AddShearStress() .................................................................................................................. 1097
AddShellBendingStress() ....................................................................................................... 1097
AddShellBottomPeakStress() ................................................................................................. 1098
AddShellMembraneStress() ................................................................................................... 1098
AddShellTopPeakStress() ....................................................................................................... 1098
AddSpringProbe() ................................................................................................................. 1098
AddStabilizationEnergy() ....................................................................................................... 1098
AddStrainProbe() .................................................................................................................. 1098
AddStressFrequencyResponse() ............................................................................................ 1099
AddStressIntensity() .............................................................................................................. 1099
AddStressPhaseResponse() ................................................................................................... 1099
AddStressProbe() .................................................................................................................. 1099
AddStressTool() ..................................................................................................................... 1099
AddStructuralError() .............................................................................................................. 1099
AddStructuralStrainEnergy() .................................................................................................. 1100
AddTemperature() ................................................................................................................ 1100
AddTemperatureProbe() ....................................................................................................... 1100
AddThermalError() ................................................................................................................ 1100
AddThermalStrain() ............................................................................................................... 1100
AddThermalStrainEnergy() .................................................................................................... 1100
AddTopologyDensity() .......................................................................................................... 1101
AddTopologyElementalDensity() ........................................................................................... 1101
AddTorqueProbe() ................................................................................................................ 1101
AddTotalAcceleration() .......................................................................................................... 1101
AddTotalAxialForce() ............................................................................................................. 1101
AddTotalBendingMoment() ................................................................................................... 1101
AddTotalCurrentDensity() ..................................................................................................... 1102
AddTotalDeformation() ......................................................................................................... 1102
AddTotalElectricFieldIntensity() ............................................................................................. 1102
AddTotalElectricFluxDensity() ................................................................................................ 1102
AddTotalElectrostaticForce() .................................................................................................. 1102
AddTotalHeatFlux() ............................................................................................................... 1102
AddTotalMagneticFieldIntensity() .......................................................................................... 1103
AddTotalMagneticFluxDensity() ............................................................................................ 1103
AddTotalShearForce() ............................................................................................................ 1103
AddTotalTorsionalMoment() .................................................................................................. 1103
AddTotalVelocity() ................................................................................................................ 1103
AddUserDefinedResult() ........................................................................................................ 1103
AddVariableGraph() .............................................................................................................. 1104
AddVectorAxialForce() .......................................................................................................... 1104
AddVectorBendingMoment() ................................................................................................ 1104
AddVectorDeformation() ....................................................................................................... 1104
AddVectorHeatFlux() ............................................................................................................. 1104

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
lxxxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddVectorPrincipalElasticStrain() ........................................................................................... 1104


AddVectorPrincipalStress() .................................................................................................... 1105
AddVectorShearForce() ......................................................................................................... 1105
AddVectorTorsionalMoment() ............................................................................................... 1105
AddVelocityFrequencyResponse() ......................................................................................... 1105
AddVelocityPhaseResponse() ................................................................................................ 1105
AddVelocityProbe() ............................................................................................................... 1105
AddVelocityWaterfallDiagram() ............................................................................................. 1106
AddVoltageFrequencyResponse() .......................................................................................... 1106
AddVoltageProbe() ............................................................................................................... 1106
AddVolume() ........................................................................................................................ 1106
AddVolumeProbe() ............................................................................................................... 1106
ClearGeneratedData() ........................................................................................................... 1106
ClearRemoteStorageData() .................................................................................................... 1107
CreateResultsAtAllSets(uint) .................................................................................................. 1107
DeleteRow(uint) .................................................................................................................... 1107
DisconnectRemoteJob() ........................................................................................................ 1107
EvaluateAllContactTrackers() ................................................................................................. 1107
EvaluateAllResults() ............................................................................................................... 1108
EvaluateContactTracker() ...................................................................................................... 1108
ExecutePostCommands() ...................................................................................................... 1108
ExecutePostCommands(IEnumerable<IDataModelObject>) ................................................... 1108
ExportSubstructure(string, ExportFormat, ExportSettings) ...................................................... 1108
ExtractSolutionStatistics() ..................................................................................................... 1109
FetchRemoteResults() ........................................................................................................... 1109
FormatValue(double, int) ....................................................................................................... 1109
GenerateAdaptedMesh() ....................................................................................................... 1110
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1110
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1110
GetResults() .......................................................................................................................... 1111
IsResultFileChanged() ............................................................................................................ 1111
IsResultFileSameAsLoaded(string) ......................................................................................... 1111
OpenSolverFilesDirectory() ................................................................................................... 1111
ReadAnsysResultFile() ........................................................................................................... 1111
ReadGivenAnsysResultFile(string, UnitSystemIDType) ............................................................ 1112
ReadGivenAnsysResultFileByReference(string, UnitSystemIDType) ......................................... 1112
ReconnectRemoteJob() ......................................................................................................... 1112
RelinkResultFile(string) .......................................................................................................... 1113
ReloadResultFile() ................................................................................................................. 1113
Solve(bool, SolveConfiguration) ............................................................................................ 1113
Solve(bool, string) ................................................................................................................. 1113
ValueForResultTracking(uint, string) ....................................................................................... 1114
ValueForSolutionTracking(uint, string) ................................................................................... 1114
SolutionCombination .................................................................................................................. 1114
Children ............................................................................................................................... 1117
Comments ............................................................................................................................ 1117
DataModelObjectCategory ................................................................................................... 1117
Definition ............................................................................................................................. 1117
EnvelopeType ....................................................................................................................... 1117
Images ................................................................................................................................. 1118
InternalObject ...................................................................................................................... 1118

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. lxxxix
ACT API Reference Guide

Type ..................................................................................................................................... 1118


AddBeamTool() ..................................................................................................................... 1118
AddComment() ..................................................................................................................... 1118
AddCompositeFailureTool() ................................................................................................... 1118
AddContactTool() .................................................................................................................. 1119
AddDirectionalAcceleration() ................................................................................................ 1119
AddDirectionalAxialForce() .................................................................................................... 1119
AddDirectionalBendingMoment() ......................................................................................... 1119
AddDirectionalDeformation() ................................................................................................ 1119
AddDirectionalShearForce() .................................................................................................. 1119
AddDirectionalTorsionalMoment() ........................................................................................ 1120
AddDirectionalVelocity() ....................................................................................................... 1120
AddElasticStrainIntensity() .................................................................................................... 1120
AddEquivalentElasticStrain() ................................................................................................. 1120
AddEquivalentElasticStrainRST() ............................................................................................ 1120
AddEquivalentStress() ........................................................................................................... 1120
AddEquivalentTotalStrain() .................................................................................................... 1121
AddFatigueTool() .................................................................................................................. 1121
AddImage(string) .................................................................................................................. 1121
AddLinearizedEquivalentStress() ........................................................................................... 1121
AddLinearizedMaximumPrincipalStress() ............................................................................... 1121
AddLinearizedMaximumShearStress() ................................................................................... 1122
AddLinearizedMiddlePrincipalStress() ................................................................................... 1122
AddLinearizedMinimumPrincipalStress() ............................................................................... 1122
AddLinearizedNormalStress() ................................................................................................ 1122
AddLinearizedShearStress() ................................................................................................... 1122
AddLinearizedStressIntensity() .............................................................................................. 1122
AddMaximumPrincipalElasticStrain() ..................................................................................... 1123
AddMaximumPrincipalStress() .............................................................................................. 1123
AddMaximumShearElasticStrain() ......................................................................................... 1123
AddMaximumShearStress() ................................................................................................... 1123
AddMiddlePrincipalElasticStrain() .......................................................................................... 1123
AddMiddlePrincipalStress() ................................................................................................... 1123
AddMinimumPrincipalElasticStrain() ..................................................................................... 1124
AddMinimumPrincipalStress() ............................................................................................... 1124
AddNormalElasticStrain() ...................................................................................................... 1124
AddNormalStress() ................................................................................................................ 1124
AddShearElasticStrain() ......................................................................................................... 1124
AddShearMomentDiagramMSUM() ....................................................................................... 1124
AddShearMomentDiagramMY() ............................................................................................ 1125
AddShearMomentDiagramMZ() ............................................................................................ 1125
AddShearMomentDiagramUSUM() ........................................................................................ 1125
AddShearMomentDiagramUY() ............................................................................................. 1125
AddShearMomentDiagramUZ() ............................................................................................. 1125
AddShearMomentDiagramVSUM() ........................................................................................ 1125
AddShearMomentDiagramVY() ............................................................................................. 1126
AddShearMomentDiagramVZ() ............................................................................................. 1126
AddShearStress() .................................................................................................................. 1126
AddStressIntensity() .............................................................................................................. 1126
AddStressTool() ..................................................................................................................... 1126
AddTotalAcceleration() .......................................................................................................... 1126

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xc of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddTotalAxialForce() ............................................................................................................. 1127


AddTotalBendingMoment() ................................................................................................... 1127
AddTotalDeformation() ......................................................................................................... 1127
AddTotalShearForce() ............................................................................................................ 1127
AddTotalTorsionalMoment() .................................................................................................. 1127
AddTotalVelocity() ................................................................................................................ 1127
AddUserDefinedResult() ........................................................................................................ 1128
AddVectorAxialForce() .......................................................................................................... 1128
AddVectorBendingMoment() ................................................................................................ 1128
AddVectorPrincipalElasticStrain() ........................................................................................... 1128
AddVectorPrincipalStress() .................................................................................................... 1128
AddVectorShearForce() ......................................................................................................... 1128
AddVectorTorsionalMoment() ............................................................................................... 1129
ClearGeneratedData() ........................................................................................................... 1129
Delete() ................................................................................................................................ 1129
EvaluateAllResults() ............................................................................................................... 1129
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1129
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1130
SolutionCombinationDefinition .................................................................................................. 1130
BaseCaseCount ..................................................................................................................... 1131
LoadCombinationCount ........................................................................................................ 1132
AddBaseCase(string, Analysis, double) ................................................................................... 1132
AddLoadCombination(string, int) .......................................................................................... 1132
DeleteBaseCase(int) .............................................................................................................. 1133
DeleteLoadCombination(int) ................................................................................................. 1133
Export(string) ....................................................................................................................... 1133
GetBaseCaseAnalysis(int) ...................................................................................................... 1133
GetBaseCaseFrequency(int) .................................................................................................. 1134
GetBaseCaseName(int) .......................................................................................................... 1134
GetBaseCasePhaseAngle(int) ................................................................................................. 1134
GetBaseCaseTime(int) ........................................................................................................... 1135
GetCoefficient(int, int) ........................................................................................................... 1135
GetLoadCombinationName(int) ............................................................................................ 1135
GetLoadCombinationType(int) .............................................................................................. 1136
Import(string) ....................................................................................................................... 1136
SetBaseCaseAnalysis(int, Analysis) ......................................................................................... 1136
SetBaseCaseFrequency(int, double) ....................................................................................... 1137
SetBaseCaseName(int, string) ................................................................................................ 1137
SetBaseCasePhaseAngle(int, double) ..................................................................................... 1137
SetBaseCaseTime(int, double) ............................................................................................... 1138
SetCoefficient(int, int, double) ............................................................................................... 1138
SetLoadCombinationName(int, string) ................................................................................... 1139
SetLoadCombinationType(int, LoadCombinationType) .......................................................... 1139
SolutionInformation ................................................................................................................... 1139
ActivateVisibility ................................................................................................................... 1143
Children ............................................................................................................................... 1143
Comments ............................................................................................................................ 1144
Component .......................................................................................................................... 1144
DataModelObjectCategory ................................................................................................... 1144
Display ................................................................................................................................. 1144
DisplayFilterDuringSolve ....................................................................................................... 1144

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xci
ACT API Reference Guide

DisplayPoints ........................................................................................................................ 1144


DisplayType .......................................................................................................................... 1145
DrawConnectionsAttachedTo ................................................................................................ 1145
EnvironmentSelection ........................................................................................................... 1145
Figures ................................................................................................................................. 1145
IdentifyElementViolations ..................................................................................................... 1145
Images ................................................................................................................................. 1145
InternalObject ...................................................................................................................... 1146
LineColor .............................................................................................................................. 1146
LineThickness ....................................................................................................................... 1146
ModeNumber ....................................................................................................................... 1146
NewtonRaphsonResiduals ..................................................................................................... 1146
ResponseConstraint .............................................................................................................. 1146
ShowChargeResiduals ........................................................................................................... 1147
ShowHeatResiduals .............................................................................................................. 1147
ShowMomentResiduals ........................................................................................................ 1147
SolutionOutput ..................................................................................................................... 1147
StepNumber ......................................................................................................................... 1147
StepSelectionMode .............................................................................................................. 1147
SummaryType ...................................................................................................................... 1148
UpdateInterval ...................................................................................................................... 1148
VisibleOnResults ................................................................................................................... 1148
AddAddedMass() .................................................................................................................. 1148
AddArtificialEnergy() ............................................................................................................. 1148
AddChattering() .................................................................................................................... 1148
AddClosedPenetration() ........................................................................................................ 1149
AddComment() ..................................................................................................................... 1149
AddContactDepth() .............................................................................................................. 1149
AddContactEnergy() ............................................................................................................. 1149
AddContactForce() ................................................................................................................ 1149
AddContactHeatFlux() ........................................................................................................... 1149
AddContactingArea() ............................................................................................................ 1150
AddContactMaximumNormalStiffness() ................................................................................ 1150
AddContactMaxTangentialFluidPressure() ............................................................................. 1150
AddContactMinimumNormalStiffness() ................................................................................. 1150
AddContactPairForceConvergenceNorm() ............................................................................. 1150
AddContactPressure() ........................................................................................................... 1150
AddDampingEnergy() ........................................................................................................... 1151
AddDeformationPlotTracker() ............................................................................................... 1151
AddDensity() ........................................................................................................................ 1151
AddDirectionalAcceleration() ................................................................................................ 1151
AddDirectionalDeformation() ................................................................................................ 1151
AddDirectionalVelocity() ....................................................................................................... 1151
AddEffectiveStrain() .............................................................................................................. 1152
AddEffectiveStress() .............................................................................................................. 1152
AddElasticSlip() ..................................................................................................................... 1152
AddErodedInternalEnergy() ................................................................................................... 1152
AddErodedKineticEnergy() .................................................................................................... 1152
AddExternalForce() ............................................................................................................... 1152
AddFigure() .......................................................................................................................... 1153
AddFluidPressure() ................................................................................................................ 1153

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xcii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddForceReaction() .............................................................................................................. 1153


AddFrictionalDissipationEnergy() .......................................................................................... 1153
AddFrictionalStress() ............................................................................................................. 1153
AddGap() .............................................................................................................................. 1153
AddHourglassEnergy() .......................................................................................................... 1154
AddImage(string) .................................................................................................................. 1154
AddInternalEnergy() .............................................................................................................. 1154
AddKineticEnergy() ............................................................................................................... 1154
AddLatticeDensity() .............................................................................................................. 1154
AddLatticeElementalDensity() ............................................................................................... 1155
AddLSDYNAGeneralTracker() ................................................................................................. 1155
AddMaximumDampingPressure() ......................................................................................... 1155
AddMaximumGeometricSlidingDistance() ............................................................................. 1155
AddMaximumTangentialStiffness() ........................................................................................ 1155
AddMinimumGeometricSlidingDistance() ............................................................................. 1155
AddMinimumTangentialStiffness() ........................................................................................ 1156
AddMomentReaction() ......................................................................................................... 1156
AddMomentum() .................................................................................................................. 1156
AddNonLinearStabilizationEnergy() ....................................................................................... 1156
AddNumberContacting() ...................................................................................................... 1156
AddNumberSticking() ........................................................................................................... 1156
AddNumberWithLargePenetration() ...................................................................................... 1157
AddNumberWithTooMuchSliding() ....................................................................................... 1157
AddPenetration() .................................................................................................................. 1157
AddPlasticWork() .................................................................................................................. 1157
AddPosition() ........................................................................................................................ 1157
AddPossibleOverconstraint() ................................................................................................. 1157
AddPressure() ....................................................................................................................... 1158
AddResultingPinball() ........................................................................................................... 1158
AddRigidBodyVelocity() ........................................................................................................ 1158
AddSlidingDistance() ............................................................................................................ 1158
AddSlidingIndication() .......................................................................................................... 1158
AddSpringTrackerDampingForce() ........................................................................................ 1158
AddSpringTrackerElasticForce() ............................................................................................. 1159
AddSpringTrackerElongation() .............................................................................................. 1159
AddSpringTrackerVelocity() ................................................................................................... 1159
AddStabilizationEnergy() ....................................................................................................... 1159
AddStiffnessEnergy() ............................................................................................................. 1159
AddStrainEnergy() ................................................................................................................. 1159
AddStrainPlotTracker() .......................................................................................................... 1160
AddStressPlotTracker() .......................................................................................................... 1160
AddTangentialDampingStress() ............................................................................................. 1160
AddTemperature() ................................................................................................................ 1160
AddTemperaturePlotTracker() ............................................................................................... 1160
AddTopologyDensity() .......................................................................................................... 1160
AddTopologyElementalDensity() ........................................................................................... 1161
AddTotalEnergy() .................................................................................................................. 1161
AddTotalForceFromContactPressureX() ................................................................................. 1161
AddTotalForceFromContactPressureY() ................................................................................. 1161
AddTotalForceFromContactPressureZ() ................................................................................. 1161
AddTotalForceFromTangentialStressX() ................................................................................. 1161

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xciii
ACT API Reference Guide

AddTotalForceFromTangentialStressY() ................................................................................. 1162


AddTotalForceFromTangentialStressZ() ................................................................................. 1162
AddTotalMassAverageVelocity() ............................................................................................ 1162
AddVolumeLossDueToWear() ................................................................................................ 1162
EvaluateAllContactTrackers() ................................................................................................. 1162
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1162
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1163
ImportResultTrackersFromFile(string) .................................................................................... 1163
RenameBasedOnDefinition() ................................................................................................. 1164
Stage .......................................................................................................................................... 1164
Behavior ............................................................................................................................... 1165
Children ............................................................................................................................... 1165
Comments ............................................................................................................................ 1165
CyclicRegion ......................................................................................................................... 1165
DataModelObjectCategory ................................................................................................... 1166
Figures ................................................................................................................................. 1166
Images ................................................................................................................................. 1166
InternalObject ...................................................................................................................... 1166
Location ............................................................................................................................... 1166
StageName ........................................................................................................................... 1166
Suppressed ........................................................................................................................... 1167
AddComment() ..................................................................................................................... 1167
AddFigure() .......................................................................................................................... 1167
AddImage(string) .................................................................................................................. 1167
Delete() ................................................................................................................................ 1167
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1168
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1168
GetHarmonicIndexForEnvironmentByIndex(uint, int) ............................................................. 1168
GetHarmonicIndexNumberForEnvironment(uint) .................................................................. 1169
SetHarmonicIndexForEnvironmentByIndex(uint, int, uint) ...................................................... 1169
SetHarmonicIndexNumberForEnvironment(uint, uint) ........................................................... 1169
STL ............................................................................................................................................. 1170
Color .................................................................................................................................... 1171
DataModelObjectCategory ................................................................................................... 1171
FileName .............................................................................................................................. 1171
InternalObject ...................................................................................................................... 1171
TranslateX ............................................................................................................................. 1172
TranslateY ............................................................................................................................. 1172
TranslateZ ............................................................................................................................. 1172
ExportStl(string, Progress) ..................................................................................................... 1172
SubstructureGenerationCondensedPart ...................................................................................... 1173
AttachmentMethod .............................................................................................................. 1174
DataModelObjectCategory ................................................................................................... 1174
GenerateDampingMatrix ...................................................................................................... 1174
InterfaceMethod ................................................................................................................... 1175
Interfaces ............................................................................................................................. 1175
InternalObject ...................................................................................................................... 1175
LumpedMassFormulation ..................................................................................................... 1175
PointMassTreatment ............................................................................................................. 1175
ReductionMethod ................................................................................................................. 1175
Surface ....................................................................................................................................... 1176

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xciv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Children ............................................................................................................................... 1176


Comments ............................................................................................................................ 1176
CoordinateSystem ................................................................................................................ 1177
DataModelObjectCategory ................................................................................................... 1177
Figures ................................................................................................................................. 1177
Images ................................................................................................................................. 1177
InternalObject ...................................................................................................................... 1177
Suppressed ........................................................................................................................... 1177
AddComment() ..................................................................................................................... 1178
AddFigure() .......................................................................................................................... 1178
AddImage(string) .................................................................................................................. 1178
Delete() ................................................................................................................................ 1178
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1178
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1179
SurfaceCoating ........................................................................................................................... 1179
Children ............................................................................................................................... 1180
Comments ............................................................................................................................ 1180
CoordinateSystem ................................................................................................................ 1180
DataModelObjectCategory ................................................................................................... 1181
Figures ................................................................................................................................. 1181
Images ................................................................................................................................. 1181
InternalObject ...................................................................................................................... 1181
Location ............................................................................................................................... 1181
Material ................................................................................................................................ 1181
Suppressed ........................................................................................................................... 1182
SurfaceCoatingStiffnessBehavior ........................................................................................... 1182
Thickness .............................................................................................................................. 1182
AddComment() ..................................................................................................................... 1182
AddFigure() .......................................................................................................................... 1182
AddImage(string) .................................................................................................................. 1182
Delete() ................................................................................................................................ 1183
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1183
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1183
Symmetry ................................................................................................................................... 1184
Children ............................................................................................................................... 1185
Comments ............................................................................................................................ 1185
DataModelObjectCategory ................................................................................................... 1185
Figures ................................................................................................................................. 1185
Images ................................................................................................................................. 1185
InternalObject ...................................................................................................................... 1185
AddComment() ..................................................................................................................... 1186
AddCyclicRegion() ................................................................................................................ 1186
AddFigure() .......................................................................................................................... 1186
AddGeneralAxisymmetric() ................................................................................................... 1186
AddImage(string) .................................................................................................................. 1186
AddLinearPeriodicRegion() ................................................................................................... 1187
AddPeriodicRegion() ............................................................................................................. 1187
AddPreMeshedCyclicRegion() ............................................................................................... 1187
AddStage() ........................................................................................................................... 1187
AddSymmetryRegion() .......................................................................................................... 1187
Delete() ................................................................................................................................ 1187

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xcv
ACT API Reference Guide

GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1188


GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1188
SymmetryGeneral ....................................................................................................................... 1188
Children ............................................................................................................................... 1189
Comments ............................................................................................................................ 1189
CoordinateSystem ................................................................................................................ 1190
DataModelObjectCategory ................................................................................................... 1190
Figures ................................................................................................................................. 1190
HighBoundaryLocation ......................................................................................................... 1190
Images ................................................................................................................................. 1190
InternalObject ...................................................................................................................... 1190
Location ............................................................................................................................... 1191
LowBoundaryLocation .......................................................................................................... 1191
ScopeMode .......................................................................................................................... 1191
Suppressed ........................................................................................................................... 1191
AddComment() ..................................................................................................................... 1191
AddFigure() .......................................................................................................................... 1191
AddImage(string) .................................................................................................................. 1192
Delete() ................................................................................................................................ 1192
FlipHighLow() ....................................................................................................................... 1192
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1192
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1193
SymmetryManufacturingConstraint ............................................................................................ 1193
Axis ...................................................................................................................................... 1194
CoordinateSystem ................................................................................................................ 1194
DataModelObjectCategory ................................................................................................... 1194
InternalObject ...................................................................................................................... 1194
Location ............................................................................................................................... 1194
ScopingMethod .................................................................................................................... 1195
SymmetryRegion ........................................................................................................................ 1195
ApplyTo ................................................................................................................................ 1196
Behavior ............................................................................................................................... 1196
DataModelObjectCategory ................................................................................................... 1196
InternalObject ...................................................................................................................... 1196
LinearShift ............................................................................................................................ 1197
Location ............................................................................................................................... 1197
PeriodicityDirection .............................................................................................................. 1197
SymmetryNormal ................................................................................................................. 1197
Type ..................................................................................................................................... 1197
Table .......................................................................................................................................... 1197
APDLName ........................................................................................................................... 1199
Children ............................................................................................................................... 1199
Comments ............................................................................................................................ 1199
DataModelObjectCategory ................................................................................................... 1199
Figures ................................................................................................................................. 1199
Images ................................................................................................................................. 1200
InternalObject ...................................................................................................................... 1200
IsStrictSizing ......................................................................................................................... 1200
PathType .............................................................................................................................. 1200
RefreshImportOn .................................................................................................................. 1200
SendToSolver ........................................................................................................................ 1201

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xcvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

SpatialCoordinateSystem ...................................................................................................... 1201


AddComment() ..................................................................................................................... 1201
AddFigure() .......................................................................................................................... 1201
AddImage(string) .................................................................................................................. 1201
CreateAndAddColumn(VariableType, VariableClassification, IEnumerable, string, string) .......... 1202
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1202
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1203
GetDataURI(Column) ............................................................................................................ 1203
GetImportSettings(Column) .................................................................................................. 1204
Import(string, ImportFormat, ImportSettingsBase) ................................................................. 1204
Column ................................................................................................................................ 1205
PropertyChanged ........................................................................................................... 1205
Add(object) .................................................................................................................... 1205
ChangeVariableType(VariableType, VariableClassification, string) ...................................... 1206
Clear() ............................................................................................................................. 1206
Contains(object) ............................................................................................................. 1206
CopyTo(Array, int) ............................................................................................................ 1207
GetEnumerator() ............................................................................................................. 1207
IndexOf(object) .............................................................................................................. 1207
Insert(int, object) ............................................................................................................. 1207
Remove(object) .............................................................................................................. 1208
RemoveAt(int) ................................................................................................................ 1208
TableGroup ................................................................................................................................. 1208
Children ............................................................................................................................... 1209
Comments ............................................................................................................................ 1209
DataModelObjectCategory ................................................................................................... 1209
Figures ................................................................................................................................. 1209
Images ................................................................................................................................. 1210
InternalObject ...................................................................................................................... 1210
AddComment() ..................................................................................................................... 1210
AddFigure() .......................................................................................................................... 1210
AddImage(string) .................................................................................................................. 1210
AddTable(bool, bool) ............................................................................................................. 1211
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1211
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1211
TCrossSection ............................................................................................................................. 1212
Area ..................................................................................................................................... 1213
DataModelObjectCategory ................................................................................................... 1213
InternalObject ...................................................................................................................... 1213
IYY ....................................................................................................................................... 1213
IZZ ....................................................................................................................................... 1213
Thick1 .................................................................................................................................. 1214
Thick2 .................................................................................................................................. 1214
Width1 ................................................................................................................................. 1214
Width2 ................................................................................................................................. 1214
TemperatureConstraint ............................................................................................................... 1214
DataModelObjectCategory ................................................................................................... 1215
InternalObject ...................................................................................................................... 1215
Location ............................................................................................................................... 1215
ScopingMethod .................................................................................................................... 1215
TemperatureAbsMax ............................................................................................................. 1215

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xcvii
ACT API Reference Guide

ThermalComplianceConstraint .................................................................................................... 1216


ComplianceLimit .................................................................................................................. 1216
DataModelObjectCategory ................................................................................................... 1216
InternalObject ...................................................................................................................... 1216
ThermalPointMass ...................................................................................................................... 1217
AppliedBy ............................................................................................................................. 1218
Behavior ............................................................................................................................... 1218
CoordinateSystem ................................................................................................................ 1218
DataModelObjectCategory ................................................................................................... 1218
InternalObject ...................................................................................................................... 1218
PinballRegion ....................................................................................................................... 1218
Suppressed ........................................................................................................................... 1219
ThermalCapacitance ............................................................................................................. 1219
XCoordinate ......................................................................................................................... 1219
YCoordinate .......................................................................................................................... 1219
ZCoordinate ......................................................................................................................... 1219
PromoteToRemotePoint() ...................................................................................................... 1219
Thickness .................................................................................................................................... 1220
Children ............................................................................................................................... 1221
Comments ............................................................................................................................ 1221
DataModelObjectCategory ................................................................................................... 1221
Figures ................................................................................................................................. 1221
Images ................................................................................................................................. 1221
IndependentVariable ............................................................................................................ 1221
InternalObject ...................................................................................................................... 1222
Location ............................................................................................................................... 1222
MembraneOffset .................................................................................................................. 1222
NumberOfSegments ............................................................................................................. 1222
OffsetType ............................................................................................................................ 1222
RangeMaximum ................................................................................................................... 1222
RangeMinimum .................................................................................................................... 1223
ScopeMode .......................................................................................................................... 1223
Suppressed ........................................................................................................................... 1223
ThicknessField ...................................................................................................................... 1223
XYZFunctionCoordinateSystem ............................................................................................. 1223
AddComment() ..................................................................................................................... 1223
AddFigure() .......................................................................................................................... 1224
AddImage(string) .................................................................................................................. 1224
Delete() ................................................................................................................................ 1224
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1224
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1225
ThroughCrack ............................................................................................................................. 1225
BottomFaceNodes ................................................................................................................ 1226
CircumferentialDivisions ....................................................................................................... 1227
Contact1Nodes ..................................................................................................................... 1227
ContactPairsNodes ................................................................................................................ 1227
CoordinateSystem ................................................................................................................ 1227
CrackFacesNodes .................................................................................................................. 1227
CrackFrontDivisions .............................................................................................................. 1227
CrackFrontNodes .................................................................................................................. 1228
CrackMeshMethod ................................................................................................................ 1228

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xcviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

CrackShape .......................................................................................................................... 1228


CrackSourceType .................................................................................................................. 1228
DataModelObjectCategory ................................................................................................... 1228
Depth ................................................................................................................................... 1228
EndWidth ............................................................................................................................. 1229
FractureAffectedZone ........................................................................................................... 1229
FractureAffectedZoneHeight ................................................................................................. 1229
FrontElementSize .................................................................................................................. 1229
GrowthRate .......................................................................................................................... 1229
InternalObject ...................................................................................................................... 1229
LargestContourRadius .......................................................................................................... 1230
Location ............................................................................................................................... 1230
MeshContours ...................................................................................................................... 1230
MidWidth ............................................................................................................................. 1230
SolutionContours .................................................................................................................. 1230
StartWidth ............................................................................................................................ 1230
Suppressed ........................................................................................................................... 1231
Target1Nodes ....................................................................................................................... 1231
TopFaceNodes ...................................................................................................................... 1231
XScaleFactor ......................................................................................................................... 1231
YScaleFactor ......................................................................................................................... 1231
ZScaleFactor ......................................................................................................................... 1231
Tree ............................................................................................................................................ 1232
ActiveObjects ....................................................................................................................... 1233
AllObjects ............................................................................................................................. 1233
CurrentFilter ......................................................................................................................... 1233
CurrentSearchGraphics ......................................................................................................... 1233
CurrentSearchState ............................................................................................................... 1233
CurrentSearchString ............................................................................................................. 1234
FirstActiveObject .................................................................................................................. 1234
GroupingFoldersVisible ......................................................................................................... 1234
Activate(IDataModelObject) .................................................................................................. 1234
Activate(IEnumerable<IDataModelObject>) .......................................................................... 1234
ClearFilter() ........................................................................................................................... 1235
ClearSort() ............................................................................................................................ 1235
Filter(string, string, ObjectState, VisibilityType, TreeFilterObjectClass, CoordinateSystem, string,
Analysis, TreeFilterScopingType, TreeFilterObjectState, string, string, Nullable<bool>) ............. 1235
Find(string, Func<IDataModelObject, bool>, string, ObjectState) ............................................ 1236
GetPathToFirstActiveObject() ................................................................................................ 1237
Group(IDataModelObject) ..................................................................................................... 1237
Group(IEnumerable) ............................................................................................................. 1237
IsSorted() .............................................................................................................................. 1238
Refresh() ............................................................................................................................... 1238
Sort(SortingType, bool) ......................................................................................................... 1238
Suspend() ***OBSOLETE*** Use 'Transaction' instead. ............................................................ 1239
Ungroup(TreeGroupingFolder) .............................................................................................. 1239
TreeGroupingFolder .................................................................................................................... 1239
Children ............................................................................................................................... 1240
ChildrenInGroup ................................................................................................................... 1240
DataModelObjectCategory ................................................................................................... 1240
InternalObject ...................................................................................................................... 1240

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xcix
ACT API Reference Guide

Suppressed ........................................................................................................................... 1240


DeleteTreeGroupAndChildren() ............................................................................................. 1240
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1241
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1241
UniformConstraint ...................................................................................................................... 1242
Axis ...................................................................................................................................... 1242
CoordinateSystem ................................................................................................................ 1242
DataModelObjectCategory ................................................................................................... 1243
InternalObject ...................................................................................................................... 1243
Location ............................................................................................................................... 1243
ScopingMethod .................................................................................................................... 1243
UserDefinedCrossSection ............................................................................................................ 1243
Area ..................................................................................................................................... 1244
CGy ...................................................................................................................................... 1244
CGZ ...................................................................................................................................... 1244
DataModelObjectCategory ................................................................................................... 1245
InternalObject ...................................................................................................................... 1245
Iw ......................................................................................................................................... 1245
Iyy ........................................................................................................................................ 1245
Izz ........................................................................................................................................ 1245
J ........................................................................................................................................... 1245
SHy ....................................................................................................................................... 1246
SHz ....................................................................................................................................... 1246
VirtualCell ................................................................................................................................... 1246
Children ............................................................................................................................... 1247
Comments ............................................................................................................................ 1247
DataModelObjectCategory ................................................................................................... 1247
Figures ................................................................................................................................. 1247
Geometry ............................................................................................................................. 1247
Images ................................................................................................................................. 1247
InternalObject ...................................................................................................................... 1248
ProjectToUnderlyingGeometry .............................................................................................. 1248
VTClass ................................................................................................................................. 1248
AddComment() ..................................................................................................................... 1248
AddFigure() .......................................................................................................................... 1248
AddImage(string) .................................................................................................................. 1248
Delete() ................................................................................................................................ 1249
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1249
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1249
VirtualTopology .......................................................................................................................... 1250
AspectRatio .......................................................................................................................... 1252
AutomaticBehavior ............................................................................................................... 1252
Children ............................................................................................................................... 1252
Comments ............................................................................................................................ 1252
ContactAngle ....................................................................................................................... 1252
CustomFeatureAngle ............................................................................................................ 1253
DataModelObjectCategory ................................................................................................... 1253
EdgeAngle ............................................................................................................................ 1253
Figures ................................................................................................................................. 1253
GaussAngle .......................................................................................................................... 1253
GenerateOnUpdate .............................................................................................................. 1253

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
c of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Images ................................................................................................................................. 1254


InternalObject ...................................................................................................................... 1254
LockPositionOfDependentEdgeSplits .................................................................................... 1254
MaxEdgeLength ................................................................................................................... 1254
MaxFaceArea ........................................................................................................................ 1254
MaxSliverWidth .................................................................................................................... 1254
MergeFaceEdges ................................................................................................................... 1255
Method ................................................................................................................................ 1255
MinEdgeLength .................................................................................................................... 1255
MinFaceArea ......................................................................................................................... 1255
MinSliverWidth ..................................................................................................................... 1255
RepairBehavior ..................................................................................................................... 1255
SharedBoundaryRatio ........................................................................................................... 1256
SimplifyFaces ........................................................................................................................ 1256
VirtualEdges ......................................................................................................................... 1256
VirtualEntities ....................................................................................................................... 1256
VirtualFaces .......................................................................................................................... 1256
VirtualHardVertex ................................................................................................................. 1256
VirtualSplitEdges .................................................................................................................. 1257
VirtualSplitFaces ................................................................................................................... 1257
AddComment() ..................................................................................................................... 1257
AddFigure() .......................................................................................................................... 1257
AddImage(string) .................................................................................................................. 1257
AddVirtualCell(ISelectionInfo) ............................................................................................... 1258
AddVirtualHardVertex(ISelectionInfo, Point) ........................................................................... 1258
AddVirtualSplitEdgeAt(ISelectionInfo, Point) .......................................................................... 1258
Delete() ................................................................................................................................ 1259
DeleteAllVirtualCells() ........................................................................................................... 1259
DeleteAllVirtualEntities() ....................................................................................................... 1259
DeleteAllVirtualHardVertices() ............................................................................................... 1259
DeleteAllVirtualSplitEdges() .................................................................................................. 1259
DeleteAllVirtualSplitFaces() ................................................................................................... 1259
GenerateVirtualCells(ISelectionInfo) ...................................................................................... 1260
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1260
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1260
GetVirtualCellFromSelection(ISelectionInfo) .......................................................................... 1261
VirtualSplitEdge(ISelectionInfo, double) ................................................................................. 1261
VirtualSplitFaceAtVertices(ISelectionInfo) .............................................................................. 1261
VolumeConstraint ....................................................................................................................... 1262
DataModelObjectCategory ................................................................................................... 1262
DefineBy ............................................................................................................................... 1263
InternalObject ...................................................................................................................... 1263
Location ............................................................................................................................... 1263
MaximumAbsoluteValue ....................................................................................................... 1263
MinimumAbsoluteValue ....................................................................................................... 1263
PercentageToRetain .............................................................................................................. 1263
PercentageToRetainMax ....................................................................................................... 1264
PercentageToRetainMin ........................................................................................................ 1264
ScopingMethod .................................................................................................................... 1264
Selection .............................................................................................................................. 1264
Worksheet .................................................................................................................................. 1264

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. ci
ACT API Reference Guide

ZCrossSection ............................................................................................................................. 1264


Area ..................................................................................................................................... 1265
DataModelObjectCategory ................................................................................................... 1265
InternalObject ...................................................................................................................... 1266
IYY ....................................................................................................................................... 1266
IZZ ....................................................................................................................................... 1266
Thick1 .................................................................................................................................. 1266
Thick2 .................................................................................................................................. 1266
Thick3 .................................................................................................................................. 1266
Width1 ................................................................................................................................. 1267
Width2 ................................................................................................................................. 1267
Width3 ................................................................................................................................. 1267
Ansys.ACT.Automation.Mechanical.FE Namespace ....................................................................... 1269
Command .................................................................................................................................. 1269
Index .................................................................................................................................... 1269
Name ................................................................................................................................... 1269
CommandColl ............................................................................................................................. 1270
Count ................................................................................................................................... 1270
Item(uint) ............................................................................................................................. 1270
CommandRepository .................................................................................................................. 1270
GetCommandByIndex(int) .................................................................................................... 1271
GetCommandName(CommandsType, int) .............................................................................. 1271
GetCommandNames(CommandsType) ................................................................................. 1272
GetCommandNamesCount(CommandsType) ........................................................................ 1272
GetCommandsByName(string) .............................................................................................. 1272
CommandsType .......................................................................................................................... 1272
FEParser ...................................................................................................................................... 1273
FEParser() ............................................................................................................................. 1273
Ansys.ACT.Automation.Mechanical.FE.NASTRAN Namespace ...................................................... 1275
CaseControlCommand ................................................................................................................ 1275
Text ...................................................................................................................................... 1275
GenericCommand ....................................................................................................................... 1276
Arguments ........................................................................................................................... 1276
NastranOption ............................................................................................................................ 1276
NastranOptionLine ..................................................................................................................... 1276
OptionsControlCommand ........................................................................................................... 1277
Arguments ........................................................................................................................... 1277
OptionLines .......................................................................................................................... 1277
Ansys.ACT.Automation.Mechanical.FE.CDB Namespace ............................................................... 1279
BeamSecBlockCommand ............................................................................................................ 1280
Cells ..................................................................................................................................... 1281
Nodes ................................................................................................................................... 1281
Type ..................................................................................................................................... 1281
BFBlockCommand ...................................................................................................................... 1281
Lab ....................................................................................................................................... 1282
NodalBodyForceCount .......................................................................................................... 1282
NodalBodyForces .................................................................................................................. 1282
BFCommand ............................................................................................................................... 1282
Lab ....................................................................................................................................... 1283
Node .................................................................................................................................... 1283
ValCount ............................................................................................................................... 1283

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Values ................................................................................................................................... 1283


BFEBlockCommand ..................................................................................................................... 1284
ElementBodyForceCount ...................................................................................................... 1284
ElementBodyForces .............................................................................................................. 1284
Lab ....................................................................................................................................... 1284
BFECommand ............................................................................................................................. 1285
Elem ..................................................................................................................................... 1285
Lab ....................................................................................................................................... 1285
Stloc ..................................................................................................................................... 1285
ValCount ............................................................................................................................... 1286
Values ................................................................................................................................... 1286
CECMODCommand .................................................................................................................... 1286
Constant ............................................................................................................................... 1286
Nce ....................................................................................................................................... 1286
CECommand .............................................................................................................................. 1287
Constant ............................................................................................................................... 1287
Nce ....................................................................................................................................... 1287
Terms ................................................................................................................................... 1287
CMBlockCommand ..................................................................................................................... 1288
Cmname ............................................................................................................................... 1288
Elements .............................................................................................................................. 1288
Type ..................................................................................................................................... 1288
CMEDITCommand ...................................................................................................................... 1289
Aname ................................................................................................................................. 1289
Cnames ................................................................................................................................ 1289
Oper ..................................................................................................................................... 1289
CMGRPCommand ....................................................................................................................... 1290
Aname ................................................................................................................................. 1290
Cnames ................................................................................................................................ 1290
CommandCell ............................................................................................................................. 1290
MatId .................................................................................................................................... 1291
Nodes ................................................................................................................................... 1291
CommandCETerm ....................................................................................................................... 1291
Coefficient ............................................................................................................................ 1291
Dof ....................................................................................................................................... 1291
Node .................................................................................................................................... 1292
CommandElement ...................................................................................................................... 1292
Csys ...................................................................................................................................... 1292
ElementShapeFlag ................................................................................................................ 1292
Id ......................................................................................................................................... 1293
Mat ...................................................................................................................................... 1293
NodeCount ........................................................................................................................... 1293
Nodes ................................................................................................................................... 1293
Real ...................................................................................................................................... 1293
Section ................................................................................................................................. 1293
Type ..................................................................................................................................... 1294
CommandElementBodyForce ...................................................................................................... 1294
Count ................................................................................................................................... 1294
Elem ..................................................................................................................................... 1294
Stlocs ................................................................................................................................... 1294
Values ................................................................................................................................... 1295

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. ciii
ACT API Reference Guide

CommandElementSurfaceLoad ................................................................................................... 1295


Count ................................................................................................................................... 1295
Elem ..................................................................................................................................... 1295
ElementSurfaceLoadValues ................................................................................................... 1296
Keys ..................................................................................................................................... 1296
LKeys .................................................................................................................................... 1296
CommandElementSurfaceLoadValues ......................................................................................... 1296
ValueCount ........................................................................................................................... 1296
Values ................................................................................................................................... 1297
CommandElementType .............................................................................................................. 1297
Ename .................................................................................................................................. 1297
Id ......................................................................................................................................... 1297
Keyopts ................................................................................................................................ 1297
CommandKeyOpt ....................................................................................................................... 1298
Knum ................................................................................................................................... 1298
Value .................................................................................................................................... 1298
CommandLayer .......................................................................................................................... 1298
Mat ...................................................................................................................................... 1299
Numpt .................................................................................................................................. 1299
Theta .................................................................................................................................... 1299
Thick .................................................................................................................................... 1299
CommandNodalBodyForce ......................................................................................................... 1299
Node .................................................................................................................................... 1300
ValCount ............................................................................................................................... 1300
Values ................................................................................................................................... 1300
CommandNodalLoad .................................................................................................................. 1300
Dof ....................................................................................................................................... 1300
Node .................................................................................................................................... 1301
ValueCount ........................................................................................................................... 1301
Values ................................................................................................................................... 1301
CommandNode .......................................................................................................................... 1301
Id ......................................................................................................................................... 1301
Location ............................................................................................................................... 1302
Rotation ............................................................................................................................... 1302
CommandReal ............................................................................................................................ 1302
Id ......................................................................................................................................... 1302
Values ................................................................................................................................... 1302
CPCommand .............................................................................................................................. 1303
Dof ....................................................................................................................................... 1303
Ncp ...................................................................................................................................... 1303
Nodes ................................................................................................................................... 1303
DBlockCommand ........................................................................................................................ 1304
NodalLoads .......................................................................................................................... 1304
NodalLoadsCount ................................................................................................................. 1304
EBlockCommand ........................................................................................................................ 1304
Elements .............................................................................................................................. 1305
ENCommand .............................................................................................................................. 1305
Type ..................................................................................................................................... 1305
Values ................................................................................................................................... 1306
ETBlockCommand ...................................................................................................................... 1306
ElementTypeCount ............................................................................................................... 1306

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
civ of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

ElementTypes ....................................................................................................................... 1306


ETCommand ............................................................................................................................... 1307
Ename .................................................................................................................................. 1307
Id ......................................................................................................................................... 1307
Keyopts ................................................................................................................................ 1307
FBlockCommand ........................................................................................................................ 1308
NodalLoads .......................................................................................................................... 1308
NodalLoadsCount ................................................................................................................. 1308
GenericCommand ....................................................................................................................... 1308
Arguments ........................................................................................................................... 1309
LocalCommand .......................................................................................................................... 1309
Cstyp .................................................................................................................................... 1310
Ncsy ..................................................................................................................................... 1310
Type ..................................................................................................................................... 1310
Values ................................................................................................................................... 1310
MPCommand ............................................................................................................................. 1310
C0 ........................................................................................................................................ 1311
C1 ........................................................................................................................................ 1311
C2 ........................................................................................................................................ 1311
C3 ........................................................................................................................................ 1311
C4 ........................................................................................................................................ 1312
Lab ....................................................................................................................................... 1312
Mat ...................................................................................................................................... 1312
MPDataCommand ...................................................................................................................... 1312
Lab ....................................................................................................................................... 1313
Mat ...................................................................................................................................... 1313
Temps .................................................................................................................................. 1313
Values ................................................................................................................................... 1313
NBlockCommand ........................................................................................................................ 1313
Nodes ................................................................................................................................... 1314
NCommand ................................................................................................................................ 1314
Node .................................................................................................................................... 1314
Type ..................................................................................................................................... 1314
Values ................................................................................................................................... 1315
PreadCommand .......................................................................................................................... 1315
Aname ................................................................................................................................. 1315
Values ................................................................................................................................... 1315
RCommand ................................................................................................................................ 1316
Nset ...................................................................................................................................... 1316
Stloc ..................................................................................................................................... 1316
Values ................................................................................................................................... 1316
RLBlockCommand ...................................................................................................................... 1317
Reals ..................................................................................................................................... 1317
SeccontrolCommand .................................................................................................................. 1317
Values ................................................................................................................................... 1318
SecdataCommand ...................................................................................................................... 1318
Values ................................................................................................................................... 1318
SecoffsetCommand .................................................................................................................... 1318
Location ............................................................................................................................... 1319
Values ................................................................................................................................... 1319
SectypeCommand ...................................................................................................................... 1319

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cv
ACT API Reference Guide

RefineKey ............................................................................................................................. 1320


Secid .................................................................................................................................... 1320
Secname .............................................................................................................................. 1320
Subtype ................................................................................................................................ 1320
Type ..................................................................................................................................... 1320
SFEBlockCommand ..................................................................................................................... 1320
ElementSurfaceLoadCount ................................................................................................... 1321
ElementSurfaceLoads ........................................................................................................... 1321
Lab ....................................................................................................................................... 1321
SFECommand ............................................................................................................................. 1321
Elem ..................................................................................................................................... 1322
Key ....................................................................................................................................... 1322
Lab ....................................................................................................................................... 1322
LKey ..................................................................................................................................... 1322
Values ................................................................................................................................... 1323
ShellSecBlockCommand ............................................................................................................. 1323
Layers ................................................................................................................................... 1323
Type ..................................................................................................................................... 1323
TBDataCommand ....................................................................................................................... 1324
DataValueCount .................................................................................................................... 1324
DataValues ........................................................................................................................... 1324
Lab ....................................................................................................................................... 1324
Mat ...................................................................................................................................... 1325
Npts ..................................................................................................................................... 1325
Ntemp .................................................................................................................................. 1325
Tbopt ................................................................................................................................... 1325
TBDataValues .............................................................................................................................. 1325
Temp .................................................................................................................................... 1326
ValueCount ........................................................................................................................... 1326
Values ................................................................................................................................... 1326
TBPTCommand ........................................................................................................................... 1326
Lab ....................................................................................................................................... 1327
Mat ...................................................................................................................................... 1327
Npts ..................................................................................................................................... 1327
Ntemp .................................................................................................................................. 1327
Tbopt ................................................................................................................................... 1327
TBPTData .............................................................................................................................. 1328
TBPTDataCount .................................................................................................................... 1328
TBPTData .................................................................................................................................... 1328
TBPTCount ............................................................................................................................ 1328
TBPTValues ........................................................................................................................... 1328
Temp .................................................................................................................................... 1329
TBPTValues ................................................................................................................................. 1329
ValueCount ........................................................................................................................... 1329
Values ................................................................................................................................... 1329
Ansys.ACT.Automation.Mechanical.FE.ABAQUS Namespace ........................................................ 1331
AbaqusKeyword ......................................................................................................................... 1331
Arguments ........................................................................................................................... 1331
DataLines ............................................................................................................................. 1332
AbaqusKeywordArgument .......................................................................................................... 1332
Key ....................................................................................................................................... 1332

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Value .................................................................................................................................... 1332


AbaqusKeywordArgumentColl .................................................................................................... 1332
Items .................................................................................................................................... 1333
AbaqusKeywordDataLine ............................................................................................................ 1333
Items .................................................................................................................................... 1333
AbaqusKeywordDataLineColl ...................................................................................................... 1333
Items .................................................................................................................................... 1334
Ansys.ACT.Automation.Mechanical.Substructure Namespace ...................................................... 1335
ExportSettings ............................................................................................................................ 1335
ExportSettings() .................................................................................................................... 1335
Ansys.ACT.Automation.Mechanical.Results Namespace ............................................................... 1337
Alert ........................................................................................................................................... 1338
Children ............................................................................................................................... 1338
Comments ............................................................................................................................ 1338
DataModelObjectCategory ................................................................................................... 1339
FailsIf .................................................................................................................................... 1339
Images ................................................................................................................................. 1339
InternalObject ...................................................................................................................... 1339
Status ................................................................................................................................... 1339
Value .................................................................................................................................... 1339
AddComment() ..................................................................................................................... 1340
AddImage(string) .................................................................................................................. 1340
Delete() ................................................................................................................................ 1340
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1340
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1341
ContactDataTable ....................................................................................................................... 1341
Children ............................................................................................................................... 1342
Comments ............................................................................................................................ 1342
DataModelObjectCategory ................................................................................................... 1342
Figures ................................................................................................................................. 1342
InternalObject ...................................................................................................................... 1342
AddComment() ..................................................................................................................... 1343
AddFigure() .......................................................................................................................... 1343
Delete() ................................................................................................................................ 1343
ExportTextFile(string) ............................................................................................................ 1343
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1343
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1344
Convergence .............................................................................................................................. 1344
AllowableChange ................................................................................................................. 1345
Children ............................................................................................................................... 1345
Comments ............................................................................................................................ 1345
DataModelObjectCategory ................................................................................................... 1345
Figures ................................................................................................................................. 1346
Images ................................................................................................................................. 1346
InternalObject ...................................................................................................................... 1346
IsConverged ......................................................................................................................... 1346
LastChange .......................................................................................................................... 1346
Type ..................................................................................................................................... 1346
AddComment() ..................................................................................................................... 1347
AddFigure() .......................................................................................................................... 1347
AddImage(string) .................................................................................................................. 1347

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cvii
ACT API Reference Guide

Delete() ................................................................................................................................ 1347


GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1347
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1348
LatticeDensity ............................................................................................................................. 1348
DataModelObjectCategory ................................................................................................... 1350
InternalObject ...................................................................................................................... 1350
LatticeElementalDensity ............................................................................................................. 1351
DataModelObjectCategory ................................................................................................... 1353
InternalObject ...................................................................................................................... 1353
LinePressureResult ...................................................................................................................... 1353
DataModelObjectCategory ................................................................................................... 1357
InternalObject ...................................................................................................................... 1357
LinePressureResultBasedOn .................................................................................................. 1357
MagneticCoenergy ..................................................................................................................... 1357
DataModelObjectCategory ................................................................................................... 1361
InternalObject ...................................................................................................................... 1361
MagneticPotential ...................................................................................................................... 1362
DataModelObjectCategory ................................................................................................... 1365
InternalObject ...................................................................................................................... 1366
NewtonRaphsonResidualCharge ................................................................................................. 1366
DataModelObjectCategory ................................................................................................... 1370
InternalObject ...................................................................................................................... 1370
NewtonRaphsonResidualForce .................................................................................................... 1370
DataModelObjectCategory ................................................................................................... 1374
InternalObject ...................................................................................................................... 1374
NewtonRaphsonResidualHeat ..................................................................................................... 1374
DataModelObjectCategory ................................................................................................... 1378
InternalObject ...................................................................................................................... 1378
NewtonRaphsonResidualMoment ............................................................................................... 1378
DataModelObjectCategory ................................................................................................... 1382
InternalObject ...................................................................................................................... 1382
Result ......................................................................................................................................... 1383
Average ................................................................................................................................ 1385
By ......................................................................................................................................... 1385
CalculateTimeHistory ............................................................................................................ 1385
Children ............................................................................................................................... 1386
CombinationNumber ............................................................................................................ 1386
Comments ............................................................................................................................ 1386
CoordinateSystem ................................................................................................................ 1386
CrackFrontNumber ............................................................................................................... 1386
DataModelObjectCategory ................................................................................................... 1387
DisplayOption ....................................................................................................................... 1387
DisplayTime .......................................................................................................................... 1387
DpfEvaluation ....................................................................................................................... 1387
Figures ................................................................................................................................. 1387
GlobalIDs .............................................................................................................................. 1387
GraphControlsXAxis .............................................................................................................. 1388
Identifier ............................................................................................................................... 1388
Images ................................................................................................................................. 1388
InternalObject ...................................................................................................................... 1388
IsSolved ................................................................................................................................ 1388

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

ItemType .............................................................................................................................. 1388


IterationNumber ................................................................................................................... 1389
LoadStep .............................................................................................................................. 1389
LoadStepForMaximumOfMaximumValues ............................................................................. 1389
LoadStepForMaximumOfMinimumValues ............................................................................. 1389
LoadStepForMinimumOfMaximumValues ............................................................................. 1389
LoadStepForMinimumOfMinimumValues .............................................................................. 1389
LoadStepNumber ................................................................................................................. 1390
Location ............................................................................................................................... 1390
Maximum ............................................................................................................................. 1390
MaximumOccursOn .............................................................................................................. 1390
MaximumOfMaximumOverTime ........................................................................................... 1390
MaximumOfMinimumOverTime ............................................................................................ 1390
Minimum .............................................................................................................................. 1391
MinimumOccursOn .............................................................................................................. 1391
MinimumOfMaximumOverTime ............................................................................................ 1391
MinimumOfMinimumOverTime ............................................................................................ 1391
NamedSelections .................................................................................................................. 1391
Path ...................................................................................................................................... 1391
PlotData ............................................................................................................................... 1392
RPMSelection ....................................................................................................................... 1392
ScopingMethod .................................................................................................................... 1392
SetNumber ........................................................................................................................... 1392
SolutionCombinationDriver .................................................................................................. 1392
SolverComponentIDs ............................................................................................................ 1392
Substep ................................................................................................................................ 1393
Suppressed ........................................................................................................................... 1393
Surface ................................................................................................................................. 1393
SurfaceCoating ..................................................................................................................... 1393
Time ..................................................................................................................................... 1393
TimeForMaximumOfMaximumValues .................................................................................... 1393
TimeForMaximumOfMinimumValues .................................................................................... 1394
TimeForMinimumOfMaximumValues .................................................................................... 1394
TimeForMinimumOfMinimumValues ..................................................................................... 1394
Total ..................................................................................................................................... 1394
AddAlert() ............................................................................................................................. 1394
AddComment() ..................................................................................................................... 1394
AddConvergence() ................................................................................................................ 1395
AddFigure() .......................................................................................................................... 1395
AddImage(string) .................................................................................................................. 1395
ClearGeneratedData() ........................................................................................................... 1395
CreateResultsAtAllSets() ........................................................................................................ 1395
Delete() ................................................................................................................................ 1396
DuplicateWithoutResults() .................................................................................................... 1396
EvaluateAllResults() ............................................................................................................... 1396
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 1396
ExportToTextFile(string) ........................................................................................................ 1397
FetchRemoteResults() ........................................................................................................... 1397
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1397
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1397
PromoteToNamedSelection() ................................................................................................ 1398

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cix
ACT API Reference Guide

RenameBasedOnDefinition() ................................................................................................. 1398


ResultChart ................................................................................................................................. 1398
AccelerationType .................................................................................................................. 1400
BoundaryCondition .............................................................................................................. 1400
ChartDimensions .................................................................................................................. 1400
ChartViewingStyle ................................................................................................................ 1401
Children ............................................................................................................................... 1401
Comments ............................................................................................................................ 1401
CoordinateSystem ................................................................................................................ 1401
CurvesAppearanceDisplay .................................................................................................... 1401
CutFrequency ....................................................................................................................... 1401
DataModelObjectCategory ................................................................................................... 1402
DeformationType .................................................................................................................. 1402
DpfEvaluation ....................................................................................................................... 1402
Duration ............................................................................................................................... 1402
EnhancedTracking ................................................................................................................ 1402
FilterMaximum ..................................................................................................................... 1402
FilterMinimum ...................................................................................................................... 1403
FilterType ............................................................................................................................. 1403
FrequencyAtMaximumAmplitude ......................................................................................... 1403
GeometrySelectionString ...................................................................................................... 1403
Images ................................................................................................................................. 1403
ImaginaryAtMaximumAmplitude .......................................................................................... 1403
InternalObject ...................................................................................................................... 1404
IsSolved ................................................................................................................................ 1404
LoadStepNumber ................................................................................................................. 1404
Location ............................................................................................................................... 1404
Maximum ............................................................................................................................. 1404
MaximumAmplitude ............................................................................................................. 1404
MaximumFrequency ............................................................................................................. 1405
Minimum .............................................................................................................................. 1405
MinimumFrequency ............................................................................................................. 1405
NamedSelections .................................................................................................................. 1405
NormalOrientation ................................................................................................................ 1405
PhaseAngle .......................................................................................................................... 1405
RealAtMaximumAmplitude ................................................................................................... 1406
ReportedFrequency .............................................................................................................. 1406
RequestedFrequency ............................................................................................................ 1406
ResultChartType ................................................................................................................... 1406
RPMSelection ....................................................................................................................... 1406
SectorNumber ...................................................................................................................... 1406
ShearOrientation .................................................................................................................. 1407
SpatialResolution .................................................................................................................. 1407
Spring .................................................................................................................................. 1407
StressStrainType ................................................................................................................... 1407
Suppressed ........................................................................................................................... 1407
TimeHistoryDisplay ............................................................................................................... 1407
UseParentFrequencyRange ................................................................................................... 1408
VelocityType ......................................................................................................................... 1408
XAxisValues .......................................................................................................................... 1408
AddComment() ..................................................................................................................... 1408

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddImage(string) .................................................................................................................. 1408


ClearGeneratedData() ........................................................................................................... 1409
Delete() ................................................................................................................................ 1409
EvaluateAllResults() ............................................................................................................... 1409
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 1409
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1410
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1410
RenameBasedOnDefinition() ................................................................................................. 1410
ResultTable ................................................................................................................................. 1411
Children ............................................................................................................................... 1411
Comments ............................................................................................................................ 1411
DataModelObjectCategory ................................................................................................... 1412
Images ................................................................................................................................. 1412
InternalObject ...................................................................................................................... 1412
Multiplier .............................................................................................................................. 1412
AddComment() ..................................................................................................................... 1412
AddImage(string) .................................................................................................................. 1412
Delete() ................................................................................................................................ 1413
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1413
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1413
ShapeFinder ............................................................................................................................... 1414
DataModelObjectCategory ................................................................................................... 1418
InternalObject ...................................................................................................................... 1418
ShapeFinderElemental ................................................................................................................ 1418
DataModelObjectCategory ................................................................................................... 1422
InternalObject ...................................................................................................................... 1422
Smoothing ................................................................................................................................. 1422
DataModelObjectCategory ................................................................................................... 1423
ExportModel ......................................................................................................................... 1423
FileName .............................................................................................................................. 1423
InternalObject ...................................................................................................................... 1424
MoveLimit ............................................................................................................................ 1424
Evaluate() ............................................................................................................................. 1424
TopologyDensity ........................................................................................................................ 1424
DataModelObjectCategory ................................................................................................... 1426
InternalObject ...................................................................................................................... 1426
RetainedThreshold ................................................................................................................ 1427
AddSmoothing() ................................................................................................................... 1427
InsertSmoothing() ................................................................................................................. 1427
TopologyElementalDensity ......................................................................................................... 1427
DataModelObjectCategory ................................................................................................... 1429
InternalObject ...................................................................................................................... 1429
RetainedThreshold ................................................................................................................ 1429
TopologyOptimizationResult ....................................................................................................... 1430
CalculateTimeHistory ............................................................................................................ 1431
Children ............................................................................................................................... 1431
Comments ............................................................................................................................ 1431
DataModelObjectCategory ................................................................................................... 1431
ExclusionsParticipation ......................................................................................................... 1431
Figures ................................................................................................................................. 1432
FinalMass .............................................................................................................................. 1432

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxi
ACT API Reference Guide

FinalVolume .......................................................................................................................... 1432


Images ................................................................................................................................. 1432
InternalObject ...................................................................................................................... 1432
IterationNumber ................................................................................................................... 1432
IterationStep ......................................................................................................................... 1433
Location ............................................................................................................................... 1433
Maximum ............................................................................................................................. 1433
Minimum .............................................................................................................................. 1433
OriginalMass ......................................................................................................................... 1433
OriginalVolume ..................................................................................................................... 1433
PercentMassOfOriginal ......................................................................................................... 1434
PercentVolumeOfOriginal ..................................................................................................... 1434
ScopingMethod .................................................................................................................... 1434
Selection .............................................................................................................................. 1434
ShowOptimizedRegion ......................................................................................................... 1434
Suppressed ........................................................................................................................... 1434
AddComment() ..................................................................................................................... 1435
AddFigure() .......................................................................................................................... 1435
AddImage(string) .................................................................................................................. 1435
ClearGeneratedData() ........................................................................................................... 1435
Delete() ................................................................................................................................ 1435
EvaluateAllResults() ............................................................................................................... 1436
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 1436
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1436
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1437
RenameBasedOnDefinition() ................................................................................................. 1437
UserDefinedResult ...................................................................................................................... 1437
Average ................................................................................................................................ 1440
AverageAcrossBodies ............................................................................................................ 1440
By ......................................................................................................................................... 1440
CalculateTimeHistory ............................................................................................................ 1440
Children ............................................................................................................................... 1440
CombinationNumber ............................................................................................................ 1441
Comments ............................................................................................................................ 1441
CoordinateSystem ................................................................................................................ 1441
CyclicMode ........................................................................................................................... 1441
DataModelObjectCategory ................................................................................................... 1441
DisplayOption ....................................................................................................................... 1441
DisplayTime .......................................................................................................................... 1442
Expression ............................................................................................................................ 1442
Figures ................................................................................................................................. 1442
GlobalIDs .............................................................................................................................. 1442
GraphControlsXAxis .............................................................................................................. 1442
Identifier ............................................................................................................................... 1442
Images ................................................................................................................................. 1443
InputUnitSystem ................................................................................................................... 1443
InternalObject ...................................................................................................................... 1443
IsSolved ................................................................................................................................ 1443
ItemType .............................................................................................................................. 1443
IterationNumber ................................................................................................................... 1443
Layer .................................................................................................................................... 1444

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

LoadMultiplier ...................................................................................................................... 1444


LoadStep .............................................................................................................................. 1444
LoadStepNumber ................................................................................................................. 1444
Location ............................................................................................................................... 1444
Maximum ............................................................................................................................. 1444
MaximumOccursOn .............................................................................................................. 1445
MaximumOfMaximumOverTime ........................................................................................... 1445
MaximumOfMinimumOverTime ............................................................................................ 1445
Minimum .............................................................................................................................. 1445
MinimumOccursOn .............................................................................................................. 1445
MinimumOfMaximumOverTime ............................................................................................ 1445
MinimumOfMinimumOverTime ............................................................................................ 1446
Mode .................................................................................................................................... 1446
OutputUnit ........................................................................................................................... 1446
PhaseIncrement .................................................................................................................... 1446
Plies ..................................................................................................................................... 1446
PlotData ............................................................................................................................... 1446
Ply ........................................................................................................................................ 1447
Position ................................................................................................................................ 1447
ReportedFrequency .............................................................................................................. 1447
RequestedFrequency ............................................................................................................ 1447
ResponseType ...................................................................................................................... 1447
RPMSelection ....................................................................................................................... 1447
ScaleFactor ........................................................................................................................... 1448
ScaleFactorValue ................................................................................................................... 1448
ScopingMethod .................................................................................................................... 1448
SetNumber ........................................................................................................................... 1448
SolutionCombinationDriver .................................................................................................. 1448
SolverComponentIDs ............................................................................................................ 1448
SubScopeBy ......................................................................................................................... 1449
Substep ................................................................................................................................ 1449
Suppressed ........................................................................................................................... 1449
SweepingPhase .................................................................................................................... 1449
Time ..................................................................................................................................... 1449
Type ..................................................................................................................................... 1449
AddComment() ..................................................................................................................... 1450
AddFigure() .......................................................................................................................... 1450
AddImage(string) .................................................................................................................. 1450
ClearGeneratedData() ........................................................................................................... 1450
CreateResultsAtAllSets() ........................................................................................................ 1450
Delete() ................................................................................................................................ 1451
DuplicateWithoutResults() .................................................................................................... 1451
EvaluateAllResults() ............................................................................................................... 1451
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 1451
ExportToTextFile(string) ........................................................................................................ 1452
FetchRemoteResults() ........................................................................................................... 1452
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 1452
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 1452
PromoteToNamedSelection() ................................................................................................ 1453
RenameBasedOnDefinition() ................................................................................................. 1453
VariableGraph ............................................................................................................................. 1453

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxiii
ACT API Reference Guide

DataModelObjectCategory ................................................................................................... 1457


InternalObject ...................................................................................................................... 1457
Volume ....................................................................................................................................... 1457
Amplitude ............................................................................................................................ 1461
DataModelObjectCategory ................................................................................................... 1462
Frequency ............................................................................................................................ 1462
InternalObject ...................................................................................................................... 1462
PhaseIncrement .................................................................................................................... 1462
SweepingPhase .................................................................................................................... 1462
Ansys.ACT.Automation.Mechanical.Results.PhaseResponseResults Namespace ......................... 1463
AccelerationPhaseResponse ........................................................................................................ 1463
ContactRegion ...................................................................................................................... 1466
DataModelObjectCategory ................................................................................................... 1466
InternalObject ...................................................................................................................... 1467
DeformationPhaseResponse ....................................................................................................... 1467
DataModelObjectCategory ................................................................................................... 1470
InternalObject ...................................................................................................................... 1470
ElasticStrainPhaseResponse ........................................................................................................ 1470
ContactRegion ...................................................................................................................... 1473
DataModelObjectCategory ................................................................................................... 1474
InternalObject ...................................................................................................................... 1474
StressPhaseResponse .................................................................................................................. 1474
DataModelObjectCategory ................................................................................................... 1477
InternalObject ...................................................................................................................... 1477
VelocityPhaseResponse ............................................................................................................... 1477
ContactRegion ...................................................................................................................... 1481
DataModelObjectCategory ................................................................................................... 1481
InternalObject ...................................................................................................................... 1481
Ansys.ACT.Automation.Mechanical.Results.StrainResults Namespace ......................................... 1483
AccumulatedEquivalentPlasticStrain ........................................................................................... 1483
DataModelObjectCategory ................................................................................................... 1488
InternalObject ...................................................................................................................... 1488
DirectionalThermalStrain ............................................................................................................ 1489
DataModelObjectCategory ................................................................................................... 1494
InternalObject ...................................................................................................................... 1494
NormalOrientation ................................................................................................................ 1494
ElasticStrainIntensity ................................................................................................................... 1494
DataModelObjectCategory ................................................................................................... 1499
InternalObject ...................................................................................................................... 1499
EquivalentCreepStrain ................................................................................................................ 1499
DataModelObjectCategory ................................................................................................... 1504
InternalObject ...................................................................................................................... 1504
EquivalentCreepStrainRST ........................................................................................................... 1505
DataModelObjectCategory ................................................................................................... 1509
InternalObject ...................................................................................................................... 1510
EquivalentElasticStrain ................................................................................................................ 1510
DataModelObjectCategory ................................................................................................... 1515
InternalObject ...................................................................................................................... 1515
EquivalentElasticStrainRST .......................................................................................................... 1515
DataModelObjectCategory ................................................................................................... 1520
InternalObject ...................................................................................................................... 1520

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

EquivalentPlasticStrain ................................................................................................................ 1520


DataModelObjectCategory ................................................................................................... 1525
InternalObject ...................................................................................................................... 1525
EquivalentPlasticStrainRST .......................................................................................................... 1526
DataModelObjectCategory ................................................................................................... 1530
InternalObject ...................................................................................................................... 1531
EquivalentTotalStrain .................................................................................................................. 1531
DataModelObjectCategory ................................................................................................... 1536
InternalObject ...................................................................................................................... 1536
MaximumPrincipalElasticStrain ................................................................................................... 1536
DataModelObjectCategory ................................................................................................... 1541
InternalObject ...................................................................................................................... 1541
Layer .................................................................................................................................... 1541
NormalOrientation ................................................................................................................ 1542
MaximumPrincipalThermalStrain ................................................................................................ 1542
DataModelObjectCategory ................................................................................................... 1547
InternalObject ...................................................................................................................... 1547
MaximumShearElasticStrain ........................................................................................................ 1547
DataModelObjectCategory ................................................................................................... 1552
InternalObject ...................................................................................................................... 1552
ShearOrientation .................................................................................................................. 1552
MiddlePrincipalElasticStrain ........................................................................................................ 1552
DataModelObjectCategory ................................................................................................... 1557
InternalObject ...................................................................................................................... 1557
MiddlePrincipalThermalStrain ..................................................................................................... 1558
DataModelObjectCategory ................................................................................................... 1563
InternalObject ...................................................................................................................... 1563
MinimumPrincipalElasticStrain .................................................................................................... 1563
DataModelObjectCategory ................................................................................................... 1568
InternalObject ...................................................................................................................... 1568
NormalElasticStrain ..................................................................................................................... 1568
DataModelObjectCategory ................................................................................................... 1573
InternalObject ...................................................................................................................... 1573
NormalOrientation ................................................................................................................ 1573
ScaleFactor ........................................................................................................................... 1574
ScaleFactorValue ................................................................................................................... 1574
ShearElasticStrain ....................................................................................................................... 1574
DataModelObjectCategory ................................................................................................... 1579
InternalObject ...................................................................................................................... 1579
ScaleFactor ........................................................................................................................... 1579
ScaleFactorValue ................................................................................................................... 1579
ShearOrientation .................................................................................................................. 1580
StrainResult ................................................................................................................................ 1580
Amplitude ............................................................................................................................ 1584
AverageAcrossBodies ............................................................................................................ 1584
CyclicMode ........................................................................................................................... 1584
DataModelObjectCategory ................................................................................................... 1585
EnvironmentSelection ........................................................................................................... 1585
Frequency ............................................................................................................................ 1585
HarmonicIndex ..................................................................................................................... 1585
InternalObject ...................................................................................................................... 1585

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxv
ACT API Reference Guide

IterationStep ......................................................................................................................... 1585


LoadMultiplier ...................................................................................................................... 1586
Mode .................................................................................................................................... 1586
PhaseIncrement .................................................................................................................... 1586
Plies ..................................................................................................................................... 1586
Ply ........................................................................................................................................ 1586
Position ................................................................................................................................ 1586
ReportedFrequency .............................................................................................................. 1587
StressStrainType ................................................................................................................... 1587
SubScopeBy ......................................................................................................................... 1587
SweepingPhase .................................................................................................................... 1587
VectorPrincipalElasticStrain ......................................................................................................... 1587
DataModelObjectCategory ................................................................................................... 1592
InternalObject ...................................................................................................................... 1592
Ansys.ACT.Automation.Mechanical.Results.DeformationResults Namespace .............................. 1593
DeformationResult ...................................................................................................................... 1593
AccelerationInG .................................................................................................................... 1598
AllowPhaseSweep ................................................................................................................. 1598
Amplitude ............................................................................................................................ 1598
CyclicMode ........................................................................................................................... 1598
CyclicPhase ........................................................................................................................... 1598
DampedFrequency ............................................................................................................... 1599
DataModelObjectCategory ................................................................................................... 1599
DeformationType .................................................................................................................. 1599
EnvironmentSelection ........................................................................................................... 1599
Frequency ............................................................................................................................ 1599
HarmonicIndex ..................................................................................................................... 1599
InternalObject ...................................................................................................................... 1600
IterationStep ......................................................................................................................... 1600
LoadMultiplier ...................................................................................................................... 1600
LogarithmicDecrement ......................................................................................................... 1600
ModalDampingRatio ............................................................................................................. 1600
Mode .................................................................................................................................... 1600
PhaseIncrement .................................................................................................................... 1601
Probability ............................................................................................................................ 1601
Reference ............................................................................................................................. 1601
ReportedFrequency .............................................................................................................. 1601
ScaleFactor ........................................................................................................................... 1601
ScaleFactorValue ................................................................................................................... 1601
Stability ................................................................................................................................ 1602
SweepingPhase .................................................................................................................... 1602
DirectionalAcceleration ............................................................................................................... 1602
DataModelObjectCategory ................................................................................................... 1607
InternalObject ...................................................................................................................... 1607
NormalOrientation ................................................................................................................ 1608
DirectionalAccelerationPSD ........................................................................................................ 1608
DataModelObjectCategory ................................................................................................... 1613
InternalObject ...................................................................................................................... 1613
NormalOrientation ................................................................................................................ 1613
DirectionalAccelerationRS ........................................................................................................... 1614
DataModelObjectCategory ................................................................................................... 1619

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

InternalObject ...................................................................................................................... 1619


NormalOrientation ................................................................................................................ 1619
DirectionalDeformation .............................................................................................................. 1619
DataModelObjectCategory ................................................................................................... 1625
InternalObject ...................................................................................................................... 1625
NormalOrientation ................................................................................................................ 1625
DirectionalVelocity ...................................................................................................................... 1625
DataModelObjectCategory ................................................................................................... 1631
InternalObject ...................................................................................................................... 1631
NormalOrientation ................................................................................................................ 1631
DirectionalVelocityPSD ............................................................................................................... 1631
DataModelObjectCategory ................................................................................................... 1636
InternalObject ...................................................................................................................... 1637
NormalOrientation ................................................................................................................ 1637
DirectionalVelocityRS .................................................................................................................. 1637
DataModelObjectCategory ................................................................................................... 1642
InternalObject ...................................................................................................................... 1642
NormalOrientation ................................................................................................................ 1643
TotalAcceleration ........................................................................................................................ 1643
DataModelObjectCategory ................................................................................................... 1648
InternalObject ...................................................................................................................... 1648
TotalDeformation ....................................................................................................................... 1648
DataModelObjectCategory ................................................................................................... 1654
InternalObject ...................................................................................................................... 1654
TotalVelocity ............................................................................................................................... 1654
DataModelObjectCategory ................................................................................................... 1659
InternalObject ...................................................................................................................... 1659
VectorDeformation ..................................................................................................................... 1660
DataModelObjectCategory ................................................................................................... 1663
InternalObject ...................................................................................................................... 1664
Ansys.ACT.Automation.Mechanical.Results.DamageResults Namespace ..................................... 1665
DamageResult ............................................................................................................................ 1665
DamageResultType ............................................................................................................... 1669
DataModelObjectCategory ................................................................................................... 1670
InternalObject ...................................................................................................................... 1670
Mode .................................................................................................................................... 1670
Plies ..................................................................................................................................... 1670
Ply ........................................................................................................................................ 1670
DamageStatus ............................................................................................................................ 1670
DataModelObjectCategory ................................................................................................... 1675
InternalObject ...................................................................................................................... 1675
EnergyDissipatedPerUnitVolume ................................................................................................. 1675
DataModelObjectCategory ................................................................................................... 1679
InternalObject ...................................................................................................................... 1679
FiberCompressiveDamageVariable .............................................................................................. 1679
DataModelObjectCategory ................................................................................................... 1683
InternalObject ...................................................................................................................... 1684
FiberCompressiveFailureCriterion ................................................................................................ 1684
DataModelObjectCategory ................................................................................................... 1688
InternalObject ...................................................................................................................... 1688
FiberTensileDamageVariable ....................................................................................................... 1688

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxvii
ACT API Reference Guide

DataModelObjectCategory ................................................................................................... 1692


InternalObject ...................................................................................................................... 1692
FiberTensileFailureCriterion ......................................................................................................... 1693
DataModelObjectCategory ................................................................................................... 1697
InternalObject ...................................................................................................................... 1697
MatrixCompressiveDamageVariable ............................................................................................ 1697
DataModelObjectCategory ................................................................................................... 1701
InternalObject ...................................................................................................................... 1701
MatrixCompressiveFailureCriterion .............................................................................................. 1701
DataModelObjectCategory ................................................................................................... 1706
InternalObject ...................................................................................................................... 1706
MatrixTensileDamageVariable ..................................................................................................... 1706
DataModelObjectCategory ................................................................................................... 1710
InternalObject ...................................................................................................................... 1710
MatrixTensileFailureCriterion ....................................................................................................... 1710
DataModelObjectCategory ................................................................................................... 1714
InternalObject ...................................................................................................................... 1715
MaximumFailureCriteria .............................................................................................................. 1715
DataModelObjectCategory ................................................................................................... 1719
InternalObject ...................................................................................................................... 1719
MullinsDamageVariable .............................................................................................................. 1719
DataModelObjectCategory ................................................................................................... 1723
InternalObject ...................................................................................................................... 1723
MullinsMaximumPreviousStrainEnergy ....................................................................................... 1724
DataModelObjectCategory ................................................................................................... 1728
InternalObject ...................................................................................................................... 1728
ShearDamageVariable ................................................................................................................. 1728
DataModelObjectCategory ................................................................................................... 1732
InternalObject ...................................................................................................................... 1732
Ansys.ACT.Automation.Mechanical.Results.CoordinateSystemsResults Namespace ................... 1733
CoordinateSystemsResult ............................................................................................................ 1733
Amplitude ............................................................................................................................ 1737
DataModelObjectCategory ................................................................................................... 1738
Frequency ............................................................................................................................ 1738
InternalObject ...................................................................................................................... 1738
LoadMultiplier ...................................................................................................................... 1738
Mode .................................................................................................................................... 1738
PhaseIncrement .................................................................................................................... 1738
Ply ........................................................................................................................................ 1739
Position ................................................................................................................................ 1739
ScaleFactor ........................................................................................................................... 1739
ScaleFactorValue ................................................................................................................... 1739
SubScopeBy ......................................................................................................................... 1739
SweepingPhase .................................................................................................................... 1739
ElementalEulerXYAngle ............................................................................................................... 1740
DataModelObjectCategory ................................................................................................... 1744
InternalObject ...................................................................................................................... 1744
ElementalEulerXZAngle .............................................................................................................. 1745
DataModelObjectCategory ................................................................................................... 1749
InternalObject ...................................................................................................................... 1750
ElementalEulerYZAngle .............................................................................................................. 1750

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

DataModelObjectCategory ................................................................................................... 1754


InternalObject ...................................................................................................................... 1755
ElementalTriads .......................................................................................................................... 1755
DataModelObjectCategory ................................................................................................... 1760
InternalObject ...................................................................................................................... 1760
NodalEulerXYAngle ..................................................................................................................... 1760
DataModelObjectCategory ................................................................................................... 1765
InternalObject ...................................................................................................................... 1765
NodalEulerXZAngle .................................................................................................................... 1765
DataModelObjectCategory ................................................................................................... 1770
InternalObject ...................................................................................................................... 1770
NodalEulerYZAngle ..................................................................................................................... 1770
DataModelObjectCategory ................................................................................................... 1775
InternalObject ...................................................................................................................... 1775
NodalTriads ................................................................................................................................ 1775
DataModelObjectCategory ................................................................................................... 1780
InternalObject ...................................................................................................................... 1780
Ansys.ACT.Automation.Mechanical.Results.LinearizedStressResults Namespace ........................ 1781
LinearizedEquivalentStress .......................................................................................................... 1781
DataModelObjectCategory ................................................................................................... 1787
InternalObject ...................................................................................................................... 1787
LinearizedMaximumPrincipalStress ............................................................................................. 1787
DataModelObjectCategory ................................................................................................... 1793
InternalObject ...................................................................................................................... 1793
LinearizedMaximumShearStress .................................................................................................. 1794
DataModelObjectCategory ................................................................................................... 1800
InternalObject ...................................................................................................................... 1800
ShearOrientation .................................................................................................................. 1800
LinearizedMiddlePrincipalStress .................................................................................................. 1800
DataModelObjectCategory ................................................................................................... 1806
InternalObject ...................................................................................................................... 1806
LinearizedMinimumPrincipalStress .............................................................................................. 1806
DataModelObjectCategory ................................................................................................... 1812
InternalObject ...................................................................................................................... 1812
LinearizedNormalStress .............................................................................................................. 1812
DataModelObjectCategory ................................................................................................... 1818
InternalObject ...................................................................................................................... 1818
LinearizedShearStress ................................................................................................................. 1819
DataModelObjectCategory ................................................................................................... 1825
InternalObject ...................................................................................................................... 1825
ShearOrientation .................................................................................................................. 1825
LinearizedStressIntensity ............................................................................................................. 1825
DataModelObjectCategory ................................................................................................... 1831
InternalObject ...................................................................................................................... 1831
LinearizedStressResult ................................................................................................................ 1831
Amplitude ............................................................................................................................ 1836
AverageRadiusOfCurvature ................................................................................................... 1836
BendingInside ...................................................................................................................... 1836
BendingOutside .................................................................................................................... 1836
DataModelObjectCategory ................................................................................................... 1836
Frequency ............................................................................................................................ 1837

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxix
ACT API Reference Guide

InternalObject ...................................................................................................................... 1837


Linearized2DBehavior ........................................................................................................... 1837
LoadMultiplier ...................................................................................................................... 1837
Membrane ............................................................................................................................ 1837
MembraneBendingCenter ..................................................................................................... 1837
MembraneBendingInside ...................................................................................................... 1838
MembraneBendingOutside ................................................................................................... 1838
NormalOrientation ................................................................................................................ 1838
PeakCenter ........................................................................................................................... 1838
PeakInside ............................................................................................................................ 1838
PeakOutside ......................................................................................................................... 1838
Position ................................................................................................................................ 1839
StressStrainType ................................................................................................................... 1839
Subtype ................................................................................................................................ 1839
SweepingPhase .................................................................................................................... 1839
ThroughThicknessBendingStress ........................................................................................... 1839
TotalCenter ........................................................................................................................... 1839
TotalInside ............................................................................................................................ 1840
TotalOutside ......................................................................................................................... 1840
ZeroThroughThicknessBendingStress .................................................................................... 1840
Ansys.ACT.Automation.Mechanical.Results.GasketResults Namespace ....................................... 1841
GasketResult ............................................................................................................................... 1841
DataModelObjectCategory ................................................................................................... 1845
GasketResultType ................................................................................................................. 1845
InternalObject ...................................................................................................................... 1845
NormalGasketPressure ................................................................................................................ 1845
DataModelObjectCategory ................................................................................................... 1849
InternalObject ...................................................................................................................... 1850
NormalGasketTotalClosure .......................................................................................................... 1850
DataModelObjectCategory ................................................................................................... 1854
InternalObject ...................................................................................................................... 1854
ShearGasketPressure ................................................................................................................... 1854
DataModelObjectCategory ................................................................................................... 1858
InternalObject ...................................................................................................................... 1858
ShearOrientation .................................................................................................................. 1858
ShearGasketTotalClosure ............................................................................................................ 1858
DataModelObjectCategory ................................................................................................... 1862
InternalObject ...................................................................................................................... 1863
ShearOrientation .................................................................................................................. 1863
Ansys.ACT.Automation.Mechanical.Results.EnergyResults Namespace ....................................... 1865
ElementalStrainEnergy ................................................................................................................ 1865
DataModelObjectCategory ................................................................................................... 1869
InternalObject ...................................................................................................................... 1869
EnergyResult .............................................................................................................................. 1869
DataModelObjectCategory ................................................................................................... 1873
InternalObject ...................................................................................................................... 1873
StabilizationEnergy ..................................................................................................................... 1873
DataModelObjectCategory ................................................................................................... 1877
InternalObject ...................................................................................................................... 1877
StructuralStrainEnergy ................................................................................................................ 1878
DataModelObjectCategory ................................................................................................... 1881

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

InternalObject ...................................................................................................................... 1882


ThermalStrainEnergy .................................................................................................................. 1882
DataModelObjectCategory ................................................................................................... 1886
InternalObject ...................................................................................................................... 1886
Ansys.ACT.Automation.Mechanical.Results.ElectromagneticResults Namespace ........................ 1887
CurrentDensity ........................................................................................................................... 1887
DataModelObjectCategory ................................................................................................... 1891
InternalObject ...................................................................................................................... 1891
DirectionalMagneticFieldIntensity ............................................................................................... 1892
DataModelObjectCategory ................................................................................................... 1896
InternalObject ...................................................................................................................... 1896
NormalOrientation ................................................................................................................ 1896
DirectionalMagneticFluxDensity ................................................................................................. 1896
DataModelObjectCategory ................................................................................................... 1900
InternalObject ...................................................................................................................... 1900
NormalOrientation ................................................................................................................ 1901
ElectricPotential .......................................................................................................................... 1901
DataModelObjectCategory ................................................................................................... 1905
InternalObject ...................................................................................................................... 1905
ElectromagneticResult ................................................................................................................ 1905
AverageAcrossBodies ............................................................................................................ 1909
DataModelObjectCategory ................................................................................................... 1909
ElectromagneticResultType ................................................................................................... 1909
InternalObject ...................................................................................................................... 1910
FluxLinkage ................................................................................................................................ 1910
DataModelObjectCategory ................................................................................................... 1910
InternalObject ...................................................................................................................... 1911
Inductance ................................................................................................................................. 1911
DataModelObjectCategory ................................................................................................... 1911
InternalObject ...................................................................................................................... 1911
MagneticDirectionalForces .......................................................................................................... 1912
DataModelObjectCategory ................................................................................................... 1916
InternalObject ...................................................................................................................... 1916
NormalOrientation ................................................................................................................ 1916
MagneticError ............................................................................................................................. 1916
DataModelObjectCategory ................................................................................................... 1920
InternalObject ...................................................................................................................... 1920
MagneticTotalForces ................................................................................................................... 1921
DataModelObjectCategory ................................................................................................... 1925
InternalObject ...................................................................................................................... 1925
TotalMagneticFieldIntensity ........................................................................................................ 1925
DataModelObjectCategory ................................................................................................... 1929
InternalObject ...................................................................................................................... 1929
TotalMagneticFluxDensity ........................................................................................................... 1929
DataModelObjectCategory ................................................................................................... 1933
InternalObject ...................................................................................................................... 1934
Ansys.ACT.Automation.Mechanical.Results.ElectricResults Namespace ....................................... 1935
DirectionalCurrentDensity .......................................................................................................... 1935
DataModelObjectCategory ................................................................................................... 1940
InternalObject ...................................................................................................................... 1940
NormalOrientation ................................................................................................................ 1940

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxxi
ACT API Reference Guide

DirectionalElectricFieldIntensity .................................................................................................. 1940


DataModelObjectCategory ................................................................................................... 1944
InternalObject ...................................................................................................................... 1945
NormalOrientation ................................................................................................................ 1945
DirectionalElectricFluxDensity ..................................................................................................... 1945
DataModelObjectCategory ................................................................................................... 1949
InternalObject ...................................................................................................................... 1949
NormalOrientation ................................................................................................................ 1950
DirectionalElectrostaticForce ....................................................................................................... 1950
DataModelObjectCategory ................................................................................................... 1954
InternalObject ...................................................................................................................... 1954
NormalOrientation ................................................................................................................ 1954
ElectricResult .............................................................................................................................. 1954
Amplitude ............................................................................................................................ 1958
AverageAcrossBodies ............................................................................................................ 1959
DataModelObjectCategory ................................................................................................... 1959
ElectricResultType ................................................................................................................. 1959
Frequency ............................................................................................................................ 1959
InternalObject ...................................................................................................................... 1959
PhaseIncrement .................................................................................................................... 1959
ReportedFrequency .............................................................................................................. 1960
SweepingPhase .................................................................................................................... 1960
ElectricVoltage ............................................................................................................................ 1960
DataModelObjectCategory ................................................................................................... 1964
InternalObject ...................................................................................................................... 1964
JouleHeat ................................................................................................................................... 1965
DataModelObjectCategory ................................................................................................... 1969
InternalObject ...................................................................................................................... 1969
TotalCurrentDensity .................................................................................................................... 1969
DataModelObjectCategory ................................................................................................... 1974
InternalObject ...................................................................................................................... 1974
TotalElectricFieldIntensity ........................................................................................................... 1974
DataModelObjectCategory ................................................................................................... 1978
InternalObject ...................................................................................................................... 1978
TotalElectricFluxDensity .............................................................................................................. 1979
DataModelObjectCategory ................................................................................................... 1983
InternalObject ...................................................................................................................... 1983
TotalElectrostaticForce ................................................................................................................ 1983
DataModelObjectCategory ................................................................................................... 1987
InternalObject ...................................................................................................................... 1988
Ansys.ACT.Automation.Mechanical.Results.ContactToolResults Namespace ............................... 1989
ContactFluidPressure .................................................................................................................. 1989
DataModelObjectCategory ................................................................................................... 1993
InternalObject ...................................................................................................................... 1993
ContactFrictionalStress ............................................................................................................... 1993
DataModelObjectCategory ................................................................................................... 1997
InternalObject ...................................................................................................................... 1998
ContactGap ................................................................................................................................ 1998
DataModelObjectCategory ................................................................................................... 2002
InternalObject ...................................................................................................................... 2002
ContactHeatFlux ......................................................................................................................... 2002

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

DataModelObjectCategory ................................................................................................... 2006


InternalObject ...................................................................................................................... 2006
ContactPenetration ..................................................................................................................... 2006
DataModelObjectCategory ................................................................................................... 2010
InternalObject ...................................................................................................................... 2010
ContactPressure .......................................................................................................................... 2010
DataModelObjectCategory ................................................................................................... 2014
InternalObject ...................................................................................................................... 2015
ContactSlidingDistance ............................................................................................................... 2015
DataModelObjectCategory ................................................................................................... 2019
InternalObject ...................................................................................................................... 2019
ContactStatus ............................................................................................................................. 2019
DataModelObjectCategory ................................................................................................... 2023
InternalObject ...................................................................................................................... 2023
ContactToolResult ....................................................................................................................... 2023
ContactResultType ................................................................................................................ 2027
DataModelObjectCategory ................................................................................................... 2027
InternalObject ...................................................................................................................... 2027
Ansys.ACT.Automation.Mechanical.Results.StressResults Namespace ......................................... 2029
BendingStressEquivalent ............................................................................................................ 2030
DataModelObjectCategory ................................................................................................... 2036
InternalObject ...................................................................................................................... 2036
BendingStressIntensity ............................................................................................................... 2036
DataModelObjectCategory ................................................................................................... 2042
InternalObject ...................................................................................................................... 2042
DirectionalStress ......................................................................................................................... 2043
DataModelObjectCategory ................................................................................................... 2049
InternalObject ...................................................................................................................... 2049
EquivalentStress ......................................................................................................................... 2049
DataModelObjectCategory ................................................................................................... 2055
InternalObject ...................................................................................................................... 2055
EquivalentStressPSD ................................................................................................................... 2056
DataModelObjectCategory ................................................................................................... 2062
InternalObject ...................................................................................................................... 2062
ScaleFactorValue ................................................................................................................... 2062
EquivalentStressRS ...................................................................................................................... 2062
DataModelObjectCategory ................................................................................................... 2069
InternalObject ...................................................................................................................... 2069
MaximumPrincipalStress ............................................................................................................. 2069
DataModelObjectCategory ................................................................................................... 2075
InternalObject ...................................................................................................................... 2075
MaximumShearStress ................................................................................................................. 2075
DataModelObjectCategory ................................................................................................... 2082
InternalObject ...................................................................................................................... 2082
ShearOrientation .................................................................................................................. 2082
MembraneStressEquivalent ......................................................................................................... 2082
DataModelObjectCategory ................................................................................................... 2088
InternalObject ...................................................................................................................... 2088
MembraneStressIntensity ........................................................................................................... 2089
DataModelObjectCategory ................................................................................................... 2095
InternalObject ...................................................................................................................... 2095

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxxiii
ACT API Reference Guide

MiddlePrincipalStress .................................................................................................................. 2095


DataModelObjectCategory ................................................................................................... 2101
InternalObject ...................................................................................................................... 2101
MinimumPrincipalStress ............................................................................................................. 2102
DataModelObjectCategory ................................................................................................... 2108
InternalObject ...................................................................................................................... 2108
NormalStress .............................................................................................................................. 2108
DataModelObjectCategory ................................................................................................... 2114
InternalObject ...................................................................................................................... 2115
ScaleFactorValue ................................................................................................................... 2115
ShearStress ................................................................................................................................. 2115
DataModelObjectCategory ................................................................................................... 2121
InternalObject ...................................................................................................................... 2121
ScaleFactorValue ................................................................................................................... 2121
ShearOrientation .................................................................................................................. 2122
ShellBendingStress ..................................................................................................................... 2122
DataModelObjectCategory ................................................................................................... 2128
InternalObject ...................................................................................................................... 2128
NormalOrientation ................................................................................................................ 2128
ScaleFactorValue ................................................................................................................... 2129
ShellMBPType ....................................................................................................................... 2129
ShellBottomPeakStress ............................................................................................................... 2129
DataModelObjectCategory ................................................................................................... 2135
InternalObject ...................................................................................................................... 2135
NormalOrientation ................................................................................................................ 2135
ShellMBPType ....................................................................................................................... 2136
ShellMembraneStress ................................................................................................................. 2136
DataModelObjectCategory ................................................................................................... 2142
InternalObject ...................................................................................................................... 2142
NormalOrientation ................................................................................................................ 2142
ScaleFactorValue ................................................................................................................... 2143
ShellMBPType ....................................................................................................................... 2143
ShellTopPeakStress ..................................................................................................................... 2143
DataModelObjectCategory ................................................................................................... 2149
InternalObject ...................................................................................................................... 2149
NormalOrientation ................................................................................................................ 2149
ShellMBPType ....................................................................................................................... 2150
StressIntensity ............................................................................................................................ 2150
DataModelObjectCategory ................................................................................................... 2156
InternalObject ...................................................................................................................... 2156
StressResult ................................................................................................................................ 2156
Amplitude ............................................................................................................................ 2161
AverageAcrossBodies ............................................................................................................ 2161
AverageRadiusOfCurvature ................................................................................................... 2162
BendingInside ...................................................................................................................... 2162
BendingOutside .................................................................................................................... 2162
CyclicMode ........................................................................................................................... 2162
DataModelObjectCategory ................................................................................................... 2162
EnvironmentSelection ........................................................................................................... 2162
Frequency ............................................................................................................................ 2163
HarmonicIndex ..................................................................................................................... 2163

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

InternalObject ...................................................................................................................... 2163


IterationStep ......................................................................................................................... 2163
Layer .................................................................................................................................... 2163
Linearized2DBehavior ........................................................................................................... 2163
LoadMultiplier ...................................................................................................................... 2164
Membrane ............................................................................................................................ 2164
MembraneBendingCenter ..................................................................................................... 2164
MembraneBendingInside ...................................................................................................... 2164
MembraneBendingOutside ................................................................................................... 2164
Mode .................................................................................................................................... 2164
NormalOrientation ................................................................................................................ 2165
PeakCenter ........................................................................................................................... 2165
PeakInside ............................................................................................................................ 2165
PeakOutside ......................................................................................................................... 2165
PhaseIncrement .................................................................................................................... 2165
Plies ..................................................................................................................................... 2165
Ply ........................................................................................................................................ 2166
Position ................................................................................................................................ 2166
Probability ............................................................................................................................ 2166
ReportedFrequency .............................................................................................................. 2166
ScaleFactor ........................................................................................................................... 2166
StressStrainType ................................................................................................................... 2166
SubScopeBy ......................................................................................................................... 2167
Subtype ................................................................................................................................ 2167
SweepingPhase .................................................................................................................... 2167
ThroughThicknessBendingStress ........................................................................................... 2167
TotalCenter ........................................................................................................................... 2167
TotalInside ............................................................................................................................ 2167
TotalOutside ......................................................................................................................... 2168
StructuralError ............................................................................................................................ 2168
DataModelObjectCategory ................................................................................................... 2174
InternalObject ...................................................................................................................... 2174
VectorPrincipalStress .................................................................................................................. 2174
DataModelObjectCategory ................................................................................................... 2180
InternalObject ...................................................................................................................... 2181
Ansys.ACT.Automation.Mechanical.Results.FatigueToolResults Namespace ............................... 2183
FatigueBiaxialityIndication .......................................................................................................... 2183
DataModelObjectCategory ................................................................................................... 2187
InternalObject ...................................................................................................................... 2187
FatigueDamage .......................................................................................................................... 2188
DataModelObjectCategory ................................................................................................... 2192
InternalObject ...................................................................................................................... 2192
FatigueDamageMatrix ................................................................................................................ 2192
DataModelObjectCategory ................................................................................................... 2195
DesignLife ............................................................................................................................ 2195
InternalObject ...................................................................................................................... 2195
MaximumMean .................................................................................................................... 2196
MaximumRange ................................................................................................................... 2196
MinimumMean ..................................................................................................................... 2196
MinimumRange .................................................................................................................... 2196
OutputUnit ........................................................................................................................... 2196

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxxv
ACT API Reference Guide

FatigueEquivalentAlternativeStress ............................................................................................. 2196


DataModelObjectCategory ................................................................................................... 2200
InternalObject ...................................................................................................................... 2201
FatigueHysteresis ........................................................................................................................ 2201
DataModelObjectCategory ................................................................................................... 2204
InternalObject ...................................................................................................................... 2204
MaximumStrain .................................................................................................................... 2204
MaximumStress .................................................................................................................... 2205
MinimumStrain ..................................................................................................................... 2205
MinimumStress ..................................................................................................................... 2205
PointsPerSegment ................................................................................................................ 2205
FatigueLife .................................................................................................................................. 2205
DataModelObjectCategory ................................................................................................... 2209
InternalObject ...................................................................................................................... 2209
FatigueRainflowMatrix ................................................................................................................ 2210
DataModelObjectCategory ................................................................................................... 2213
InternalObject ...................................................................................................................... 2213
MaximumMean .................................................................................................................... 2213
MaximumRange ................................................................................................................... 2213
MinimumMean ..................................................................................................................... 2214
MinimumRange .................................................................................................................... 2214
OutputUnit ........................................................................................................................... 2214
FatigueSafetyFactor .................................................................................................................... 2214
DataModelObjectCategory ................................................................................................... 2218
InternalObject ...................................................................................................................... 2218
FatigueSensitivity ....................................................................................................................... 2218
ChartViewingStyle ................................................................................................................ 2219
Children ............................................................................................................................... 2219
Comments ............................................................................................................................ 2220
DataModelObjectCategory ................................................................................................... 2220
DesignLife ............................................................................................................................ 2220
Images ................................................................................................................................. 2220
InternalObject ...................................................................................................................... 2220
Location ............................................................................................................................... 2220
LowerVariation ..................................................................................................................... 2221
NumberOfFillPoints .............................................................................................................. 2221
Sensitivity ............................................................................................................................. 2221
Suppressed ........................................................................................................................... 2221
UpperVariation ..................................................................................................................... 2221
AddComment() ..................................................................................................................... 2221
AddImage(string) .................................................................................................................. 2222
Delete() ................................................................................................................................ 2222
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2222
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2223
RenameBasedOnDefinition() ................................................................................................. 2223
FatigueToolResult ....................................................................................................................... 2223
AverageAcrossBodies ............................................................................................................ 2227
DataModelObjectCategory ................................................................................................... 2227
DesignLife ............................................................................................................................ 2227
InternalObject ...................................................................................................................... 2228
Method ................................................................................................................................ 2228

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Ansys.ACT.Automation.Mechanical.Results.ThermalResults Namespace ..................................... 2229


DirectionalHeatFlux .................................................................................................................... 2229
DataModelObjectCategory ................................................................................................... 2233
InternalObject ...................................................................................................................... 2234
Ply ........................................................................................................................................ 2234
DirectionalThermalHeatFlux ........................................................................................................ 2234
DataModelObjectCategory ................................................................................................... 2238
InternalObject ...................................................................................................................... 2238
FluidFlowRate ............................................................................................................................. 2238
DataModelObjectCategory ................................................................................................... 2243
InternalObject ...................................................................................................................... 2243
FluidHeatConductionRate ........................................................................................................... 2243
DataModelObjectCategory ................................................................................................... 2247
InternalObject ...................................................................................................................... 2247
FluidHeatTransportRate .............................................................................................................. 2247
DataModelObjectCategory ................................................................................................... 2252
InternalObject ...................................................................................................................... 2252
TemperatureResult ..................................................................................................................... 2252
DataModelObjectCategory ................................................................................................... 2256
InternalObject ...................................................................................................................... 2256
ThermalError .............................................................................................................................. 2256
DataModelObjectCategory ................................................................................................... 2261
InternalObject ...................................................................................................................... 2261
ThermalResult ............................................................................................................................ 2261
AverageAcrossBodies ............................................................................................................ 2265
DataModelObjectCategory ................................................................................................... 2265
InternalObject ...................................................................................................................... 2265
Layer .................................................................................................................................... 2265
NormalOrientation ................................................................................................................ 2266
Position ................................................................................................................................ 2266
ThermalResultType ............................................................................................................... 2266
TotalHeatFlux ............................................................................................................................. 2266
DataModelObjectCategory ................................................................................................... 2270
InternalObject ...................................................................................................................... 2270
VectorHeatFlux ........................................................................................................................... 2271
DataModelObjectCategory ................................................................................................... 2274
InternalObject ...................................................................................................................... 2275
Ansys.ACT.Automation.Mechanical.Results.StressToolResults Namespace .................................. 2277
StressRatio .................................................................................................................................. 2277
DataModelObjectCategory ................................................................................................... 2281
InternalObject ...................................................................................................................... 2281
StressSafetyFactor ....................................................................................................................... 2281
DataModelObjectCategory ................................................................................................... 2285
InternalObject ...................................................................................................................... 2285
StressSafetyMargin ..................................................................................................................... 2286
DataModelObjectCategory ................................................................................................... 2289
InternalObject ...................................................................................................................... 2290
StressTool ................................................................................................................................... 2290
Children ............................................................................................................................... 2291
Comments ............................................................................................................................ 2291
CompressiveLimit ................................................................................................................. 2291

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxxvii
ACT API Reference Guide

CompressiveLimitType .......................................................................................................... 2291


DataModelObjectCategory ................................................................................................... 2291
Figures ................................................................................................................................. 2292
Images ................................................................................................................................. 2292
InternalObject ...................................................................................................................... 2292
LimitFactor ........................................................................................................................... 2292
StressLimit ............................................................................................................................ 2292
StressLimitType .................................................................................................................... 2292
TensileLimit .......................................................................................................................... 2293
TensileLimitType ................................................................................................................... 2293
Theory .................................................................................................................................. 2293
AddComment() ..................................................................................................................... 2293
AddFigure() .......................................................................................................................... 2293
AddImage(string) .................................................................................................................. 2293
AddSafetyFactor() ................................................................................................................. 2294
AddSafetyMargin() ................................................................................................................ 2294
AddStressRatio() ................................................................................................................... 2294
Delete() ................................................................................................................................ 2294
EvaluateAllResults() ............................................................................................................... 2294
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2295
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2295
StressToolResult .......................................................................................................................... 2295
AverageAcrossBodies ............................................................................................................ 2299
DataModelObjectCategory ................................................................................................... 2299
InternalObject ...................................................................................................................... 2300
Ansys.ACT.Automation.Mechanical.Results.ScriptableResults Namespace .................................. 2301
PythonResult .............................................................................................................................. 2301
By ......................................................................................................................................... 2302
Children ............................................................................................................................... 2302
Comments ............................................................................................................................ 2303
DataModelObjectCategory ................................................................................................... 2303
DisplayTime .......................................................................................................................... 2303
Figures ................................................................................................................................. 2303
Images ................................................................................................................................. 2303
InternalObject ...................................................................................................................... 2303
Location ............................................................................................................................... 2304
Mode .................................................................................................................................... 2304
AddComment() ..................................................................................................................... 2304
AddFigure() .......................................................................................................................... 2304
AddImage(string) .................................................................................................................. 2304
ClearGeneratedData() ........................................................................................................... 2305
Evaluate() ............................................................................................................................. 2305
EvaluateAllResults() ............................................................................................................... 2305
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 2305
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2306
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2306
ScriptDefinedResultFolder .......................................................................................................... 2307
Children ............................................................................................................................... 2307
Comments ............................................................................................................................ 2307
DataModelObjectCategory ................................................................................................... 2308
Figures ................................................................................................................................. 2308

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Images ................................................................................................................................. 2308


InternalObject ...................................................................................................................... 2308
AddComment() ..................................................................................................................... 2308
AddFigure() .......................................................................................................................... 2308
AddImage(string) .................................................................................................................. 2309
AddPythonResult() ................................................................................................................ 2309
EvaluateAllResults() ............................................................................................................... 2309
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2309
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2310
Ansys.ACT.Automation.Mechanical.Results.ResultTrackers Namespace ....................................... 2311
AddedMassTracker ...................................................................................................................... 2313
DataModelObjectCategory ................................................................................................... 2316
InternalObject ...................................................................................................................... 2316
ArtificialEnergyTracker ................................................................................................................ 2317
DataModelObjectCategory ................................................................................................... 2320
InternalObject ...................................................................................................................... 2320
CampbellDiagram ....................................................................................................................... 2320
CriticalSpeed ........................................................................................................................ 2324
DataModelObjectCategory ................................................................................................... 2324
InternalObject ...................................................................................................................... 2324
Ratio ..................................................................................................................................... 2324
RotationalVelocitySelection .................................................................................................. 2324
Sorting ................................................................................................................................. 2324
XAxisLabel ............................................................................................................................ 2325
XAxisMaximum ..................................................................................................................... 2325
XAxisMinimum ..................................................................................................................... 2325
XAxisRange .......................................................................................................................... 2325
YAxisData ............................................................................................................................. 2325
YAxisLabel ............................................................................................................................ 2325
YAxisMaximum ..................................................................................................................... 2326
YAxisMinimum ...................................................................................................................... 2326
YAxisRange ........................................................................................................................... 2326
ContactChatteringTracker ........................................................................................................... 2326
ContactRegion ...................................................................................................................... 2329
ContactSide .......................................................................................................................... 2329
DataModelObjectCategory ................................................................................................... 2330
InternalObject ...................................................................................................................... 2330
ContactClosedPenetrationTracker ............................................................................................... 2330
ContactRegion ...................................................................................................................... 2333
DataModelObjectCategory ................................................................................................... 2333
InternalObject ...................................................................................................................... 2333
ContactDepthTracker .................................................................................................................. 2334
ContactRegion ...................................................................................................................... 2337
DataModelObjectCategory ................................................................................................... 2337
InternalObject ...................................................................................................................... 2337
ContactElasticSlipTracker ............................................................................................................ 2337
ContactRegion ...................................................................................................................... 2340
ContactSide .......................................................................................................................... 2341
DataModelObjectCategory ................................................................................................... 2341
InternalObject ...................................................................................................................... 2341
ContactEnergyTracker ................................................................................................................. 2341

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxxix
ACT API Reference Guide

ContactRegion ...................................................................................................................... 2344


DataModelObjectCategory ................................................................................................... 2344
InternalObject ...................................................................................................................... 2345
ContactFluidPressureTracker ....................................................................................................... 2345
ContactRegion ...................................................................................................................... 2348
ContactSide .......................................................................................................................... 2348
DataModelObjectCategory ................................................................................................... 2348
InternalObject ...................................................................................................................... 2348
ContactForceTracker ................................................................................................................... 2349
ContactRegion ...................................................................................................................... 2352
ContactSide .......................................................................................................................... 2352
DataModelObjectCategory ................................................................................................... 2352
InternalObject ...................................................................................................................... 2352
ContactFrictionalDissipationEnergyTracker .................................................................................. 2352
ContactRegion ...................................................................................................................... 2356
DataModelObjectCategory ................................................................................................... 2356
InternalObject ...................................................................................................................... 2356
ContactFrictionalStressTracker .................................................................................................... 2356
ContactRegion ...................................................................................................................... 2359
ContactSide .......................................................................................................................... 2359
DataModelObjectCategory ................................................................................................... 2360
InternalObject ...................................................................................................................... 2360
ContactGapTracker ..................................................................................................................... 2360
ContactRegion ...................................................................................................................... 2363
ContactSide .......................................................................................................................... 2363
DataModelObjectCategory ................................................................................................... 2363
InternalObject ...................................................................................................................... 2364
ContactHeatFluxTracker .............................................................................................................. 2364
ContactRegion ...................................................................................................................... 2367
DataModelObjectCategory ................................................................................................... 2367
InternalObject ...................................................................................................................... 2367
ContactingAreaTracker ............................................................................................................... 2367
ContactRegion ...................................................................................................................... 2371
ContactSide .......................................................................................................................... 2371
DataModelObjectCategory ................................................................................................... 2371
InternalObject ...................................................................................................................... 2371
ContactMaximumDampingPressureTracker ................................................................................. 2371
ContactRegion ...................................................................................................................... 2374
ContactSide .......................................................................................................................... 2375
DataModelObjectCategory ................................................................................................... 2375
InternalObject ...................................................................................................................... 2375
ContactMaximumGeometricSlidingDistanceTracker .................................................................... 2375
ContactRegion ...................................................................................................................... 2378
ContactSide .......................................................................................................................... 2378
DataModelObjectCategory ................................................................................................... 2379
InternalObject ...................................................................................................................... 2379
ContactMaximumNormalStiffnessTracker .................................................................................... 2379
ContactRegion ...................................................................................................................... 2382
ContactSide .......................................................................................................................... 2382
DataModelObjectCategory ................................................................................................... 2382
InternalObject ...................................................................................................................... 2383

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxxx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

ContactMaximumTangentialStiffnessTracker ............................................................................... 2383


ContactRegion ...................................................................................................................... 2386
ContactSide .......................................................................................................................... 2386
DataModelObjectCategory ................................................................................................... 2386
InternalObject ...................................................................................................................... 2386
ContactMaxTangentialFluidPressureTracker ................................................................................. 2387
ContactRegion ...................................................................................................................... 2390
DataModelObjectCategory ................................................................................................... 2390
InternalObject ...................................................................................................................... 2390
ContactMinimumGeometricSlidingDistanceTracker ..................................................................... 2390
ContactRegion ...................................................................................................................... 2393
ContactSide .......................................................................................................................... 2394
DataModelObjectCategory ................................................................................................... 2394
InternalObject ...................................................................................................................... 2394
ContactMinimumNormalStiffnessTracker .................................................................................... 2394
ContactRegion ...................................................................................................................... 2397
DataModelObjectCategory ................................................................................................... 2397
InternalObject ...................................................................................................................... 2398
ContactMinimumTangentialStiffnessTracker ................................................................................ 2398
ContactRegion ...................................................................................................................... 2401
ContactSide .......................................................................................................................... 2401
DataModelObjectCategory ................................................................................................... 2401
InternalObject ...................................................................................................................... 2401
ContactNumberStickingTracker ................................................................................................... 2402
ContactRegion ...................................................................................................................... 2405
ContactSide .......................................................................................................................... 2405
DataModelObjectCategory ................................................................................................... 2405
InternalObject ...................................................................................................................... 2405
ContactNumberWithLargePenetrationTracker ............................................................................. 2405
ContactRegion ...................................................................................................................... 2409
DataModelObjectCategory ................................................................................................... 2409
InternalObject ...................................................................................................................... 2409
ContactNumberWithTooMuchSlidingTracker ............................................................................... 2409
ContactRegion ...................................................................................................................... 2412
DataModelObjectCategory ................................................................................................... 2412
InternalObject ...................................................................................................................... 2413
ContactPairForceConvergenceNormTracker ................................................................................. 2413
ContactRegion ...................................................................................................................... 2416
DataModelObjectCategory ................................................................................................... 2416
InternalObject ...................................................................................................................... 2416
ContactPenetrationTracker .......................................................................................................... 2416
ContactRegion ...................................................................................................................... 2420
ContactSide .......................................................................................................................... 2420
DataModelObjectCategory ................................................................................................... 2420
InternalObject ...................................................................................................................... 2420
ContactPressureTracker ............................................................................................................... 2420
ContactRegion ...................................................................................................................... 2423
ContactSide .......................................................................................................................... 2424
DataModelObjectCategory ................................................................................................... 2424
InternalObject ...................................................................................................................... 2424
ContactResultingPinballTracker ................................................................................................... 2424

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxxxi
ACT API Reference Guide

ContactRegion ...................................................................................................................... 2427


ContactSide .......................................................................................................................... 2427
DataModelObjectCategory ................................................................................................... 2428
InternalObject ...................................................................................................................... 2428
ContactSlidingDistanceTracker .................................................................................................... 2428
ContactRegion ...................................................................................................................... 2431
ContactSide .......................................................................................................................... 2431
DataModelObjectCategory ................................................................................................... 2431
InternalObject ...................................................................................................................... 2432
ContactSlidingIndicationTracker .................................................................................................. 2432
ContactRegion ...................................................................................................................... 2435
DataModelObjectCategory ................................................................................................... 2435
InternalObject ...................................................................................................................... 2435
ContactStabilizationEnergyTracker .............................................................................................. 2435
ContactRegion ...................................................................................................................... 2439
DataModelObjectCategory ................................................................................................... 2439
InternalObject ...................................................................................................................... 2439
ContactStrainEnergyTracker ........................................................................................................ 2439
ContactRegion ...................................................................................................................... 2442
DataModelObjectCategory ................................................................................................... 2442
InternalObject ...................................................................................................................... 2443
ContactTangentialDampingStressTracker .................................................................................... 2443
ContactRegion ...................................................................................................................... 2446
DataModelObjectCategory ................................................................................................... 2446
InternalObject ...................................................................................................................... 2446
ContactTotalForceFromContactPressureXTracker ......................................................................... 2446
ContactRegion ...................................................................................................................... 2450
DataModelObjectCategory ................................................................................................... 2450
InternalObject ...................................................................................................................... 2450
ContactTotalForceFromContactPressureYTracker ......................................................................... 2450
ContactRegion ...................................................................................................................... 2453
DataModelObjectCategory ................................................................................................... 2453
InternalObject ...................................................................................................................... 2454
ContactTotalForceFromContactPressureZTracker ......................................................................... 2454
ContactRegion ...................................................................................................................... 2457
DataModelObjectCategory ................................................................................................... 2457
InternalObject ...................................................................................................................... 2457
ContactTotalForceFromTangentialStressXTracker ......................................................................... 2457
ContactRegion ...................................................................................................................... 2461
DataModelObjectCategory ................................................................................................... 2461
InternalObject ...................................................................................................................... 2461
ContactTotalForceFromTangentialStressYTracker ......................................................................... 2461
ContactRegion ...................................................................................................................... 2464
DataModelObjectCategory ................................................................................................... 2464
InternalObject ...................................................................................................................... 2465
ContactTotalForceFromTangentialStressZTracker ......................................................................... 2465
ContactRegion ...................................................................................................................... 2468
DataModelObjectCategory ................................................................................................... 2468
InternalObject ...................................................................................................................... 2468
ContactVolumeLossDueToWearTracker ....................................................................................... 2468
ContactRegion ...................................................................................................................... 2472

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxxxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

DataModelObjectCategory ................................................................................................... 2472


InternalObject ...................................................................................................................... 2472
DampingEnergyTracker .............................................................................................................. 2472
DataModelObjectCategory ................................................................................................... 2475
InternalObject ...................................................................................................................... 2475
DensityTracker ............................................................................................................................ 2476
DataModelObjectCategory ................................................................................................... 2479
InternalObject ...................................................................................................................... 2479
LocationCoordinateSystem ................................................................................................... 2479
LocationMethod ................................................................................................................... 2479
LocationXCoordinate ............................................................................................................ 2480
LocationYCoordinate ............................................................................................................ 2480
LocationZCoordinate ............................................................................................................ 2480
DirectionalAccelerationTracker .................................................................................................... 2480
DataModelObjectCategory ................................................................................................... 2483
InternalObject ...................................................................................................................... 2484
LocationCoordinateSystem ................................................................................................... 2484
LocationMethod ................................................................................................................... 2484
LocationXCoordinate ............................................................................................................ 2484
LocationYCoordinate ............................................................................................................ 2484
LocationZCoordinate ............................................................................................................ 2484
DirectionalDeformationTracker ................................................................................................... 2485
DataModelObjectCategory ................................................................................................... 2488
InternalObject ...................................................................................................................... 2488
LocationCoordinateSystem ................................................................................................... 2488
LocationMethod ................................................................................................................... 2488
LocationXCoordinate ............................................................................................................ 2488
LocationYCoordinate ............................................................................................................ 2489
LocationZCoordinate ............................................................................................................ 2489
DirectionalVelocityTracker ........................................................................................................... 2489
DataModelObjectCategory ................................................................................................... 2492
InternalObject ...................................................................................................................... 2492
LocationCoordinateSystem ................................................................................................... 2493
LocationMethod ................................................................................................................... 2493
LocationXCoordinate ............................................................................................................ 2493
LocationYCoordinate ............................................................................................................ 2493
LocationZCoordinate ............................................................................................................ 2493
EffectiveStrainTracker ................................................................................................................. 2493
DataModelObjectCategory ................................................................................................... 2497
InternalObject ...................................................................................................................... 2497
LocationCoordinateSystem ................................................................................................... 2497
LocationMethod ................................................................................................................... 2497
LocationXCoordinate ............................................................................................................ 2497
LocationYCoordinate ............................................................................................................ 2498
LocationZCoordinate ............................................................................................................ 2498
EffectiveStressTracker ................................................................................................................. 2498
DataModelObjectCategory ................................................................................................... 2501
InternalObject ...................................................................................................................... 2501
LocationCoordinateSystem ................................................................................................... 2501
LocationMethod ................................................................................................................... 2502
LocationXCoordinate ............................................................................................................ 2502

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxxxiii
ACT API Reference Guide

LocationYCoordinate ............................................................................................................ 2502


LocationZCoordinate ............................................................................................................ 2502
ErodedInternalEnergyTracker ...................................................................................................... 2502
DataModelObjectCategory ................................................................................................... 2505
InternalObject ...................................................................................................................... 2506
ErodedKineticEnergyTracker ....................................................................................................... 2506
DataModelObjectCategory ................................................................................................... 2509
InternalObject ...................................................................................................................... 2509
ExternalForceTracker ................................................................................................................... 2509
DataModelObjectCategory ................................................................................................... 2512
InternalObject ...................................................................................................................... 2513
ForceReactionTracker .................................................................................................................. 2513
DataModelObjectCategory ................................................................................................... 2516
ForceComponentMethod ...................................................................................................... 2516
InternalObject ...................................................................................................................... 2516
LocationCoordinateSystem ................................................................................................... 2517
LocationMethod ................................................................................................................... 2517
LocationXCoordinate ............................................................................................................ 2517
LocationYCoordinate ............................................................................................................ 2517
LocationZCoordinate ............................................................................................................ 2517
HourglassEnergyTracker .............................................................................................................. 2517
ContactRegion ...................................................................................................................... 2521
DataModelObjectCategory ................................................................................................... 2521
InternalObject ...................................................................................................................... 2521
InternalEnergyTracker ................................................................................................................. 2521
DataModelObjectCategory ................................................................................................... 2524
InternalObject ...................................................................................................................... 2525
LocationCoordinateSystem ................................................................................................... 2525
LocationMethod ................................................................................................................... 2525
LocationXCoordinate ............................................................................................................ 2525
LocationYCoordinate ............................................................................................................ 2525
LocationZCoordinate ............................................................................................................ 2525
KineticEnergyTracker .................................................................................................................. 2526
DataModelObjectCategory ................................................................................................... 2529
InternalObject ...................................................................................................................... 2529
LSDYNAGeneralTracker ............................................................................................................... 2529
ACTLoad ............................................................................................................................... 2532
ContactRegion ...................................................................................................................... 2533
ContactSide .......................................................................................................................... 2533
DataModelObjectCategory ................................................................................................... 2533
InternalObject ...................................................................................................................... 2533
Joint ..................................................................................................................................... 2533
LSDYNABranchName ............................................................................................................ 2533
LSDYNAComponentName ..................................................................................................... 2534
LSDYNASubBranchName ...................................................................................................... 2534
GetBranches() ....................................................................................................................... 2534
GetComponents(string) ........................................................................................................ 2534
MomentReactionTracker ............................................................................................................. 2534
DataModelObjectCategory ................................................................................................... 2538
InternalObject ...................................................................................................................... 2538
MomentumTracker ..................................................................................................................... 2538

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxxxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

DataModelObjectCategory ................................................................................................... 2541


InternalObject ...................................................................................................................... 2541
NonLinearStabilizationEnergyTracker .......................................................................................... 2541
DataModelObjectCategory ................................................................................................... 2545
InternalObject ...................................................................................................................... 2545
NumberContactingTracker .......................................................................................................... 2545
ContactRegion ...................................................................................................................... 2548
ContactSide .......................................................................................................................... 2548
DataModelObjectCategory ................................................................................................... 2548
InternalObject ...................................................................................................................... 2549
PlasticWorkTracker ...................................................................................................................... 2549
DataModelObjectCategory ................................................................................................... 2552
InternalObject ...................................................................................................................... 2552
PositionTracker ........................................................................................................................... 2552
DataModelObjectCategory ................................................................................................... 2555
InternalObject ...................................................................................................................... 2556
LocationCoordinateSystem ................................................................................................... 2556
LocationMethod ................................................................................................................... 2556
LocationXCoordinate ............................................................................................................ 2556
LocationYCoordinate ............................................................................................................ 2556
LocationZCoordinate ............................................................................................................ 2556
PressureTracker ........................................................................................................................... 2557
DataModelObjectCategory ................................................................................................... 2560
InternalObject ...................................................................................................................... 2560
LocationCoordinateSystem ................................................................................................... 2560
LocationMethod ................................................................................................................... 2560
LocationXCoordinate ............................................................................................................ 2561
LocationYCoordinate ............................................................................................................ 2561
LocationZCoordinate ............................................................................................................ 2561
RigidBodyVelocityTracker ............................................................................................................ 2561
DataModelObjectCategory ................................................................................................... 2564
InternalObject ...................................................................................................................... 2564
SpringDampingForceTracker ....................................................................................................... 2565
DataModelObjectCategory ................................................................................................... 2568
InternalObject ...................................................................................................................... 2568
SpringElasticForceTracker ........................................................................................................... 2568
DataModelObjectCategory ................................................................................................... 2571
InternalObject ...................................................................................................................... 2571
SpringElongationTracker ............................................................................................................. 2571
DataModelObjectCategory ................................................................................................... 2575
InternalObject ...................................................................................................................... 2575
SpringVelocityTracker ................................................................................................................. 2575
DataModelObjectCategory ................................................................................................... 2578
InternalObject ...................................................................................................................... 2578
StiffnessEnergyTracker ................................................................................................................ 2578
DataModelObjectCategory ................................................................................................... 2582
InternalObject ...................................................................................................................... 2582
TemperatureTracker .................................................................................................................... 2582
DataModelObjectCategory ................................................................................................... 2585
InternalObject ...................................................................................................................... 2585
LocationCoordinateSystem ................................................................................................... 2586

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxxxv
ACT API Reference Guide

LocationMethod ................................................................................................................... 2586


LocationXCoordinate ............................................................................................................ 2586
LocationYCoordinate ............................................................................................................ 2586
LocationZCoordinate ............................................................................................................ 2586
ScopingMethod .................................................................................................................... 2586
TotalEnergyTracker ..................................................................................................................... 2587
DataModelObjectCategory ................................................................................................... 2590
InternalObject ...................................................................................................................... 2590
TotalMassAverageVelocityTracker ................................................................................................ 2590
DataModelObjectCategory ................................................................................................... 2593
InternalObject ...................................................................................................................... 2593
Ansys.ACT.Automation.Mechanical.Results.ProbeResults Namespace ......................................... 2595
AccelerationProbe ...................................................................................................................... 2596
DataModelObjectCategory ................................................................................................... 2599
InternalObject ...................................................................................................................... 2599
AngularAccelerationProbe .......................................................................................................... 2599
DataModelObjectCategory ................................................................................................... 2602
InternalObject ...................................................................................................................... 2603
AngularVelocityProbe ................................................................................................................. 2603
DataModelObjectCategory ................................................................................................... 2606
InternalObject ...................................................................................................................... 2606
BeamProbe ................................................................................................................................. 2606
AxialForce ............................................................................................................................. 2609
DataModelObjectCategory ................................................................................................... 2610
InternalObject ...................................................................................................................... 2610
MaximumAxialForce ............................................................................................................. 2610
MaximumMomentAtI ............................................................................................................ 2610
MaximumMomentAtJ ........................................................................................................... 2610
MaximumShearForceAtI ........................................................................................................ 2610
MaximumShearForceAtJ ....................................................................................................... 2611
MaximumTorque .................................................................................................................. 2611
MinimumAxialForce .............................................................................................................. 2611
MinimumMomentAtI ............................................................................................................ 2611
MinimumMomentAtJ ............................................................................................................ 2611
MinimumShearForceAtI ........................................................................................................ 2611
MinimumShearForceAtJ ........................................................................................................ 2612
MinimumTorque ................................................................................................................... 2612
MomentAtI ........................................................................................................................... 2612
MomentAtJ ........................................................................................................................... 2612
ShearForceAtI ....................................................................................................................... 2612
ShearForceAtJ ....................................................................................................................... 2612
Torque .................................................................................................................................. 2613
BearingProbe .............................................................................................................................. 2613
By ......................................................................................................................................... 2616
DampingForce1 .................................................................................................................... 2617
DampingForce2 .................................................................................................................... 2617
DataModelObjectCategory ................................................................................................... 2617
ElasticForce1 ......................................................................................................................... 2617
ElasticForce2 ......................................................................................................................... 2617
Elongation1 .......................................................................................................................... 2617
Elongation2 .......................................................................................................................... 2618

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxxxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

InternalObject ...................................................................................................................... 2618


MaximumDampingForce1 .................................................................................................... 2618
MaximumDampingForce2 .................................................................................................... 2618
MaximumElasticForce1 ......................................................................................................... 2618
MaximumElasticForce2 ......................................................................................................... 2618
MaximumElongation1 .......................................................................................................... 2619
MaximumElongation2 .......................................................................................................... 2619
MaximumVelocity1 ............................................................................................................... 2619
MaximumVelocity2 ............................................................................................................... 2619
MinimumDampingForce1 ..................................................................................................... 2619
MinimumDampingForce2 ..................................................................................................... 2619
MinimumElasticForce1 .......................................................................................................... 2620
MinimumElasticForce2 .......................................................................................................... 2620
MinimumElongation1 ........................................................................................................... 2620
MinimumElongation2 ........................................................................................................... 2620
MinimumVelocity1 ................................................................................................................ 2620
MinimumVelocity2 ................................................................................................................ 2620
PhaseIncrement .................................................................................................................... 2621
ReportedFrequency .............................................................................................................. 2621
ScaleFactor ........................................................................................................................... 2621
ScaleFactorValue ................................................................................................................... 2621
SweepingPhase .................................................................................................................... 2621
Velocity1 .............................................................................................................................. 2621
Velocity2 .............................................................................................................................. 2622
BoltPretensionProbe ................................................................................................................... 2622
Adjustment .......................................................................................................................... 2625
DataModelObjectCategory ................................................................................................... 2625
InternalObject ...................................................................................................................... 2625
MaximumAdjustment ........................................................................................................... 2625
MaximumWorkingLoad ......................................................................................................... 2626
MinimumAdjustment ............................................................................................................ 2626
MinimumWorkingLoad ......................................................................................................... 2626
ScaleFactor ........................................................................................................................... 2626
ScaleFactorValue ................................................................................................................... 2626
WorkingLoad ........................................................................................................................ 2626
ChargeReactionProbe ................................................................................................................. 2627
By ......................................................................................................................................... 2630
ChargeReactionImag ............................................................................................................ 2630
ChargeReactionReal .............................................................................................................. 2630
DataModelObjectCategory ................................................................................................... 2630
Frequency ............................................................................................................................ 2630
InternalObject ...................................................................................................................... 2631
MaximumImagChargeReaction ............................................................................................. 2631
MaximumRealChargeReaction .............................................................................................. 2631
MinimumImagChargeReaction ............................................................................................. 2631
MinimumRealChargeReaction ............................................................................................... 2631
ReportedFrequency .............................................................................................................. 2631
SetNumber ........................................................................................................................... 2632
SweepingPhase .................................................................................................................... 2632
ContactDistanceProbe ................................................................................................................ 2632
DataModelObjectCategory ................................................................................................... 2635

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxxxvii
ACT API Reference Guide

InternalObject ...................................................................................................................... 2635


MaximumValueOverTime ...................................................................................................... 2635
MinimumValueOverTime ...................................................................................................... 2635
Results .................................................................................................................................. 2636
CurrentDensityProbe .................................................................................................................. 2636
CurrentDensityTotal .............................................................................................................. 2639
DataModelObjectCategory ................................................................................................... 2639
InternalObject ...................................................................................................................... 2639
XAxisCurrentDensity ............................................................................................................. 2639
YAxisCurrentDensity ............................................................................................................. 2640
ZAxisCurrentDensity ............................................................................................................. 2640
DeformationProbe ...................................................................................................................... 2640
DataModelObjectCategory ................................................................................................... 2643
InternalObject ...................................................................................................................... 2643
MaximumTotalDeformation .................................................................................................. 2644
MaximumXAxisDeformation ................................................................................................. 2644
MaximumYAxisDeformation .................................................................................................. 2644
MaximumZAxisDeformation ................................................................................................. 2644
MinimumTotalDeformation ................................................................................................... 2644
MinimumXAxisDeformation .................................................................................................. 2644
MinimumYAxisDeformation .................................................................................................. 2645
MinimumZAxisDeformation .................................................................................................. 2645
TotalDeformation ................................................................................................................. 2645
XAxisDeformation ................................................................................................................. 2645
XCoordinate ......................................................................................................................... 2645
YAxisDeformation ................................................................................................................. 2645
YCoordinate .......................................................................................................................... 2646
ZAxisDeformation ................................................................................................................. 2646
ZCoordinate ......................................................................................................................... 2646
ElectricFieldProbe ....................................................................................................................... 2646
DataModelObjectCategory ................................................................................................... 2649
InternalObject ...................................................................................................................... 2649
Total ..................................................................................................................................... 2649
YAxisFieldIntensity ................................................................................................................ 2649
ZAxisFieldIntensity ................................................................................................................ 2650
ElectricVoltageProbe ................................................................................................................... 2650
DataModelObjectCategory ................................................................................................... 2653
InternalObject ...................................................................................................................... 2653
MaximumVoltageProbe ........................................................................................................ 2653
MinimumVoltageProbe ......................................................................................................... 2653
VoltageProbe ........................................................................................................................ 2653
ElectromechanicalCouplingCoefficient ........................................................................................ 2654
By ......................................................................................................................................... 2657
DataModelObjectCategory ................................................................................................... 2657
ElectromechanicalCouplingCoefficientValue ......................................................................... 2657
Frequency ............................................................................................................................ 2657
InternalObject ...................................................................................................................... 2658
MaximumElectromechanicalCouplingCoefficient .................................................................. 2658
MinimumElectromechanicalCouplingCoefficient ................................................................... 2658
ReportedFrequency .............................................................................................................. 2658
SetNumber ........................................................................................................................... 2658

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxxxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

SweepingPhase .................................................................................................................... 2658


EmagReactionProbe ................................................................................................................... 2659
Current ................................................................................................................................. 2662
DataModelObjectCategory ................................................................................................... 2662
InternalObject ...................................................................................................................... 2662
MaximumCurrent ................................................................................................................. 2662
MinimumCurrent .................................................................................................................. 2662
EnergyProbe ............................................................................................................................... 2662
By ......................................................................................................................................... 2666
ContactEnergy ...................................................................................................................... 2666
DampingEnergy .................................................................................................................... 2667
DataModelObjectCategory ................................................................................................... 2667
ExternalEnergy ..................................................................................................................... 2667
Frequency ............................................................................................................................ 2667
HourglassEnergy ................................................................................................................... 2667
InternalEnergy ...................................................................................................................... 2667
InternalObject ...................................................................................................................... 2668
KineticEnergy ....................................................................................................................... 2668
MagnetostaticCoEnergy ........................................................................................................ 2668
MaximumContactEnergy ...................................................................................................... 2668
MaximumDampingEnergy .................................................................................................... 2668
MaximumExternalEnergy ...................................................................................................... 2668
MaximumHourglassEnergy ................................................................................................... 2669
MaximumInternalEnergy ....................................................................................................... 2669
MaximumKineticEnergy ........................................................................................................ 2669
MaximumPlasticWork ........................................................................................................... 2669
MaximumPotentialEnergy ..................................................................................................... 2669
MaximumStrainEnergy .......................................................................................................... 2669
MaximumTotalEnergy ........................................................................................................... 2670
MaxMagnetostaticCoEnergyOverTime .................................................................................. 2670
MinimumContactEnergy ....................................................................................................... 2670
MinimumDampingEnergy ..................................................................................................... 2670
MinimumExternalEnergy ...................................................................................................... 2670
MinimumHourglassEnergy .................................................................................................... 2670
MinimumInternalEnergy ....................................................................................................... 2671
MinimumKineticEnergy ........................................................................................................ 2671
MinimumPlasticWork ............................................................................................................ 2671
MinimumPotentialEnergy ..................................................................................................... 2671
MinimumStrainEnergy .......................................................................................................... 2671
MinimumTotalEnergy ........................................................................................................... 2671
MinMagnetostaticCoEnergyOverTime ................................................................................... 2672
PlasticWork ........................................................................................................................... 2672
PotentialEnergy .................................................................................................................... 2672
ReportedFrequency .............................................................................................................. 2672
SetNumber ........................................................................................................................... 2672
StrainEnergy ......................................................................................................................... 2672
TotalEnergy .......................................................................................................................... 2673
FieldIntensityProbe ..................................................................................................................... 2673
DataModelObjectCategory ................................................................................................... 2676
InternalObject ...................................................................................................................... 2676
TotalFieldIntensity ................................................................................................................ 2676

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxxxix
ACT API Reference Guide

YAxisFieldIntensity ................................................................................................................ 2676


FlexibleRotationProbe ................................................................................................................. 2676
DataModelObjectCategory ................................................................................................... 2680
InternalObject ...................................................................................................................... 2680
MaximumXAxisRotation ........................................................................................................ 2680
MaximumYAxisRotation ........................................................................................................ 2680
MaximumZAxisRotation ........................................................................................................ 2680
MinimumXAxisRotation ........................................................................................................ 2680
MinimumYAxisRotation ......................................................................................................... 2681
MinimumZAxisRotation ........................................................................................................ 2681
XAxisRotation ....................................................................................................................... 2681
YAxisRotation ....................................................................................................................... 2681
ZAxisRotation ....................................................................................................................... 2681
FluxDensityProbe ....................................................................................................................... 2681
DataModelObjectCategory ................................................................................................... 2685
InternalObject ...................................................................................................................... 2685
Probability ............................................................................................................................ 2685
TotalFluxDensity ................................................................................................................... 2685
XAxisFluxDensity .................................................................................................................. 2685
XCoordinate ......................................................................................................................... 2685
YAxisFluxDensity ................................................................................................................... 2686
YCoordinate .......................................................................................................................... 2686
ZAxisFluxDensity .................................................................................................................. 2686
ZCoordinate ......................................................................................................................... 2686
ForceReaction ............................................................................................................................. 2686
Beam .................................................................................................................................... 2690
By ......................................................................................................................................... 2690
ContactForce ........................................................................................................................ 2690
DataModelObjectCategory ................................................................................................... 2690
Extraction ............................................................................................................................. 2690
Frequency ............................................................................................................................ 2690
InternalObject ...................................................................................................................... 2691
Mode .................................................................................................................................... 2691
PhaseIncrement .................................................................................................................... 2691
Probability ............................................................................................................................ 2691
Reference ............................................................................................................................. 2691
RemotePoints ....................................................................................................................... 2691
ReportedFrequency .............................................................................................................. 2692
ScaleFactor ........................................................................................................................... 2692
ScaleFactorValue ................................................................................................................... 2692
Spring .................................................................................................................................. 2692
SurfaceArea .......................................................................................................................... 2692
SweepingPhase .................................................................................................................... 2692
SymmetryMultiplier .............................................................................................................. 2693
ForceSummationProbe ............................................................................................................... 2693
DataModelObjectCategory ................................................................................................... 2696
InternalObject ...................................................................................................................... 2696
SymmetryMultiplier .............................................................................................................. 2696
GeneralizedPlaneStrainProbe ...................................................................................................... 2696
DataModelObjectCategory ................................................................................................... 2699
InternalObject ...................................................................................................................... 2699

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxl of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

HeatFluxProbe ............................................................................................................................ 2699


DataModelObjectCategory ................................................................................................... 2703
InternalObject ...................................................................................................................... 2703
MaximumTotalHeatFlux ........................................................................................................ 2703
MaximumXAxisHeatFlux ....................................................................................................... 2703
MaximumYAxisHeatFlux ........................................................................................................ 2703
MaximumZAxisHeatFlux ....................................................................................................... 2704
MinimumTotalHeatFlux ......................................................................................................... 2704
MinimumXAxisHeatFlux ........................................................................................................ 2704
MinimumYAxisHeatFlux ........................................................................................................ 2704
MinimumZAxisHeatFlux ........................................................................................................ 2704
TotalHeatFlux ....................................................................................................................... 2704
XAxisHeatFlux ....................................................................................................................... 2705
XCoordinate ......................................................................................................................... 2705
YAxisHeatFlux ....................................................................................................................... 2705
YCoordinate .......................................................................................................................... 2705
ZAxisHeatFlux ....................................................................................................................... 2705
ZCoordinate ......................................................................................................................... 2705
ImpedanceProbe ........................................................................................................................ 2706
By ......................................................................................................................................... 2709
DataModelObjectCategory ................................................................................................... 2709
Frequency ............................................................................................................................ 2709
ImpedanceImag ................................................................................................................... 2709
ImpedanceReal ..................................................................................................................... 2709
InternalObject ...................................................................................................................... 2710
MaximumImagImpedance .................................................................................................... 2710
MaximumRealImpedance ..................................................................................................... 2710
MinimumImagImpedance ..................................................................................................... 2710
MinimumRealImpedance ...................................................................................................... 2710
ReportedFrequency .............................................................................................................. 2710
SetNumber ........................................................................................................................... 2711
SweepingPhase .................................................................................................................... 2711
JointProbe .................................................................................................................................. 2711
DataModelObjectCategory ................................................................................................... 2714
InternalObject ...................................................................................................................... 2714
OrientationMethod ............................................................................................................... 2714
ResultType ............................................................................................................................ 2714
Status ................................................................................................................................... 2715
JouleHeatProbe .......................................................................................................................... 2715
By ......................................................................................................................................... 2718
DataModelObjectCategory ................................................................................................... 2718
Frequency ............................................................................................................................ 2718
InternalObject ...................................................................................................................... 2718
JouleHeat ............................................................................................................................. 2719
MaximumJouleHeat .............................................................................................................. 2719
MinimumJouleHeat .............................................................................................................. 2719
ReportedFrequency .............................................................................................................. 2719
SetNumber ........................................................................................................................... 2719
SweepingPhase .................................................................................................................... 2719
MagneticFluxProbe ..................................................................................................................... 2720
DataModelObjectCategory ................................................................................................... 2723

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxli
ACT API Reference Guide

InternalObject ...................................................................................................................... 2723


MagneticFlux ........................................................................................................................ 2723
MaximumMagneticFlux ........................................................................................................ 2723
MinimumMagneticFlux ......................................................................................................... 2723
SymmetryMultiplier .............................................................................................................. 2723
MomentReaction ........................................................................................................................ 2724
Beam .................................................................................................................................... 2727
By ......................................................................................................................................... 2727
ContactForce ........................................................................................................................ 2727
DataModelObjectCategory ................................................................................................... 2727
Extraction ............................................................................................................................. 2728
Frequency ............................................................................................................................ 2728
InternalObject ...................................................................................................................... 2728
Mode .................................................................................................................................... 2728
PhaseIncrement .................................................................................................................... 2728
Probability ............................................................................................................................ 2728
Reference ............................................................................................................................. 2729
RemotePoints ....................................................................................................................... 2729
ReportedFrequency .............................................................................................................. 2729
ScaleFactor ........................................................................................................................... 2729
ScaleFactorValue ................................................................................................................... 2729
SurfaceArea .......................................................................................................................... 2729
SweepingPhase .................................................................................................................... 2730
SymmetryMultiplier .............................................................................................................. 2730
Position ...................................................................................................................................... 2730
DataModelObjectCategory ................................................................................................... 2733
InternalObject ...................................................................................................................... 2733
QualityFactor .............................................................................................................................. 2733
By ......................................................................................................................................... 2736
DataModelObjectCategory ................................................................................................... 2736
Frequency ............................................................................................................................ 2737
InternalObject ...................................................................................................................... 2737
MaximumQualityFactor ......................................................................................................... 2737
MinimumQualityFactor ......................................................................................................... 2737
QualityFactorValue ................................................................................................................ 2737
ReportedFrequency .............................................................................................................. 2737
SetNumber ........................................................................................................................... 2738
SweepingPhase .................................................................................................................... 2738
RadiationProbe ........................................................................................................................... 2738
DataModelObjectCategory ................................................................................................... 2741
EmittedRadiation .................................................................................................................. 2741
IncidentRadiation ................................................................................................................. 2741
InternalObject ...................................................................................................................... 2741
NetRadiation ........................................................................................................................ 2742
ReflectedRadiation ............................................................................................................... 2742
ReactionProbe ............................................................................................................................ 2742
DataModelObjectCategory ................................................................................................... 2745
Extraction ............................................................................................................................. 2745
Heat ..................................................................................................................................... 2745
InternalObject ...................................................................................................................... 2746
MaximumHeat ...................................................................................................................... 2746

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxlii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

MinimumHeat ...................................................................................................................... 2746


ResponsePSD .............................................................................................................................. 2746
AccelerationInG .................................................................................................................... 2749
DataModelObjectCategory ................................................................................................... 2749
ExpectedFrequency .............................................................................................................. 2750
InternalObject ...................................................................................................................... 2750
Probability ............................................................................................................................ 2750
RangeMaximum ................................................................................................................... 2750
RangeMinimum .................................................................................................................... 2750
Reference ............................................................................................................................. 2750
ResultType ............................................................................................................................ 2751
RMSPercentage .................................................................................................................... 2751
RMSValue ............................................................................................................................. 2751
SelectedFrequencyRange ..................................................................................................... 2751
ResultProbe ................................................................................................................................ 2751
BeamSelection ...................................................................................................................... 2753
BoundaryConditionSelection ................................................................................................ 2753
Children ............................................................................................................................... 2753
Comments ............................................................................................................................ 2754
ContactRegionSelection ....................................................................................................... 2754
CoordinateSystemSelection .................................................................................................. 2754
DataModelObjectCategory ................................................................................................... 2754
DisplayTime .......................................................................................................................... 2754
DpfEvaluation ....................................................................................................................... 2754
Figures ................................................................................................................................. 2755
GeometryLocation ................................................................................................................ 2755
Images ................................................................................................................................. 2755
InternalObject ...................................................................................................................... 2755
IsSolved ................................................................................................................................ 2755
IterationNumber ................................................................................................................... 2755
LoadStep .............................................................................................................................. 2756
LoadStepNumber ................................................................................................................. 2756
LocationMethod ................................................................................................................... 2756
MaximumTotal ...................................................................................................................... 2756
MaximumXAxis ..................................................................................................................... 2756
MaximumYAxis ..................................................................................................................... 2756
MaximumZAxis ..................................................................................................................... 2757
MeshConnectionSelection .................................................................................................... 2757
MinimumTotal ...................................................................................................................... 2757
MinimumXAxis ..................................................................................................................... 2757
MinimumYAxis ...................................................................................................................... 2757
MinimumZAxis ..................................................................................................................... 2757
Orientation ........................................................................................................................... 2758
RemotePointSelection .......................................................................................................... 2758
ResultSelection ..................................................................................................................... 2758
RPMSelection ....................................................................................................................... 2758
SpatialResolution .................................................................................................................. 2758
SpringSelection .................................................................................................................... 2758
Substep ................................................................................................................................ 2759
Summation ........................................................................................................................... 2759
Suppressed ........................................................................................................................... 2759

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxliii
ACT API Reference Guide

SurfaceSelection ................................................................................................................... 2759


Time ..................................................................................................................................... 2759
Total ..................................................................................................................................... 2759
Type ..................................................................................................................................... 2760
XAxis .................................................................................................................................... 2760
YAxis ..................................................................................................................................... 2760
ZAxis .................................................................................................................................... 2760
AddComment() ..................................................................................................................... 2760
AddFigure() .......................................................................................................................... 2760
AddImage(string) .................................................................................................................. 2761
ClearGeneratedData() ........................................................................................................... 2761
Delete() ................................................................................................................................ 2761
DuplicateWithoutResults() .................................................................................................... 2761
EvaluateAllResults() ............................................................................................................... 2761
ExportAnimation(string, GraphicsAnimationExportFormat, AnimationExportSettings) ............ 2762
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2762
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2763
RenameBasedOnDefinition() ................................................................................................. 2763
SnapToMeshNodes() ............................................................................................................. 2763
RotationProbe ............................................................................................................................ 2763
DataModelObjectCategory ................................................................................................... 2767
InternalObject ...................................................................................................................... 2767
MaximumXAxisRotation ........................................................................................................ 2767
MaximumYAxisRotation ........................................................................................................ 2767
MaximumZAxisRotation ........................................................................................................ 2767
MinimumXAxisRotation ........................................................................................................ 2767
MinimumYAxisRotation ......................................................................................................... 2768
MinimumZAxisRotation ........................................................................................................ 2768
XAxisRotation ....................................................................................................................... 2768
YAxisRotation ....................................................................................................................... 2768
ZAxisRotation ....................................................................................................................... 2768
SpringProbe ............................................................................................................................... 2768
By ......................................................................................................................................... 2772
DampingForce ...................................................................................................................... 2772
DataModelObjectCategory ................................................................................................... 2772
ElasticForce .......................................................................................................................... 2772
Elongation ............................................................................................................................ 2773
Frequency ............................................................................................................................ 2773
InternalObject ...................................................................................................................... 2773
MaximumDampingForce ...................................................................................................... 2773
MaximumElasticForce ........................................................................................................... 2773
MaximumElongation ............................................................................................................ 2773
MaximumVelocity ................................................................................................................. 2774
MinimumDampingForce ....................................................................................................... 2774
MinimumElasticForce ............................................................................................................ 2774
MinimumElongation ............................................................................................................. 2774
MinimumVelocity ................................................................................................................. 2774
ScaleFactor ........................................................................................................................... 2774
ScaleFactorValue ................................................................................................................... 2775
Spring .................................................................................................................................. 2775
SweepingPhase .................................................................................................................... 2775

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxliv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Velocity ................................................................................................................................ 2775


StrainProbe ................................................................................................................................. 2775
DataModelObjectCategory ................................................................................................... 2779
EquivalentStrain ................................................................................................................... 2779
InternalObject ...................................................................................................................... 2779
MaximumEquivalentStrain .................................................................................................... 2780
MaximumMaximumPrincipalStrain ........................................................................................ 2780
MaximumMiddlePrincipalStrain ............................................................................................ 2780
MaximumMinimumPrincipalStrain ........................................................................................ 2780
MaximumNormalXAxisStrain ................................................................................................ 2780
MaximumNormalYAxisStrain ................................................................................................. 2780
MaximumNormalZAxisStrain ................................................................................................. 2781
MaximumPrincipalStrain ....................................................................................................... 2781
MaximumStrainIntensity ....................................................................................................... 2781
MaximumXYShearStrain ....................................................................................................... 2781
MaximumXZShearStrain ....................................................................................................... 2781
MaximumYZShearStrain ........................................................................................................ 2781
MiddlePrincipalStrain ............................................................................................................ 2782
MinimumEquivalentStrain ..................................................................................................... 2782
MinimumMiddlePrincipalStrain ............................................................................................. 2782
MinimumMinimumPrincipalStrain ......................................................................................... 2782
MinimumNormalXAxisStrain ................................................................................................. 2782
MinimumNormalYAxisStrain ................................................................................................. 2782
MinimumNormalZAxisStrain ................................................................................................. 2783
MinimumPrincipalStrain ....................................................................................................... 2783
MinimumStrain ..................................................................................................................... 2783
MinimumStrainIntensity ....................................................................................................... 2783
MinimumStrainMaximumPrincipal ........................................................................................ 2783
MinimumXYShearStrain ........................................................................................................ 2783
MinimumXZShearStrain ........................................................................................................ 2784
MinimumYZShearStrain ........................................................................................................ 2784
NormalXAxisStrain ................................................................................................................ 2784
NormalYAxisStrain ................................................................................................................ 2784
NormalZAxisStrain ................................................................................................................ 2784
Strain .................................................................................................................................... 2784
StrainIntensity ...................................................................................................................... 2785
XYShearStrain ....................................................................................................................... 2785
XZShearStrain ....................................................................................................................... 2785
YZShearStrain ....................................................................................................................... 2785
StressProbe ................................................................................................................................ 2785
DataModelObjectCategory ................................................................................................... 2789
EquivalentStress ................................................................................................................... 2789
InternalObject ...................................................................................................................... 2789
MaximumEquivalentStress .................................................................................................... 2790
MaximumMaximumPrincipalStress ....................................................................................... 2790
MaximumMiddlePrincipalStress ............................................................................................ 2790
MaximumMinimumPrincipalStress ........................................................................................ 2790
MaximumNormalXAxisStress ................................................................................................ 2790
MaximumNormalYAxisStress ................................................................................................. 2790
MaximumNormalZAxisStress ................................................................................................ 2791
MaximumPrincipalStress ....................................................................................................... 2791

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxlv
ACT API Reference Guide

MaximumStressIntensity ....................................................................................................... 2791


MaximumXYShearStress ....................................................................................................... 2791
MaximumXZShearStress ....................................................................................................... 2791
MaximumYZShearStress ....................................................................................................... 2791
MiddlePrincipalStress ............................................................................................................ 2792
MinimumEquivalentStress .................................................................................................... 2792
MinimumMaximumPrincipalStress ........................................................................................ 2792
MinimumMiddlePrincipalStress ............................................................................................. 2792
MinimumMinimumPrincipalStress ......................................................................................... 2792
MinimumNormalXAxisStress ................................................................................................. 2792
MinimumNormalYAxisStress ................................................................................................. 2793
MinimumNormalZAxisStress ................................................................................................. 2793
MinimumPrincipalStress ....................................................................................................... 2793
MinimumStressIntensity ....................................................................................................... 2793
MinimumXYShearStress ........................................................................................................ 2793
MinimumXZShearStress ........................................................................................................ 2793
MinimumYZShearStress ........................................................................................................ 2794
NormalXAxisStress ................................................................................................................ 2794
NormalYAxisStress ................................................................................................................ 2794
NormalZAxisStress ................................................................................................................ 2794
StressIntensity ...................................................................................................................... 2794
XCoordinate ......................................................................................................................... 2794
XYShearStress ....................................................................................................................... 2795
XZShearStress ....................................................................................................................... 2795
YCoordinate .......................................................................................................................... 2795
YZShearStress ....................................................................................................................... 2795
ZCoordinate ......................................................................................................................... 2795
TemperatureProbe ...................................................................................................................... 2795
DataModelObjectCategory ................................................................................................... 2799
InternalObject ...................................................................................................................... 2799
MaximumTemperature ......................................................................................................... 2799
MinimumTemperature .......................................................................................................... 2799
Temperature ......................................................................................................................... 2799
XCoordinate ......................................................................................................................... 2799
YCoordinate .......................................................................................................................... 2800
ZCoordinate ......................................................................................................................... 2800
TorqueProbe ............................................................................................................................... 2800
DataModelObjectCategory ................................................................................................... 2803
InternalObject ...................................................................................................................... 2803
SymmetryMultiplier .............................................................................................................. 2803
VelocityProbe ............................................................................................................................. 2803
DataModelObjectCategory ................................................................................................... 2806
InternalObject ...................................................................................................................... 2807
VolumeProbe .............................................................................................................................. 2807
DataModelObjectCategory ................................................................................................... 2810
InternalObject ...................................................................................................................... 2810
MaximumVolume ................................................................................................................. 2810
MinimumVolume .................................................................................................................. 2810
VolumeResult ....................................................................................................................... 2810
XCoordinate ......................................................................................................................... 2811
YCoordinate .......................................................................................................................... 2811

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxlvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

ZCoordinate ......................................................................................................................... 2811


Ansys.ACT.Automation.Mechanical.Results.FrequencyResponseResults Namespace .................. 2813
AccelerationFrequencyResponse ................................................................................................. 2814
DataModelObjectCategory ................................................................................................... 2817
InternalObject ...................................................................................................................... 2817
AccelerationWaterfallDiagram ..................................................................................................... 2817
DataModelObjectCategory ................................................................................................... 2821
InternalObject ...................................................................................................................... 2821
NormalOrientation ................................................................................................................ 2822
SpatialResolution .................................................................................................................. 2822
STFTCutoffFrequency ............................................................................................................ 2822
STFTEndTime ........................................................................................................................ 2822
STFTMinFreqResolution ........................................................................................................ 2822
STFTNumberSlice .................................................................................................................. 2822
STFTOverlap ......................................................................................................................... 2823
STFTStartTime ...................................................................................................................... 2823
STFTWindowType ................................................................................................................. 2823
AcousticAWeightedSPLFrequencyResponse ................................................................................ 2823
DataModelObjectCategory ................................................................................................... 2826
InternalObject ...................................................................................................................... 2826
AcousticKineticEnergyFrequencyResponse .................................................................................. 2827
DataModelObjectCategory ................................................................................................... 2830
InternalObject ...................................................................................................................... 2830
AcousticPotentialEnergyFrequencyResponse .............................................................................. 2830
DataModelObjectCategory ................................................................................................... 2833
InternalObject ...................................................................................................................... 2833
AcousticPressureFrequencyResponse .......................................................................................... 2834
DataModelObjectCategory ................................................................................................... 2837
InternalObject ...................................................................................................................... 2837
AcousticSPLFrequencyResponse ................................................................................................. 2837
DataModelObjectCategory ................................................................................................... 2840
InternalObject ...................................................................................................................... 2840
ExportToWAVFile(string) ........................................................................................................ 2841
ExportToXMLFile(string) ........................................................................................................ 2841
AcousticVelocityFrequencyResponse ........................................................................................... 2841
DataModelObjectCategory ................................................................................................... 2844
InternalObject ...................................................................................................................... 2844
ChargeReactionFrequencyResponse ........................................................................................... 2845
DataModelObjectCategory ................................................................................................... 2848
InternalObject ...................................................................................................................... 2848
LocationMethod ................................................................................................................... 2848
DeformationFrequencyResponse ................................................................................................ 2848
ContactRegion ...................................................................................................................... 2852
DataModelObjectCategory ................................................................................................... 2852
InternalObject ...................................................................................................................... 2852
ElasticStrainFrequencyResponse ................................................................................................. 2852
DataModelObjectCategory ................................................................................................... 2856
InternalObject ...................................................................................................................... 2856
EquivalentRadiatedPower ........................................................................................................... 2856
DataModelObjectCategory ................................................................................................... 2860
FrequencyRange ................................................................................................................... 2860

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxlvii
ACT API Reference Guide

InternalObject ...................................................................................................................... 2860


MaximumFrequency ............................................................................................................. 2860
MinimumFrequency ............................................................................................................. 2860
EquivalentRadiatedPowerLevel ................................................................................................... 2861
DataModelObjectCategory ................................................................................................... 2865
DBWeighting ........................................................................................................................ 2865
FrequencyRange ................................................................................................................... 2865
InternalObject ...................................................................................................................... 2865
MaximumFrequency ............................................................................................................. 2865
MinimumFrequency ............................................................................................................. 2865
ExportToWAVFile(string) ........................................................................................................ 2866
ExportToXMLFile(string) ........................................................................................................ 2866
EquivalentRadiatedPowerLevelWaterfallDiagram ......................................................................... 2866
DataModelObjectCategory ................................................................................................... 2870
DBWeighting ........................................................................................................................ 2870
InternalObject ...................................................................................................................... 2870
ExportToWAVFile(string) ........................................................................................................ 2871
ExportToXMLFile(string) ........................................................................................................ 2871
EquivalentRadiatedPowerWaterfallDiagram ................................................................................ 2871
DataModelObjectCategory ................................................................................................... 2875
InternalObject ...................................................................................................................... 2875
ForceReactionFrequencyResponse .............................................................................................. 2875
Beam .................................................................................................................................... 2879
ContactRegion ...................................................................................................................... 2879
DataModelObjectCategory ................................................................................................... 2879
InternalObject ...................................................................................................................... 2879
LocationMethod ................................................................................................................... 2879
RemotePoint ......................................................................................................................... 2880
FrequencyResponseResultChart .................................................................................................. 2880
CoordinateSystem ................................................................................................................ 2883
DataModelObjectCategory ................................................................................................... 2883
InternalObject ...................................................................................................................... 2883
RemotePointSelection .......................................................................................................... 2883
ImpedanceFrequencyResponse .................................................................................................. 2884
DataModelObjectCategory ................................................................................................... 2887
InternalObject ...................................................................................................................... 2887
LocationMethod ................................................................................................................... 2887
MCFWaterfallDiagram ................................................................................................................. 2887
DataModelObjectCategory ................................................................................................... 2891
InternalObject ...................................................................................................................... 2891
StressFrequencyResponse ........................................................................................................... 2892
DataModelObjectCategory ................................................................................................... 2895
InternalObject ...................................................................................................................... 2895
VelocityFrequencyResponse ........................................................................................................ 2895
ContactRegion ...................................................................................................................... 2899
DataModelObjectCategory ................................................................................................... 2899
InternalObject ...................................................................................................................... 2899
VelocityWaterfallDiagram ............................................................................................................ 2899
DataModelObjectCategory ................................................................................................... 2903
InternalObject ...................................................................................................................... 2903
NormalOrientation ................................................................................................................ 2903

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cxlviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

SpatialResolution .................................................................................................................. 2904


STFTCutoffFrequency ............................................................................................................ 2904
STFTEndTime ........................................................................................................................ 2904
STFTMinFreqResolution ........................................................................................................ 2904
STFTNumberSlice .................................................................................................................. 2904
STFTOverlap ......................................................................................................................... 2904
STFTStartTime ...................................................................................................................... 2905
STFTWindowType ................................................................................................................. 2905
VoltageFrequencyResponse ........................................................................................................ 2905
DataModelObjectCategory ................................................................................................... 2908
InternalObject ...................................................................................................................... 2908
Ansys.ACT.Automation.Mechanical.Results.FractureToolResults Namespace .............................. 2911
FractureCrackExtensionProbe ..................................................................................................... 2911
DataModelObjectCategory ................................................................................................... 2914
InternalObject ...................................................................................................................... 2914
MaximumValueOverTime ...................................................................................................... 2915
MinimumValueOverTime ...................................................................................................... 2915
ResultProbeValue .................................................................................................................. 2915
FractureEquivalentSIFSRangeProbe ............................................................................................. 2915
DataModelObjectCategory ................................................................................................... 2918
InternalObject ...................................................................................................................... 2918
MaximumValueOverTime ...................................................................................................... 2919
MinimumValueOverTime ...................................................................................................... 2919
ResultProbeValue .................................................................................................................. 2919
FractureJINTProbe ...................................................................................................................... 2919
DataModelObjectCategory ................................................................................................... 2922
InternalObject ...................................................................................................................... 2922
MaximumValueOverTime ...................................................................................................... 2923
MinimumValueOverTime ...................................................................................................... 2923
ResultProbeValue .................................................................................................................. 2923
FractureSIFSProbe ....................................................................................................................... 2923
DataModelObjectCategory ................................................................................................... 2926
FractureProbeSubType .......................................................................................................... 2926
InternalObject ...................................................................................................................... 2927
MaximumValueOverTime ...................................................................................................... 2927
MinimumValueOverTime ...................................................................................................... 2927
ResultProbeValue .................................................................................................................. 2927
FractureTool ............................................................................................................................... 2927
Children ............................................................................................................................... 2929
Comments ............................................................................................................................ 2929
CrackFrontNumber ............................................................................................................... 2929
CrackSelection ...................................................................................................................... 2929
CrackSelectionMode ............................................................................................................. 2929
DataModelObjectCategory ................................................................................................... 2930
Figures ................................................................................................................................. 2930
Images ................................................................................................................................. 2930
InternalObject ...................................................................................................................... 2930
MultipleCracksSelection ........................................................................................................ 2930
ScopingMethod .................................................................................................................... 2930
Suppressed ........................................................................................................................... 2931
AddComment() ..................................................................................................................... 2931

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cxlix
ACT API Reference Guide

AddCrackExtensionProbe() .................................................................................................... 2931


AddCStarIntegral() ................................................................................................................ 2931
AddEquivalentSIFSRange() .................................................................................................... 2931
AddEquivalentSIFSRangeProbe() ........................................................................................... 2931
AddFigure() .......................................................................................................................... 2932
AddImage(string) .................................................................................................................. 2932
AddJINT() .............................................................................................................................. 2932
AddJINTProbe() ..................................................................................................................... 2932
AddMaterialForceX() ............................................................................................................. 2932
AddMaterialForceY() ............................................................................................................. 2933
AddMaterialForceZ() ............................................................................................................. 2933
AddNumberOfCyclesProbe() ................................................................................................. 2933
AddSIFSK1() .......................................................................................................................... 2933
AddSIFSK1Probe() ................................................................................................................. 2933
AddSIFSK2() .......................................................................................................................... 2933
AddSIFSK2Probe() ................................................................................................................. 2934
AddSIFSK3() .......................................................................................................................... 2934
AddSIFSK3Probe() ................................................................................................................. 2934
AddTSTRESS() ....................................................................................................................... 2934
AddVCCTG1() ........................................................................................................................ 2934
AddVCCTG2() ........................................................................................................................ 2934
AddVCCTG3() ........................................................................................................................ 2935
AddVCCTGT() ........................................................................................................................ 2935
Delete() ................................................................................................................................ 2935
EvaluateAllResults() ............................................................................................................... 2935
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2935
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2936
FractureToolProbe ...................................................................................................................... 2936
ActiveContour ...................................................................................................................... 2939
CrackLengthPercentage ........................................................................................................ 2939
DataModelObjectCategory ................................................................................................... 2939
InternalObject ...................................................................................................................... 2940
SolverID ................................................................................................................................ 2940
FractureToolResult ...................................................................................................................... 2940
ActiveContour ...................................................................................................................... 2944
ActiveContourEnd ................................................................................................................ 2944
ActiveContourStart ............................................................................................................... 2944
DataModelObjectCategory ................................................................................................... 2944
FractureResultSubType ......................................................................................................... 2945
FractureResultType ............................................................................................................... 2945
InternalObject ...................................................................................................................... 2945
Mode .................................................................................................................................... 2945
SolverID ................................................................................................................................ 2945
FractureTotalNumberOfCyclesProbe ............................................................................................ 2945
DataModelObjectCategory ................................................................................................... 2949
InternalObject ...................................................................................................................... 2949
MaximumValueOverTime ...................................................................................................... 2949
MinimumValueOverTime ...................................................................................................... 2949
ResultProbeValue .................................................................................................................. 2949
Ansys.ACT.Automation.Mechanical.Results.CompositeFailureResults Namespace ...................... 2951
CompositeFailureCriteria ............................................................................................................. 2952

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cl of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Children ............................................................................................................................... 2953


Comments ............................................................................................................................ 2953
CoreFailure ........................................................................................................................... 2953
Cuntze .................................................................................................................................. 2953
DataModelObjectCategory ................................................................................................... 2954
FaceSheetWrinkling .............................................................................................................. 2954
Figures ................................................................................................................................. 2954
Hashin .................................................................................................................................. 2954
Hoffman ............................................................................................................................... 2954
Images ................................................................................................................................. 2954
InternalObject ...................................................................................................................... 2955
LaRC ..................................................................................................................................... 2955
MaximumStrain .................................................................................................................... 2955
MaximumStress .................................................................................................................... 2955
Puck ..................................................................................................................................... 2955
ShearCrimping ...................................................................................................................... 2955
TsaiHill .................................................................................................................................. 2956
TsaiWu .................................................................................................................................. 2956
VonMises .............................................................................................................................. 2956
AddComment() ..................................................................................................................... 2956
AddFigure() .......................................................................................................................... 2956
AddImage(string) .................................................................................................................. 2956
Delete() ................................................................................................................................ 2957
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2957
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2957
CompositeFailureCriterionSettings .............................................................................................. 2958
Active ................................................................................................................................... 2958
Reset() .................................................................................................................................. 2958
CompositeFailureTool ................................................................................................................. 2958
Children ............................................................................................................................... 2959
Comments ............................................................................................................................ 2959
DataModelObjectCategory ................................................................................................... 2960
Figures ................................................................................................................................. 2960
Images ................................................................................................................................. 2960
InternalObject ...................................................................................................................... 2960
AddComment() ..................................................................................................................... 2960
AddFigure() .......................................................................................................................... 2960
AddGroupedScopedACPResults(ResultType, IEnumerable<IDataModelObject>) .................... 2961
AddImage(string) .................................................................................................................. 2961
AddInverseReserveFactor() .................................................................................................... 2961
AddSafetyFactor() ................................................................................................................. 2962
AddSafetyMargin() ................................................................................................................ 2962
Delete() ................................................................................................................................ 2962
EvaluateAllResults() ............................................................................................................... 2962
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2962
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2963
CompositeSamplingPoint ........................................................................................................... 2963
Children ............................................................................................................................... 2964
Comments ............................................................................................................................ 2964
DataModelObjectCategory ................................................................................................... 2964
Figures ................................................................................................................................. 2964

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cli
ACT API Reference Guide

Images ................................................................................................................................. 2964


InternalObject ...................................................................................................................... 2965
Location ............................................................................................................................... 2965
AddComment() ..................................................................................................................... 2965
AddFigure() .......................................................................................................................... 2965
AddImage(string) .................................................................................................................. 2965
Delete() ................................................................................................................................ 2966
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2966
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2966
CompositeSamplingPointTool ..................................................................................................... 2967
Children ............................................................................................................................... 2967
Comments ............................................................................................................................ 2968
DataModelObjectCategory ................................................................................................... 2968
Figures ................................................................................................................................. 2968
Images ................................................................................................................................. 2968
InternalObject ...................................................................................................................... 2968
AddComment() ..................................................................................................................... 2968
AddCompositeSamplingPoint() ............................................................................................. 2969
AddFigure() .......................................................................................................................... 2969
AddImage(string) .................................................................................................................. 2969
Delete() ................................................................................................................................ 2969
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 2969
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 2970
CoreFailureSettings ..................................................................................................................... 2970
ConsiderInterlaminarNormalStresses ..................................................................................... 2971
WeightingFactor ................................................................................................................... 2971
CuntzeSettings ........................................................................................................................... 2971
EvaluateFiberCompressionFailure .......................................................................................... 2972
EvaluateFiberTensionFailure .................................................................................................. 2972
EvaluateMatrixCompressionFailure ........................................................................................ 2972
EvaluateMatrixTensionFailure ................................................................................................ 2973
EvaluateMatrixWedgeShapeFailure ....................................................................................... 2973
FailureDimension .................................................................................................................. 2973
FiberCompressionFailureWeightingFactor ............................................................................. 2973
FiberTensionFailureWeightingFactor ..................................................................................... 2973
FracturePlaneAngle .............................................................................................................. 2973
InPlaneShearFrictionCoefficient ............................................................................................ 2974
MatrixCompressionFailureWeightingFactor ........................................................................... 2974
MatrixTensionFailureWeightingFactor ................................................................................... 2974
MatrixWedgeShapeFailureWeightingFactor ........................................................................... 2974
ModeInteractionCoefficient .................................................................................................. 2974
OutOfPlaneShearFrictionCoefficient ...................................................................................... 2974
FaceSheetWrinklingSettings ........................................................................................................ 2975
HomogeneousCoreCoefficient .............................................................................................. 2975
HoneycombCoreCoefficient .................................................................................................. 2975
WeightingFactor ................................................................................................................... 2975
HashinSettings ........................................................................................................................... 2975
DelaminationWeightingFactor .............................................................................................. 2976
EvaluateDelamination ........................................................................................................... 2976
EvaluateFiberFailure .............................................................................................................. 2976
EvaluateMatrixFailure ............................................................................................................ 2977

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

FailureDimension .................................................................................................................. 2977


FiberFailureWeightingFactor ................................................................................................. 2977
MatrixFailureWeightingFactor ............................................................................................... 2977
HoffmanSettings ......................................................................................................................... 2977
FailureDimension .................................................................................................................. 2978
WeightingFactor ................................................................................................................... 2978
LaRCSettings .............................................................................................................................. 2978
EvaluateFiberCompressionFailure .......................................................................................... 2979
EvaluateFiberTensionFailure .................................................................................................. 2979
EvaluateMatrixCompressionFailure ........................................................................................ 2979
EvaluateMatrixTensionFailure ................................................................................................ 2979
FiberCompressionFailureWeightingFactor ............................................................................. 2979
FiberTensionFailureWeightingFactor ..................................................................................... 2980
Formulation .......................................................................................................................... 2980
MatrixCompressionFailureWeightingFactor ........................................................................... 2980
MatrixTensionFailureWeightingFactor ................................................................................... 2980
MaximumStrainSettings .............................................................................................................. 2980
CompressiveLimitMaterialOneDirection ................................................................................ 2982
CompressiveLimitMaterialThreeDirection .............................................................................. 2982
CompressiveLimitMaterialTwoDirection ................................................................................ 2982
EvaluateMaterialOneDirectionFailure .................................................................................... 2983
EvaluateMaterialThreeDirectionFailure .................................................................................. 2983
EvaluateMaterialTwoDirectionFailure .................................................................................... 2983
EvaluateShearOneThreeFailure .............................................................................................. 2983
EvaluateShearOneTwoFailure ................................................................................................ 2983
EvaluateShearTwoThreeFailure .............................................................................................. 2984
MaterialOneDirectionFailureWeightingFactor ........................................................................ 2984
MaterialThreeDirectionFailureWeightingFactor ...................................................................... 2984
MaterialTwoDirectionFailureWeightingFactor ........................................................................ 2984
OverrideMaterial ................................................................................................................... 2984
ShearLimitOneThree ............................................................................................................. 2984
ShearLimitOneTwo ............................................................................................................... 2985
ShearLimitTwoThree ............................................................................................................. 2985
ShearOneThreeFailureWeightingFactor ................................................................................. 2985
ShearOneTwoFailureWeightingFactor .................................................................................... 2985
ShearTwoThreeFailureWeightingFactor ................................................................................. 2985
TensileLimitMaterialOneDirection ......................................................................................... 2985
TensileLimitMaterialThreeDirection ....................................................................................... 2986
TensileLimitMaterialTwoDirection ......................................................................................... 2986
MaximumStressSettings .............................................................................................................. 2986
EvaluateMaterialOneDirectionFailure .................................................................................... 2987
EvaluateMaterialThreeDirectionFailure .................................................................................. 2987
EvaluateMaterialTwoDirectionFailure .................................................................................... 2987
EvaluateShearOneThreeFailure .............................................................................................. 2988
EvaluateShearOneTwoFailure ................................................................................................ 2988
EvaluateShearTwoThreeFailure .............................................................................................. 2988
MaterialOneDirectionFailureWeightingFactor ........................................................................ 2988
MaterialThreeDirectionFailureWeightingFactor ...................................................................... 2988
MaterialTwoDirectionFailureWeightingFactor ........................................................................ 2988
ShearOneThreeFailureWeightingFactor ................................................................................. 2989
ShearOneTwoFailureWeightingFactor .................................................................................... 2989

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. cliii
ACT API Reference Guide

ShearTwoThreeFailureWeightingFactor ................................................................................. 2989


PuckSettings ............................................................................................................................... 2989
ConsiderInterFiberParallelStresses ......................................................................................... 2990
DegradationInitiationFactor .................................................................................................. 2991
DegradationResidualStrengthFactor ...................................................................................... 2991
DelaminationWeightingFactor .............................................................................................. 2991
EvaluateDelamination ........................................................................................................... 2991
EvaluateFiberFailure .............................................................................................................. 2991
EvaluateMatrixCompressionFailure ........................................................................................ 2991
EvaluateMatrixShearFailure ................................................................................................... 2992
EvaluateMatrixTensionFailure ................................................................................................ 2992
FiberFailureWeightingFactor ................................................................................................. 2992
Formulation .......................................................................................................................... 2992
InclinationFactorTwoOneNegative ........................................................................................ 2992
InclinationFactorTwoOnePositive .......................................................................................... 2992
InclinationFactorTwoTwoNegative ........................................................................................ 2993
InclinationFactorTwoTwoPositive .......................................................................................... 2993
InterfaceWeakeningFactor .................................................................................................... 2993
MatrixCompressionFailureWeightingFactor ........................................................................... 2993
MatrixShearFailureWeightingFactor ....................................................................................... 2993
MatrixTensionFailureWeightingFactor ................................................................................... 2993
OverrideMaterial ................................................................................................................... 2994
ShearCrimpingSettings ............................................................................................................... 2994
CoreWeightingFactor ............................................................................................................ 2994
FaceSheetWeightingFactor ................................................................................................... 2994
WeightingFactor ................................................................................................................... 2994
TsaiHillSettings ........................................................................................................................... 2995
FailureDimension .................................................................................................................. 2995
WeightingFactor ................................................................................................................... 2995
TsaiWuSettings ........................................................................................................................... 2995
FailureDimension .................................................................................................................. 2996
WeightingFactor ................................................................................................................... 2996
VonMisesSettings ....................................................................................................................... 2996
ConsiderInterlaminarNormalStresses ..................................................................................... 2996
EvaluateStrainFailure ............................................................................................................. 2997
EvaluateStressFailure ............................................................................................................ 2997
StrainFailureWeightingFactor ................................................................................................ 2997
StressFailureWeightingFactor ................................................................................................ 2997
Ansys.ACT.Automation.Mechanical.Results.BoltToolResults Namespace ..................................... 2999
BoltAdjustment .......................................................................................................................... 2999
BoltResultType ...................................................................................................................... 3003
DataModelObjectCategory ................................................................................................... 3003
InternalObject ...................................................................................................................... 3003
BoltTool ...................................................................................................................................... 3003
Children ............................................................................................................................... 3004
Comments ............................................................................................................................ 3004
DataModelObjectCategory ................................................................................................... 3005
Figures ................................................................................................................................. 3005
Images ................................................................................................................................. 3005
InternalObject ...................................................................................................................... 3005
AddAdjustment() .................................................................................................................. 3005

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
cliv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

AddComment() ..................................................................................................................... 3005


AddFigure() .......................................................................................................................... 3006
AddImage(string) .................................................................................................................. 3006
AddWorkingLoad() ................................................................................................................ 3006
Delete() ................................................................................................................................ 3006
EvaluateAllResults() ............................................................................................................... 3006
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3007
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3007
BoltToolResult ............................................................................................................................ 3007
DataModelObjectCategory ................................................................................................... 3011
InternalObject ...................................................................................................................... 3011
BoltWorkingLoad ........................................................................................................................ 3012
BoltResultType ...................................................................................................................... 3015
DataModelObjectCategory ................................................................................................... 3016
InternalObject ...................................................................................................................... 3016
Ansys.ACT.Automation.Mechanical.Results.BeamToolResults Namespace .................................. 3017
BeamTool ................................................................................................................................... 3017
Children ............................................................................................................................... 3018
Comments ............................................................................................................................ 3018
DataModelObjectCategory ................................................................................................... 3018
Figures ................................................................................................................................. 3019
Images ................................................................................................................................. 3019
InternalObject ...................................................................................................................... 3019
Location ............................................................................................................................... 3019
AddComment() ..................................................................................................................... 3019
AddDirectionalDeformation() ................................................................................................ 3019
AddDirectStress() .................................................................................................................. 3020
AddFigure() .......................................................................................................................... 3020
AddImage(string) .................................................................................................................. 3020
AddMaximumBendingStress() ............................................................................................... 3020
AddMaximumCombinedStress() ............................................................................................ 3020
AddMinimumBendingStress() ............................................................................................... 3021
AddMinimumCombinedStress() ............................................................................................ 3021
AddTotalDeformation() ......................................................................................................... 3021
Delete() ................................................................................................................................ 3021
EvaluateAllResults() ............................................................................................................... 3021
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3021
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3022
BeamToolResult .......................................................................................................................... 3022
BeamToolStressResultType .................................................................................................... 3026
DataModelObjectCategory ................................................................................................... 3026
InternalObject ...................................................................................................................... 3026
DirectStress ................................................................................................................................ 3027
DataModelObjectCategory ................................................................................................... 3031
InternalObject ...................................................................................................................... 3031
MaximumBendingStress ............................................................................................................. 3031
DataModelObjectCategory ................................................................................................... 3035
InternalObject ...................................................................................................................... 3035
MaximumCombinedStress .......................................................................................................... 3035
DataModelObjectCategory ................................................................................................... 3039
InternalObject ...................................................................................................................... 3039

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clv
ACT API Reference Guide

MinimumBendingStress .............................................................................................................. 3039


DataModelObjectCategory ................................................................................................... 3043
InternalObject ...................................................................................................................... 3044
MinimumCombinedStress ........................................................................................................... 3044
DataModelObjectCategory ................................................................................................... 3048
InternalObject ...................................................................................................................... 3048
Ansys.ACT.Automation.Mechanical.Results.BeamResults Namespace ......................................... 3049
BeamResult ................................................................................................................................ 3049
BeamResultType ................................................................................................................... 3053
DataModelObjectCategory ................................................................................................... 3053
InternalObject ...................................................................................................................... 3054
DirectionalAxialForce .................................................................................................................. 3054
DataModelObjectCategory ................................................................................................... 3058
InternalObject ...................................................................................................................... 3058
DirectionalBendingMoment ........................................................................................................ 3058
DataModelObjectCategory ................................................................................................... 3062
InternalObject ...................................................................................................................... 3062
NormalOrientation ................................................................................................................ 3062
DirectionalShearForce ................................................................................................................. 3062
DataModelObjectCategory ................................................................................................... 3066
InternalObject ...................................................................................................................... 3067
DirectionalShearMomentDiagram ............................................................................................... 3067
DataModelObjectCategory ................................................................................................... 3071
GraphicsDisplay .................................................................................................................... 3071
InternalObject ...................................................................................................................... 3071
ShearMomentType ............................................................................................................... 3071
DirectionalTorsionalMoment ....................................................................................................... 3071
DataModelObjectCategory ................................................................................................... 3075
InternalObject ...................................................................................................................... 3075
TotalAxialForce ........................................................................................................................... 3076
DataModelObjectCategory ................................................................................................... 3079
InternalObject ...................................................................................................................... 3080
TotalBendingMoment ................................................................................................................. 3080
DataModelObjectCategory ................................................................................................... 3084
InternalObject ...................................................................................................................... 3084
TotalShearForce .......................................................................................................................... 3084
DataModelObjectCategory ................................................................................................... 3088
InternalObject ...................................................................................................................... 3088
NormalOrientation ................................................................................................................ 3088
TotalShearMomentDiagram ........................................................................................................ 3088
DataModelObjectCategory ................................................................................................... 3092
GraphicsDisplay .................................................................................................................... 3093
InternalObject ...................................................................................................................... 3093
ShearMomentType ............................................................................................................... 3093
TotalTorsionalMoment ................................................................................................................ 3093
DataModelObjectCategory ................................................................................................... 3097
InternalObject ...................................................................................................................... 3097
VectorAxialForce ......................................................................................................................... 3097
DataModelObjectCategory ................................................................................................... 3101
InternalObject ...................................................................................................................... 3101
VectorBendingMoment ............................................................................................................... 3101

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

DataModelObjectCategory ................................................................................................... 3105


InternalObject ...................................................................................................................... 3105
VectorShearForce ........................................................................................................................ 3106
DataModelObjectCategory ................................................................................................... 3109
InternalObject ...................................................................................................................... 3110
VectorTorsionalMoment .............................................................................................................. 3110
DataModelObjectCategory ................................................................................................... 3114
InternalObject ...................................................................................................................... 3114
Ansys.ACT.Automation.Mechanical.Results.AcousticResults Namespace ..................................... 3115
AcousticAbsorptionCoefficient .................................................................................................... 3115
DataModelObjectCategory ................................................................................................... 3120
FrequencyRange ................................................................................................................... 3120
InputPort .............................................................................................................................. 3120
InternalObject ...................................................................................................................... 3120
MaximumFrequency ............................................................................................................. 3121
MinimumFrequency ............................................................................................................. 3121
AcousticAWeightedSoundPressureLevel ...................................................................................... 3121
DataModelObjectCategory ................................................................................................... 3125
InternalObject ...................................................................................................................... 3126
AcousticDiffuseSoundTransmissionLoss ...................................................................................... 3126
DataModelObjectCategory ................................................................................................... 3130
FrequencyRange ................................................................................................................... 3130
InternalObject ...................................................................................................................... 3131
MaximumFrequency ............................................................................................................. 3131
MinimumFrequency ............................................................................................................. 3131
AcousticDirectionalVelocityResult ............................................................................................... 3131
DataModelObjectCategory ................................................................................................... 3136
InternalObject ...................................................................................................................... 3136
NormalOrientation ................................................................................................................ 3136
AcousticFarFieldResult ................................................................................................................ 3136
DampedFrequency ............................................................................................................... 3141
DataModelObjectCategory ................................................................................................... 3141
Density ................................................................................................................................. 3141
EndingRadiationAnglePhi ..................................................................................................... 3141
EndingRadiationAngleTheta ................................................................................................. 3141
FarFieldMicrophoneDefinitionMethod .................................................................................. 3142
Frequency ............................................................................................................................ 3142
InternalObject ...................................................................................................................... 3142
LogarithmicDecrement ......................................................................................................... 3142
ModalDampingRatio ............................................................................................................. 3142
ModelThicknessInZDirection ................................................................................................. 3142
ModelType ........................................................................................................................... 3143
PhiAngleEnd ......................................................................................................................... 3143
PhiAngleNoOfDivisions ......................................................................................................... 3143
PhiAngleStart ....................................................................................................................... 3143
ReferenceRMSSoundPressure ................................................................................................ 3143
ReferenceSoundPower .......................................................................................................... 3143
ReportedFrequency .............................................................................................................. 3144
SoundSpeed ......................................................................................................................... 3144
SpatialRadiationAngle .......................................................................................................... 3144
SphereRadius ....................................................................................................................... 3144

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clvii
ACT API Reference Guide

Stability ................................................................................................................................ 3144


StartingRadiationAnglePhi .................................................................................................... 3144
StartingRadiationAngleTheta ................................................................................................ 3145
ThetaAngleEnd ..................................................................................................................... 3145
ThetaAngleNoOfDivisions ..................................................................................................... 3145
ThetaAngleStart ................................................................................................................... 3145
Worksheet ............................................................................................................................ 3145
XCoordinate ......................................................................................................................... 3145
YAxisExtrusionAngle ............................................................................................................. 3146
YCoordinate .......................................................................................................................... 3146
ZCoordinate ......................................................................................................................... 3146
ExportToWAVFile(string) ........................................................................................................ 3146
ExportToXMLFile(string) ........................................................................................................ 3146
AcousticFarFieldSoundPowerLevelWaterfallDiagram ................................................................... 3147
DataModelObjectCategory ................................................................................................... 3153
InternalObject ...................................................................................................................... 3153
AcousticFarFieldSPLMicWaterfallDiagram .................................................................................... 3153
DataModelObjectCategory ................................................................................................... 3160
InternalObject ...................................................................................................................... 3160
AcousticFrequencyBandAWeightedSPL ....................................................................................... 3160
DataModelObjectCategory ................................................................................................... 3165
InternalObject ...................................................................................................................... 3165
AcousticFrequencyBandSPL ........................................................................................................ 3165
DataModelObjectCategory ................................................................................................... 3169
InternalObject ...................................................................................................................... 3169
AcousticKineticEnergy ................................................................................................................ 3170
DataModelObjectCategory ................................................................................................... 3174
InternalObject ...................................................................................................................... 3174
AcousticPotentialEnergy ............................................................................................................. 3174
DataModelObjectCategory ................................................................................................... 3179
InternalObject ...................................................................................................................... 3179
AcousticPressureResult ............................................................................................................... 3179
DataModelObjectCategory ................................................................................................... 3184
InternalObject ...................................................................................................................... 3184
ExportToWAVFile(string) ........................................................................................................ 3184
AcousticResult ............................................................................................................................ 3184
Amplitude ............................................................................................................................ 3188
DampedFrequency ............................................................................................................... 3188
DataModelObjectCategory ................................................................................................... 3189
Frequency ............................................................................................................................ 3189
InternalObject ...................................................................................................................... 3189
LogarithmicDecrement ......................................................................................................... 3189
ModalDampingRatio ............................................................................................................. 3189
Mode .................................................................................................................................... 3189
ReportedFrequency .............................................................................................................. 3190
Stability ................................................................................................................................ 3190
SweepingPhase .................................................................................................................... 3190
AcousticReturnLoss ..................................................................................................................... 3190
DataModelObjectCategory ................................................................................................... 3195
FrequencyRange ................................................................................................................... 3195
InputPort .............................................................................................................................. 3195

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

InternalObject ...................................................................................................................... 3195


MaximumFrequency ............................................................................................................. 3195
MinimumFrequency ............................................................................................................. 3195
AcousticSoundPressureLevel ....................................................................................................... 3196
DataModelObjectCategory ................................................................................................... 3200
InternalObject ...................................................................................................................... 3200
AcousticTotalVelocityResult ......................................................................................................... 3200
DataModelObjectCategory ................................................................................................... 3205
InternalObject ...................................................................................................................... 3205
AcousticTransmissionLoss ........................................................................................................... 3205
DataModelObjectCategory ................................................................................................... 3210
FrequencyRange ................................................................................................................... 3210
InputPort .............................................................................................................................. 3210
InternalObject ...................................................................................................................... 3210
MaximumFrequency ............................................................................................................. 3210
MinimumFrequency ............................................................................................................. 3211
OutputPort ........................................................................................................................... 3211
Ansys.ACT.Automation.Mechanical.MeshControls Namespace ..................................................... 3213
AutomaticMethod ...................................................................................................................... 3213
Active ................................................................................................................................... 3218
AggressiveInflateOption ....................................................................................................... 3218
AggressiveTetImprovement .................................................................................................. 3219
Algorithm ............................................................................................................................. 3219
ApproximativeNumberOfElementsPerPart ............................................................................. 3219
AutoCollapseShortEdges ....................................................................................................... 3219
AutomaticNodeMovement .................................................................................................... 3219
AutoPinchFaces .................................................................................................................... 3219
AutoPinchTolerance .............................................................................................................. 3220
AutoRemoveThinFaces .......................................................................................................... 3220
AutoRepairFeatureAngle ....................................................................................................... 3220
AutoRepairPartialDefeature .................................................................................................. 3220
AutoSharpAngle ................................................................................................................... 3220
AutoShortEdgeLength .......................................................................................................... 3220
AutoThinFaceWidth .............................................................................................................. 3221
BFCartSubType ..................................................................................................................... 3221
BFCartTolerance .................................................................................................................... 3221
BodyStackingType ................................................................................................................ 3221
CartesianSize ........................................................................................................................ 3221
CartSweepSpacingOption ..................................................................................................... 3221
Clearence ............................................................................................................................. 3222
ConstrainBoundary ............................................................................................................... 3222
ControlMessages .................................................................................................................. 3222
CoordinateSystem ................................................................................................................ 3222
CornerAngle ......................................................................................................................... 3222
CurvatureNormalAngle ......................................................................................................... 3222
DataModelObjectCategory ................................................................................................... 3223
DecompositionType .............................................................................................................. 3223
DefeatureLayerVolume ......................................................................................................... 3223
DefeaturingTolerance ........................................................................................................... 3223
DefinedBy ............................................................................................................................. 3223
ElementMidsideNodes ***OBSOLETE*** Use the ElementOrder property instead. ................... 3223

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clix
ACT API Reference Guide

ElementOption ..................................................................................................................... 3224


ElementOrder ....................................................................................................................... 3224
FaceProximityGapFactor ....................................................................................................... 3224
FallBackMeshType ................................................................................................................. 3224
FeatureAngle ........................................................................................................................ 3224
FeatureProtectionAngle ........................................................................................................ 3224
FilletCollapse ........................................................................................................................ 3225
FillingDirection ..................................................................................................................... 3225
FillingFraction ....................................................................................................................... 3225
FreeFaceMeshType ............................................................................................................... 3225
FreeMeshType ...................................................................................................................... 3225
GenerateLayersUsingFacets .................................................................................................. 3225
ImprovementIterations ......................................................................................................... 3226
InflateRelativeTolerance ........................................................................................................ 3226
InternalObject ...................................................................................................................... 3226
KeyPointsSelection ............................................................................................................... 3226
KeyPointsTolerance ............................................................................................................... 3226
LateralDefeatureSize ............................................................................................................. 3226
LayerHeight .......................................................................................................................... 3227
LayerStart ............................................................................................................................. 3227
Location ............................................................................................................................... 3227
MappedSweptType ............................................................................................................... 3227
MatchMeshWherePossible .................................................................................................... 3227
MaximumElementSize .......................................................................................................... 3227
MeshBasedDefeaturing ......................................................................................................... 3228
MeshFlowControl ................................................................................................................. 3228
MeshInCenter ....................................................................................................................... 3228
MeshType ............................................................................................................................. 3228
MeshUsingVoxelization ......................................................................................................... 3228
Method ................................................................................................................................ 3228
MinimumEdgeLength ........................................................................................................... 3229
MinimumSizeLimit ................................................................................................................ 3229
MinimumThickness ............................................................................................................... 3229
MZSweepNumberDivisions ................................................................................................... 3229
NamedSelection ................................................................................................................... 3229
NumberOfCellsAcrossGap ..................................................................................................... 3229
NumberOfElementLayers ...................................................................................................... 3230
OverlappingAngle ................................................................................................................ 3230
PartialFill ............................................................................................................................... 3230
ParticleCoordinateSystem ..................................................................................................... 3230
ParticleDiameter ................................................................................................................... 3230
PreserveBoundaries .............................................................................................................. 3230
PrimeMethodAutoRepair ...................................................................................................... 3231
PrimeRepairTolerance ........................................................................................................... 3231
ProjectCornersToTop ............................................................................................................. 3231
ProjectInConstantZPlane ....................................................................................................... 3231
ProjectionFactor ................................................................................................................... 3231
RadialGrowthRate ................................................................................................................. 3232
RefineAtThinSection ............................................................................................................. 3232
Refinement ........................................................................................................................... 3232
RefineSurfaceMesh ............................................................................................................... 3232

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

RelativeTolerance .................................................................................................................. 3232


RemoveSharpAngleFaces ...................................................................................................... 3232
RepairFacets ......................................................................................................................... 3233
RestrictNodeMovementsToSurface ........................................................................................ 3233
ReuseBlocking ...................................................................................................................... 3233
ShowAdvancedImproveOptions ............................................................................................ 3233
SlicerFeatureAngle ................................................................................................................ 3233
SliverTriangleHeight ............................................................................................................. 3233
SmoothMeshSpacing ............................................................................................................ 3234
SmoothTransition ................................................................................................................. 3234
SolidShellElementForStacker ................................................................................................. 3234
SolidShellElementForStackerGeometrySelection ................................................................... 3234
SolidShellElementForStackerNamedSelection ....................................................................... 3234
SolidShellElementForStackerScopingMethod ........................................................................ 3234
SourceLocation ..................................................................................................................... 3235
SourceTargetSelection .......................................................................................................... 3235
SpacingOption ..................................................................................................................... 3235
SplitAngle ............................................................................................................................. 3235
SrcTrgNamedSelection .......................................................................................................... 3235
SrcTrgScopingMethod .......................................................................................................... 3235
StackerCoordinateSystem ..................................................................................................... 3236
StackerFreeFaceMeshType .................................................................................................... 3236
StackerTriangleReduction ..................................................................................................... 3236
StackingAxis ......................................................................................................................... 3236
StackingDefeatureSize .......................................................................................................... 3236
StretchFactorX ...................................................................................................................... 3236
StretchFactorY ...................................................................................................................... 3237
StretchFactorZ ...................................................................................................................... 3237
SubsampleRate ..................................................................................................................... 3237
SurfaceMeshMethod ............................................................................................................. 3237
SweepBiasType ..................................................................................................................... 3237
SweepBiasValue .................................................................................................................... 3237
SweepEdges ......................................................................................................................... 3238
SweepElementSize ................................................................................................................ 3238
SweepESizeType ................................................................................................................... 3238
SweepNumberDivisions ........................................................................................................ 3238
SweepSizeBehavior ............................................................................................................... 3238
SweepThickness ................................................................................................................... 3238
TargetLocation ...................................................................................................................... 3239
TetraGrowthRate ................................................................................................................... 3239
TriangleReduction ................................................................................................................ 3239
UseSplitAngle ....................................................................................................................... 3239
WallThickness ....................................................................................................................... 3239
WriteICEMCFDFiles ............................................................................................................... 3239
Connect ...................................................................................................................................... 3240
ConnectionOption ................................................................................................................ 3240
ConnectionSize ..................................................................................................................... 3241
ConnectionTolerance ............................................................................................................ 3241
ConnectionToleranceList ....................................................................................................... 3241
CoplanarAngleTolerance ....................................................................................................... 3241
DataModelObjectCategory ................................................................................................... 3241

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxi
ACT API Reference Guide

InternalObject ...................................................................................................................... 3241


Location ............................................................................................................................... 3242
MultipleConnectionStep ....................................................................................................... 3242
NamedSelection ................................................................................................................... 3242
PerformIntersections ............................................................................................................ 3242
ContactSizing ............................................................................................................................. 3242
ContactRegion ...................................................................................................................... 3243
DataModelObjectCategory ................................................................................................... 3243
ElementSize .......................................................................................................................... 3243
InternalObject ...................................................................................................................... 3244
Relevance ............................................................................................................................. 3244
Type ..................................................................................................................................... 3244
Deviation .................................................................................................................................... 3244
ControlType .......................................................................................................................... 3245
DataModelObjectCategory ................................................................................................... 3245
InternalObject ...................................................................................................................... 3245
Location ............................................................................................................................... 3245
MeshSize .............................................................................................................................. 3246
NamedSelection ................................................................................................................... 3246
NumberOfDivisions .............................................................................................................. 3246
Tolerance .............................................................................................................................. 3246
FaceMeshing .............................................................................................................................. 3246
Active ................................................................................................................................... 3247
ConstrainBoundary ............................................................................................................... 3247
DataModelObjectCategory ................................................................................................... 3248
InternalNumberOfDivisions ................................................................................................... 3248
InternalObject ...................................................................................................................... 3248
Location ............................................................................................................................... 3248
MappedMesh ....................................................................................................................... 3248
Method ................................................................................................................................ 3248
MultiZoneSemiStructured ..................................................................................................... 3249
NamedSelection ................................................................................................................... 3249
SpecifiedCorners ................................................................................................................... 3249
SpecifiedEnds ....................................................................................................................... 3249
SpecifiedSides ...................................................................................................................... 3249
TransitionType ...................................................................................................................... 3249
FeatureSuppress ......................................................................................................................... 3250
DataModelObjectCategory ................................................................................................... 3250
FeatureHeight ....................................................................................................................... 3251
InternalObject ...................................................................................................................... 3251
Location ............................................................................................................................... 3251
NamedSelection ................................................................................................................... 3251
SourceLocation ..................................................................................................................... 3251
SourceNamedSelection ......................................................................................................... 3251
SourceSelection .................................................................................................................... 3252
GeometryFidelity ........................................................................................................................ 3252
DataModelObjectCategory ................................................................................................... 3253
InternalObject ...................................................................................................................... 3253
Location ............................................................................................................................... 3253
NamedSelection ................................................................................................................... 3253
Inflation ...................................................................................................................................... 3253

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Active ................................................................................................................................... 3254


AspectRatio .......................................................................................................................... 3254
BoundaryLocation ................................................................................................................ 3255
BoundaryNamedSelection .................................................................................................... 3255
DataModelObjectCategory ................................................................................................... 3255
FirstLayerHeight ................................................................................................................... 3255
GrowthRate .......................................................................................................................... 3255
InflationAlgorithm ................................................................................................................ 3255
InflationOption ..................................................................................................................... 3256
InternalObject ...................................................................................................................... 3256
Location ............................................................................................................................... 3256
MaximumLayers ................................................................................................................... 3256
MaximumThickness .............................................................................................................. 3256
NamedSelection ................................................................................................................... 3256
NumberOfLayers ................................................................................................................... 3257
TransitionRatio ...................................................................................................................... 3257
MatchControl ............................................................................................................................. 3257
ControlMessages .................................................................................................................. 3258
DataModelObjectCategory ................................................................................................... 3258
HighCoordinateSystem ......................................................................................................... 3258
HighGeometrySelection ........................................................................................................ 3258
HighNamedSelection ............................................................................................................ 3259
InternalObject ...................................................................................................................... 3259
LowCoordinateSystem .......................................................................................................... 3259
LowGeometrySelection ......................................................................................................... 3259
LowNamedSelection ............................................................................................................. 3259
RotationAxis ......................................................................................................................... 3259
Transformation ..................................................................................................................... 3260
Mesh .......................................................................................................................................... 3260
AspectRatio .......................................................................................................................... 3269
AutomaticMeshBasedDefeaturing ......................................................................................... 3269
Average ................................................................................................................................ 3269
Beam3 .................................................................................................................................. 3269
Beam4 .................................................................................................................................. 3270
BeamElements ...................................................................................................................... 3270
CaptureCurvature ................................................................................................................. 3270
CaptureProximity .................................................................................................................. 3270
CheckMeshQuality ................................................................................................................ 3270
Children ............................................................................................................................... 3270
CollisionAvoidance ............................................................................................................... 3271
Comments ............................................................................................................................ 3271
ConnectionSize ..................................................................................................................... 3271
ConnectionTolerance ............................................................................................................ 3271
ConnectionToleranceList ....................................................................................................... 3271
CoplanarAngleTol ................................................................................................................. 3271
CornerNodes ........................................................................................................................ 3272
CurrentConfiguration ............................................................................................................ 3272
CurvatureNormalAngle ......................................................................................................... 3272
DataModelObjectCategory ................................................................................................... 3272
DefaultShellMesher .............................................................................................................. 3272
DefeatureTolerance ............................................................................................................... 3272

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxiii
ACT API Reference Guide

DisplayStyle .......................................................................................................................... 3273


ElementOrder ....................................................................................................................... 3273
Elements .............................................................................................................................. 3273
ElementSize .......................................................................................................................... 3273
ExportFormat ....................................................................................................................... 3273
ExportUnit ............................................................................................................................ 3273
ExtraRetriesForAssembly ....................................................................................................... 3274
Figures ................................................................................................................................. 3274
FilletRatio ............................................................................................................................. 3274
FirstLayerHeight ................................................................................................................... 3274
GapFactor ............................................................................................................................. 3274
GasketElements .................................................................................................................... 3274
GeneratePinchOnRefresh ...................................................................................................... 3275
GlobalUseCustomTargetLimit ................................................................................................ 3275
GrowthRate .......................................................................................................................... 3275
GrowthRateSF ....................................................................................................................... 3275
GrowthRateType ................................................................................................................... 3275
Hex20 ................................................................................................................................... 3275
Hex8 ..................................................................................................................................... 3276
HoleRemovalTolerance ......................................................................................................... 3276
Images ................................................................................................................................. 3276
InflationAlgorithm ................................................................................................................ 3276
InflationElementType ............................................................................................................ 3276
InflationOption ..................................................................................................................... 3276
InitialSizeSeed ...................................................................................................................... 3277
InternalObject ...................................................................................................................... 3277
Line2 .................................................................................................................................... 3277
Line3 .................................................................................................................................... 3277
Maximum ............................................................................................................................. 3277
MaximumAngle .................................................................................................................... 3277
MaximumHeightOverBase .................................................................................................... 3278
MaximumLayers ................................................................................................................... 3278
MaximumSize ....................................................................................................................... 3278
MaximumThickness .............................................................................................................. 3278
MeshBasedConnection ......................................................................................................... 3278
MeshMetric .......................................................................................................................... 3278
MeshMorphing ..................................................................................................................... 3279
Method ................................................................................................................................ 3279
MidNodes ............................................................................................................................. 3279
MinimizeNumTriangles ......................................................................................................... 3279
Minimum .............................................................................................................................. 3279
MinimumEdgeLength ........................................................................................................... 3279
MinimumSize ....................................................................................................................... 3280
MultiConnectionSteps .......................................................................................................... 3280
NamedSelection ................................................................................................................... 3280
Nodes ................................................................................................................................... 3280
NumberOfCPUsForParallelPartMeshing ................................................................................. 3280
NumberOfRetries .................................................................................................................. 3280
NumberOfShellMeshQualityMetrics ...................................................................................... 3281
NumLayers ........................................................................................................................... 3281
OrientationNodes ................................................................................................................. 3281

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

PhysicsPreference ................................................................................................................. 3281


PinchTolerance ..................................................................................................................... 3281
ProximityGapFactor .............................................................................................................. 3281
ProximityMinimumSize ......................................................................................................... 3282
ProximitySizeSources ............................................................................................................ 3282
Pyramid13 ............................................................................................................................ 3282
Pyramid5 .............................................................................................................................. 3282
Quad4 .................................................................................................................................. 3282
Quad8 .................................................................................................................................. 3282
QuadMesh ............................................................................................................................ 3283
ReadOnly .............................................................................................................................. 3283
Relevance ............................................................................................................................. 3283
RelevanceCenter ................................................................................................................... 3283
Resolution ............................................................................................................................ 3283
RigidBodyBehavior ............................................................................................................... 3283
RigidBodyFaceMeshType ...................................................................................................... 3284
ShapeChecking ..................................................................................................................... 3284
SharedNodes ........................................................................................................................ 3284
SheetLoopRemoval ............................................................................................................... 3284
ShellElements ....................................................................................................................... 3284
ShowDetailedStatistics .......................................................................................................... 3284
Smoothing ........................................................................................................................... 3285
SmoothingIterations ............................................................................................................. 3285
SolidElements ....................................................................................................................... 3285
SolidShellElements ............................................................................................................... 3285
SolverPreference ................................................................................................................... 3285
SpanAngleCenter .................................................................................................................. 3285
StandardDeviation ................................................................................................................ 3286
StraightSidedElements .......................................................................................................... 3286
TargetCharacteristicLength ................................................................................................... 3286
TargetExplicitAspectRatio ..................................................................................................... 3286
TargetQuality ........................................................................................................................ 3286
TargetSkewness .................................................................................................................... 3286
Tet10 .................................................................................................................................... 3287
Tet4 ...................................................................................................................................... 3287
TopologyChecking ................................................................................................................ 3287
TransitionOption ................................................................................................................... 3287
TransitionRatio ...................................................................................................................... 3287
Tri3 ....................................................................................................................................... 3287
Tri6 ....................................................................................................................................... 3288
TriangleSurfaceMesher ......................................................................................................... 3288
UseAdaptiveSizing ................................................................................................................ 3288
UseAdvancedSizeFunction .................................................................................................... 3288
UseAutomaticInflation .......................................................................................................... 3288
UseFixedSizeFunctionForSheets ............................................................................................ 3288
UsePostSmoothing ............................................................................................................... 3289
UseSheetThicknessForPinch .................................................................................................. 3289
ViewAdvancedOptions ......................................................................................................... 3289
Wedge15 .............................................................................................................................. 3289
Wedge6 ................................................................................................................................ 3289
Worksheet ............................................................................................................................ 3289

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxv
ACT API Reference Guide

ActivateAllSolidSurfaceWorksheetRows() .............................................................................. 3290


ActivateAllSurfaceWorksheetRows() ...................................................................................... 3290
ActivateAllVolumeWorksheetRows() ...................................................................................... 3290
AddAutomaticMethod() ........................................................................................................ 3290
AddComment() ..................................................................................................................... 3290
AddConnect() ....................................................................................................................... 3290
AddContactMatchGroup() ..................................................................................................... 3291
AddContactSizing() ............................................................................................................... 3291
AddDeviation() ..................................................................................................................... 3291
AddDirectMorph() ................................................................................................................ 3291
AddFaceMeshing() ................................................................................................................ 3291
AddFeatureSuppress() ........................................................................................................... 3291
AddFigure() .......................................................................................................................... 3292
AddGeometryFidelity() ......................................................................................................... 3292
AddImage(string) .................................................................................................................. 3292
AddInflation() ....................................................................................................................... 3292
AddManualMeshConnection() .............................................................................................. 3292
AddMatchControl() ............................................................................................................... 3293
AddMeshConnectionGroup() ................................................................................................ 3293
AddMeshCopy() .................................................................................................................... 3293
AddMeshLayers() .................................................................................................................. 3293
AddNodeMerge() .................................................................................................................. 3293
AddNodeMergeGroup() ........................................................................................................ 3293
AddPinch() ........................................................................................................................... 3294
AddPullExtrude() .................................................................................................................. 3294
AddPullRevolve() .................................................................................................................. 3294
AddPullSurfaceCoating() ....................................................................................................... 3294
AddRefinement() .................................................................................................................. 3294
AddRepairTopology() ............................................................................................................ 3294
AddSizing() ........................................................................................................................... 3295
AddTopologySuppressControl() ............................................................................................ 3295
AddWasher() ......................................................................................................................... 3295
AddWeld() ............................................................................................................................ 3295
CleanPartOrBody(IEnumerable) ............................................................................................. 3295
ClearGeneratedData() ........................................................................................................... 3296
CreateMQSolidSurfaceElementsNamedSelection(MeshMetricType, uint) ................................ 3296
CreateMQSurfaceElementsNamedSelection(MeshMetricType, uint) ....................................... 3296
CreateMQVolumeElementsNamedSelection(MeshMetricType, uint) ....................................... 3297
CreatePinchControls() ........................................................................................................... 3297
DeactivateAllSolidSurfaceWorksheetRows() ........................................................................... 3297
DeactivateAllSurfaceWorksheetRows() .................................................................................. 3297
DeactivateAllVolumeWorksheetRows() .................................................................................. 3298
ExportWeldDefinitionFile(string) ........................................................................................... 3298
GenerateMesh() .................................................................................................................... 3298
GetActiveSurfaceMeshQuality(MeshMetricType) ................................................................... 3298
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3298
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3299
GetIsShellTargetMetric(MeshMetricType) .............................................................................. 3299
GetIsSolidSurfaceTargetMetric(MeshMetricType) ................................................................... 3300
GetIsSolidTargetMetric(MeshMetricType) .............................................................................. 3300
GetMeshMetricOptions(MeshMetricType) ............................................................................. 3300

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

GetSolidSurfaceMeshMetrics() .............................................................................................. 3301


GetSolidSurfaceMeshQualityAverageMetricValue(MeshMetricType) ....................................... 3301
GetSolidSurfaceMeshQualityCountFailed(MeshMetricType) ................................................... 3301
GetSolidSurfaceMeshQualityErrorLimit(MeshMetricType) ...................................................... 3301
GetSolidSurfaceMeshQualityName(MeshMetricType) ............................................................ 3302
GetSolidSurfaceMeshQualityPercentageFailed(MeshMetricType) ........................................... 3302
GetSolidSurfaceMeshQualityWarningCountFailed(MeshMetricType) ...................................... 3302
GetSolidSurfaceMeshQualityWarningLimit(MeshMetricType) ................................................. 3302
GetSolidSurfaceMeshQualityWarningPercentageFailed(MeshMetricType) .............................. 3303
GetSolidSurfaceMeshQualityWorstMetricBackgroundColor(MeshMetricType) ........................ 3303
GetSolidSurfaceMeshQualityWorstMetricValue(MeshMetricType) .......................................... 3303
GetSurfaceMeshQualityAverageMetricValue(MeshMetricType) .............................................. 3304
GetSurfaceMeshQualityCountFailed(MeshMetricType) .......................................................... 3304
GetSurfaceMeshQualityErrorLimit(MeshMetricType) .............................................................. 3304
GetSurfaceMeshQualityName(MeshMetricType) .................................................................... 3304
GetSurfaceMeshQualityPercentageFailed(MeshMetricType) ................................................... 3305
GetSurfaceMeshQualityWarningCountFailed(MeshMetricType) .............................................. 3305
GetSurfaceMeshQualityWarningLimit(MeshMetricType) ........................................................ 3305
GetSurfaceMeshQualityWarningPercentageFailed(MeshMetricType) ...................................... 3306
GetSurfaceMeshQualityWorstMetricValue(MeshMetricType) .................................................. 3306
GetVolumeMeshMetrics() ...................................................................................................... 3306
GetVolumeMeshQualityAverageMetricValue(MeshMetricType) .............................................. 3306
GetVolumeMeshQualityCountFailed(MeshMetricType) .......................................................... 3307
GetVolumeMeshQualityErrorLimit(MeshMetricType) ............................................................. 3307
GetVolumeMeshQualityName(MeshMetricType) ................................................................... 3307
GetVolumeMeshQualityPercentageFailed(MeshMetricType) .................................................. 3307
GetVolumeMeshQualityWarningCountFailed(MeshMetricType) ............................................. 3308
GetVolumeMeshQualityWarningLimit(MeshMetricType) ........................................................ 3308
GetVolumeMeshQualityWarningPercentageFailed(MeshMetricType) ..................................... 3308
GetVolumeMeshQualityWorstMetricBackgroundColor(MeshMetricType) ............................... 3309
GetVolumeMeshQualityWorstMetricValue(MeshMetricType) .................................................. 3309
IsMeshMetricVisible(uint) ...................................................................................................... 3309
LoadMQWorksheetFile(string) ............................................................................................... 3309
PinchControlGeomtry(MeshControlPinchGeomtryType) ........................................................ 3310
PreviewInflation() .................................................................................................................. 3310
PreviewMeshOnAllWelds() .................................................................................................... 3310
PreviewMeshOnWeld(IDataModelObject) .............................................................................. 3310
PreviewMeshOnWelds(IEnumerable<IDataModelObject>) .................................................... 3311
PreviewMeshOnWeldWorksheet(IDataModelObject, IEnumerable<int>) ................................ 3311
PreviewSurfaceMesh() ........................................................................................................... 3311
PreviewWelds() ..................................................................................................................... 3311
RemoveMeshLayers() ............................................................................................................ 3312
SaveMQWorksheetFile(string) ............................................................................................... 3312
SetActiveSolidSurfaceMeshQuality(MeshMetricType, double) ................................................ 3312
SetActiveSurfaceMeshQuality(MeshMetricType, double) ........................................................ 3312
SetActiveVolumeMeshQuality(MeshMetricType, double) ....................................................... 3313
SetMeshMetricOptions(MeshMetricType, MetricPreference) ................................................... 3313
SetSolidMeshMetricLimits(MeshMetricType, Quantity, Quantity) ............................................ 3313
SetSolidSurfaceMeshMetricLimits(MeshMetricType, Quantity, Quantity) ................................. 3314
SetSolidSurfaceMeshQualityErrorLimit(MeshMetricType, double) ........................................... 3314
SetSolidSurfaceMeshQualityErrorLimit(MeshMetricType, Quantity) ........................................ 3315

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxvii
ACT API Reference Guide

SetSolidSurfaceMeshQualityWarningLimit(MeshMetricType, double) ..................................... 3315


SetSolidSurfaceMeshQualityWarningLimit(MeshMetricType, Quantity) .................................. 3315
SetSurfaceMeshMetricLimits(MeshMetricType, Quantity, Quantity) ........................................ 3316
SetSurfaceMeshQualityErrorLimit(MeshMetricType, double) .................................................. 3316
SetSurfaceMeshQualityErrorLimit(MeshMetricType, Quantity) ................................................ 3317
SetSurfaceMeshQualityWarningLimit(MeshMetricType, double) ............................................. 3317
SetSurfaceMeshQualityWarningLimit(MeshMetricType, Quantity) .......................................... 3317
SetVolumeMeshQualityErrorLimit(MeshMetricType, double) .................................................. 3318
SetVolumeMeshQualityErrorLimit(MeshMetricType, Quantity) ............................................... 3318
SetVolumeMeshQualityWarningLimit(MeshMetricType, double) ............................................ 3318
SetVolumeMeshQualityWarningLimit(MeshMetricType, Quantity) .......................................... 3319
ShowFeatureSuppressibleFaces() .......................................................................................... 3319
ShowMappableBodies() ........................................................................................................ 3319
ShowOverlappingFaces() ...................................................................................................... 3320
ShowSweepableBodies() ....................................................................................................... 3320
ShowUnconnectedFacesNearEdges() .................................................................................... 3320
Update() ............................................................................................................................... 3320
MeshControl ............................................................................................................................... 3320
Children ............................................................................................................................... 3321
Comments ............................................................................................................................ 3321
DataModelObjectCategory ................................................................................................... 3321
Figures ................................................................................................................................. 3321
Images ................................................................................................................................. 3322
InternalObject ...................................................................................................................... 3322
ScopingMethod .................................................................................................................... 3322
Suppressed ........................................................................................................................... 3322
AddComment() ..................................................................................................................... 3322
AddFigure() .......................................................................................................................... 3322
AddImage(string) .................................................................................................................. 3323
Delete() ................................................................................................................................ 3323
GenerateMesh() .................................................................................................................... 3323
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3323
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3324
RenameBasedOnDefinition() ................................................................................................. 3324
MeshCopy .................................................................................................................................. 3324
DataModelObjectCategory ................................................................................................... 3325
InternalObject ...................................................................................................................... 3325
NodeMergeTolerance ........................................................................................................... 3326
NodeMergeToleranceOption ................................................................................................. 3326
PercentageOfElementSize ..................................................................................................... 3326
SourceAnchors ..................................................................................................................... 3326
SourceAnchorsNamedSelection ............................................................................................ 3326
TargetAnchors ...................................................................................................................... 3326
TargetAnchorsNamedSelection ............................................................................................. 3327
TargetScoping ...................................................................................................................... 3327
Pinch .......................................................................................................................................... 3327
AutoManualMode ................................................................................................................. 3328
DataModelObjectCategory ................................................................................................... 3328
InternalObject ...................................................................................................................... 3328
MasterGeometry ................................................................................................................... 3328
SlaveGeometry ..................................................................................................................... 3328

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

Tolerance .............................................................................................................................. 3329


Refinement ................................................................................................................................. 3329
DataModelObjectCategory ................................................................................................... 3329
InternalObject ...................................................................................................................... 3330
Location ............................................................................................................................... 3330
NamedSelection ................................................................................................................... 3330
NumberOfRefinements ......................................................................................................... 3330
Relevance ................................................................................................................................... 3330
DataModelObjectCategory ................................................................................................... 3331
InternalObject ...................................................................................................................... 3331
Location ............................................................................................................................... 3331
NamedSelection ................................................................................................................... 3332
PartRelavance ....................................................................................................................... 3332
RepairTopology .......................................................................................................................... 3332
CollapseShortEdges .............................................................................................................. 3334
DataModelObjectCategory ................................................................................................... 3334
FeatureAngle ........................................................................................................................ 3335
FillHole ................................................................................................................................. 3335
FillHoleGeometryDefineBy .................................................................................................... 3335
FillHoleGeometrySelection .................................................................................................... 3335
FillHoleNamedSelection ........................................................................................................ 3335
InternalObject ...................................................................................................................... 3335
MergeFaces .......................................................................................................................... 3336
MergeFacesGeometryDefineBy ............................................................................................. 3336
MergeFacesGeometrySelection ............................................................................................. 3336
MergeFacesNamedSelection ................................................................................................. 3336
PartialDefeatureGeometrySelection ...................................................................................... 3336
PartialDefeatureNamedSelection .......................................................................................... 3336
PinchFaces ............................................................................................................................ 3337
PinchFacesGeometryDefineBy .............................................................................................. 3337
PinchFacesGeometrySelection .............................................................................................. 3337
PinchFacesNamedSelection .................................................................................................. 3337
PinchFacesUseLocalScoping .................................................................................................. 3337
PinchTolerance ..................................................................................................................... 3337
RemoveSharpAngleFaces ...................................................................................................... 3338
RemoveThinFaces ................................................................................................................. 3338
RepairPartialDefeature .......................................................................................................... 3338
RepairPartialDefeatureGeometryDefineBy ............................................................................. 3338
SharpAngle ........................................................................................................................... 3338
SharpAngleGeometryDefineBy ............................................................................................. 3338
SharpAngleGeometrySelection ............................................................................................. 3339
SharpAngleNamedSelection ................................................................................................. 3339
SharpAngleUseLocalScoping ................................................................................................ 3339
ShortEdgeGeometryDefineBy ............................................................................................... 3339
ShortEdgeGeometrySelection ............................................................................................... 3339
ShortEdgeLength ................................................................................................................. 3339
ShortEdgeNamedSelection ................................................................................................... 3340
ShortEdgeUseLocalScoping .................................................................................................. 3340
SuppressEdges ..................................................................................................................... 3340
SuppressEdgesGeometryDefineBy ........................................................................................ 3340
SuppressEdgesGeometrySelection ........................................................................................ 3340

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxix
ACT API Reference Guide

SuppressEdgesNamedSelection ............................................................................................ 3340


ThinFaceGeometryDefineBy .................................................................................................. 3341
ThinFaceGeometrySelection ................................................................................................. 3341
ThinFaceNamedSelection ...................................................................................................... 3341
ThinFacesUseLocalScoping ................................................................................................... 3341
ThinFaceWidth ...................................................................................................................... 3341
Sizing ......................................................................................................................................... 3341
Active ................................................................................................................................... 3343
Behavior ............................................................................................................................... 3343
BiasFactor ............................................................................................................................. 3343
BiasGrowthRate .................................................................................................................... 3343
BiasOption ............................................................................................................................ 3344
BiasType ............................................................................................................................... 3344
BodyOfInfluence ................................................................................................................... 3344
CaptureCurvature ................................................................................................................. 3344
CaptureProximity .................................................................................................................. 3344
CurvatureNormalAngle ......................................................................................................... 3344
DataModelObjectCategory ................................................................................................... 3345
DefeatureSize ....................................................................................................................... 3345
ElementSize .......................................................................................................................... 3345
GrowthRate .......................................................................................................................... 3345
InternalObject ...................................................................................................................... 3345
LocalMinimumSize ................................................................................................................ 3345
Location ............................................................................................................................... 3346
NamedSelection ................................................................................................................... 3346
NumberOfDivisions .............................................................................................................. 3346
OriginX ................................................................................................................................. 3346
OriginY ................................................................................................................................. 3346
OriginZ ................................................................................................................................. 3346
ProximityGapFactor .............................................................................................................. 3347
ProximityMinimumSize ......................................................................................................... 3347
ProximitySizeSources ............................................................................................................ 3347
ReverseBias .......................................................................................................................... 3347
SphereCenter ....................................................................................................................... 3347
SphereRadius ....................................................................................................................... 3347
Type ..................................................................................................................................... 3348
TopologySuppressControl ........................................................................................................... 3348
DataModelObjectCategory ................................................................................................... 3348
InternalObject ...................................................................................................................... 3349
Location ............................................................................................................................... 3349
Washer ....................................................................................................................................... 3349
DataModelObjectCategory ................................................................................................... 3350
ElementSize .......................................................................................................................... 3350
FaceNamedSelection ............................................................................................................ 3351
FaceScopingMethod ............................................................................................................. 3351
FaceSelection ....................................................................................................................... 3351
FirstLayerHeight ................................................................................................................... 3351
GrowthRate .......................................................................................................................... 3351
InternalObject ...................................................................................................................... 3351
LayerTransitionType .............................................................................................................. 3352
Location ............................................................................................................................... 3352

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

MinimumNumberOfDivisions ................................................................................................ 3352


NamedSelection ................................................................................................................... 3352
NumberOfDivisions .............................................................................................................. 3352
NumberOfLayers ................................................................................................................... 3352
QuadLayerDefeatureProximityTolerance ............................................................................... 3353
QuadLayerDirection .............................................................................................................. 3353
QuadLayerType ..................................................................................................................... 3353
Relaxation ............................................................................................................................ 3353
ScaleOfDiameter ................................................................................................................... 3353
WasherAutoDefeature ........................................................................................................... 3353
WasherHeightType ............................................................................................................... 3354
WasherMethod ..................................................................................................................... 3354
Weld ........................................................................................................................................... 3354
AdjustWeldHeight ................................................................................................................ 3359
AngledDirection ................................................................................................................... 3359
BottomEntities ...................................................................................................................... 3359
BottomEntitiesNamedSelection ............................................................................................ 3359
ButtWeldOption .................................................................................................................... 3360
ConnectionTolerance ............................................................................................................ 3360
ControlType .......................................................................................................................... 3360
CreateHAZLayer .................................................................................................................... 3360
CreateUsing .......................................................................................................................... 3360
CreationCriteria .................................................................................................................... 3360
CrossSectionId ...................................................................................................................... 3361
CurveScoping ....................................................................................................................... 3361
DataModelObjectCategory ................................................................................................... 3361
EdgeMeshSize ...................................................................................................................... 3361
EdgeMeshSizeAssignment .................................................................................................... 3361
EdgeMeshSizeExpression ...................................................................................................... 3361
EdgeSelection ....................................................................................................................... 3362
GenerateEndCaps ................................................................................................................. 3362
GenerateNamedSelection ..................................................................................................... 3362
HAZDistanceAssignment ...................................................................................................... 3362
HAZDistanceBottomPlate ..................................................................................................... 3362
HAZDistanceExpressionBottomPlate ..................................................................................... 3362
HAZDistanceExpressionTopPlate ........................................................................................... 3363
HAZDistanceOption .............................................................................................................. 3363
HAZDistanceTopPlate ........................................................................................................... 3363
HAZGrowthRate .................................................................................................................... 3363
InternalObject ...................................................................................................................... 3363
LapWeldAngleTolerance ....................................................................................................... 3363
LayerTransitionType .............................................................................................................. 3364
MaterialId ............................................................................................................................. 3364
MaxThicknessFactor .............................................................................................................. 3364
MinThicknessFactor .............................................................................................................. 3364
ModeledAs ........................................................................................................................... 3364
NameFilter ............................................................................................................................ 3364
NumberOfLayers ................................................................................................................... 3365
NumberOfWelds ................................................................................................................... 3365
Offset1 ................................................................................................................................. 3365
Offset2 ................................................................................................................................. 3365

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxxi
ACT API Reference Guide

Relaxation ............................................................................................................................ 3365


SharpAngle ........................................................................................................................... 3365
Smoothing ........................................................................................................................... 3366
Source .................................................................................................................................. 3366
Thickness .............................................................................................................................. 3366
ThicknessAssignment ........................................................................................................... 3366
TopEntities ........................................................................................................................... 3366
TopEntitiesNamedSelection .................................................................................................. 3366
UseWorksheet ...................................................................................................................... 3367
WeldAngle ............................................................................................................................ 3367
WeldControlWeldWidth ........................................................................................................ 3367
WeldCurves .......................................................................................................................... 3367
WeldCurvesBody .................................................................................................................. 3367
WeldDefinitionFileLocation ................................................................................................... 3367
WeldEdgesNamedSelection .................................................................................................. 3368
WeldElementRows ................................................................................................................ 3368
WeldFormulation .................................................................................................................. 3368
WeldHeight .......................................................................................................................... 3368
WeldHeightAssignment ........................................................................................................ 3368
WeldHeightExpression .......................................................................................................... 3368
WeldIntersectionTag ............................................................................................................. 3369
WeldIntersectionTolerance .................................................................................................... 3369
WeldLength .......................................................................................................................... 3369
WeldPinballRadius ................................................................................................................ 3369
WeldPitch ............................................................................................................................. 3369
WeldTargetShellFace ............................................................................................................. 3369
WeldThicknessExpression ..................................................................................................... 3370
WeldWidthAssignment ......................................................................................................... 3370
WeldWidthExpression ........................................................................................................... 3370
WriteDefinitionFile ................................................................................................................ 3370
ActivateAllWorksheetEntries() ............................................................................................... 3370
AddWeldWorksheetScopeToSelection(int, int) ....................................................................... 3370
AppendWeldControlIntersectionTag(string) .......................................................................... 3371
AppendWeldWorksheetIntersectionTag(IEnumerable<int>, string) ........................................ 3371
ClearAutoWeldIntersectionTag(bool) ..................................................................................... 3371
ClearWeldControlIntersectionTag() ........................................................................................ 3372
ClearWeldWorksheetIntersectionTag(IEnumerable<int>) ....................................................... 3372
DeactivateAllWorksheetEntries() ........................................................................................... 3372
DeactivateProblematicWorksheetEntries() ............................................................................. 3372
GenerateWeldIntersectionTag() ............................................................................................. 3373
GetCrossSectionIds(int) ......................................................................................................... 3373
GetMaterialIds(int) ................................................................................................................ 3373
GetWeldWorksheetAbsTol(int) ............................................................................................... 3373
GetWeldWorksheetActive(int) ............................................................................................... 3374
GetWeldWorksheetBottomEntities(int) .................................................................................. 3374
GetWeldWorksheetEdgeMeshSize(int) ................................................................................... 3374
GetWeldWorksheetEdgeMeshSizeExpression(int) .................................................................. 3374
GetWeldWorksheetEdges(int) ................................................................................................ 3375
GetWeldWorksheetGenerateEndCaps(int) ............................................................................. 3375
GetWeldWorksheetHAZDistanceBottomPlate(int) .................................................................. 3375
GetWeldWorksheetHAZDistanceExpressionBottomPlate(int) ................................................. 3376

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

GetWeldWorksheetHAZDistanceExpressionTopPlate(int) ....................................................... 3376


GetWeldWorksheetHAZGrowthRate(int) ................................................................................ 3376
GetWeldWorksheetHeight(int) .............................................................................................. 3376
GetWeldWorksheetIntersectionTag(int) ................................................................................. 3377
GetWeldWorksheetLapAngleTol(int) ...................................................................................... 3377
GetWeldWorksheetLength(int) .............................................................................................. 3377
GetWeldWorksheetMaxThicknessFactor(int) .......................................................................... 3378
GetWeldWorksheetMinThicknessFactor(int) .......................................................................... 3378
GetWeldWorksheetNumError() .............................................................................................. 3378
GetWeldWorksheetNumLayers(int) ........................................................................................ 3378
GetWeldWorksheetNumWarning() ........................................................................................ 3379
GetWeldWorksheetNumWelds(int) ........................................................................................ 3379
GetWeldWorksheetOffset1(int) .............................................................................................. 3379
GetWeldWorksheetOffset2(int) .............................................................................................. 3379
GetWeldWorksheetPitch(int) ................................................................................................. 3380
GetWeldWorksheetSharpAngle(int) ....................................................................................... 3380
GetWeldWorksheetSmoothing(int) ........................................................................................ 3380
GetWeldWorksheetThickness(int) .......................................................................................... 3380
GetWeldWorksheetThicknessExpression(int) ......................................................................... 3381
GetWeldWorksheetTopEntities(int) ........................................................................................ 3381
GetWeldWorksheetWeldAngle(int) ........................................................................................ 3381
GetWeldWorksheetWeldCurve(int) ........................................................................................ 3382
GetWeldWorksheetWeldHeightExpression(int) ...................................................................... 3382
GetWeldWorksheetWeldWidthExpression(int) ....................................................................... 3382
GetWeldWorksheetWidth(int) ............................................................................................... 3382
PreviewMeshOnWeldWorksheet(IEnumerable<int>) .............................................................. 3383
PromoteToWeldControl(IEnumerable<int>) ........................................................................... 3383
SetWeldWorksheetAbsTol(IEnumerable<int>, double) ........................................................... 3383
SetWeldWorksheetActive(IEnumerable<int>, bool) ................................................................ 3384
SetWeldWorksheetBottomEntities(IEnumerable<int>, uint) ................................................... 3384
SetWeldWorksheetEdgeMeshSize(IEnumerable<int>, double) ............................................... 3384
SetWeldWorksheetEdgeMeshSizeExpression(IEnumerable<int>, string) ................................. 3385
SetWeldWorksheetEdges(IEnumerable<int>, uint) ................................................................. 3385
SetWeldWorksheetGenerateEndCaps(IEnumerable<int>, bool) .............................................. 3385
SetWeldWorksheetHAZDistanceBottomPlate(IEnumerable<int>, double) .............................. 3386
SetWeldWorksheetHAZDistanceExpressionBottomPlate(IEnumerable<int>, string) ................ 3386
SetWeldWorksheetHAZDistanceExpressionTopPlate(IEnumerable<int>, string) ...................... 3387
SetWeldWorksheetHAZDistanceTopPlate(IEnumerable<int>, double) .................................... 3387
SetWeldWorksheetHAZGrowthRate(IEnumerable<int>, double) ............................................. 3387
SetWeldWorksheetHeight(IEnumerable<int>, double) ........................................................... 3388
SetWeldWorksheetIntersectionTag(IEnumerable<int>, string) ................................................ 3388
SetWeldWorksheetLapAngleTol(IEnumerable<int>, double) .................................................. 3388
SetWeldWorksheetLength(IEnumerable<int>, double) ........................................................... 3389
SetWeldWorksheetMaxThicknessFactor(IEnumerable<int>, double) ....................................... 3389
SetWeldWorksheetMinThicknessFactor(IEnumerable<int>, double) ....................................... 3390
SetWeldWorksheetNumLayers(IEnumerable<int>, int) ........................................................... 3390
SetWeldWorksheetNumWelds(IEnumerable<int>, int) ............................................................ 3390
SetWeldWorksheetOffset1(IEnumerable<int>, double) .......................................................... 3391
SetWeldWorksheetOffset2(IEnumerable<int>, double) .......................................................... 3391
SetWeldWorksheetPitch(IEnumerable<int>, double) .............................................................. 3391
SetWeldWorksheetSharpAngle(IEnumerable<int>, double) .................................................... 3392

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxxiii
ACT API Reference Guide

SetWeldWorksheetSmoothing(IEnumerable<int>, bool) ........................................................ 3392


SetWeldWorksheetThickness(IEnumerable<int>, double) ....................................................... 3392
SetWeldWorksheetThicknessExpression(IEnumerable<int>, string) ........................................ 3393
SetWeldWorksheetTopEntities(IEnumerable<int>, uint) ......................................................... 3393
SetWeldWorksheetWeldAngle(IEnumerable<int>, double) ..................................................... 3394
SetWeldWorksheetWeldBody(IEnumerable<int>, uint) ........................................................... 3394
SetWeldWorksheetWeldCurve(IEnumerable<int>, uint) .......................................................... 3394
SetWeldWorksheetWeldHeightExpression(IEnumerable<int>, string) ..................................... 3395
SetWeldWorksheetWeldWidthExpression(IEnumerable<int>, string) ...................................... 3395
SetWeldWorksheetWidth(IEnumerable<int>, double) ............................................................ 3395
WeldWorksheetAddEntry() .................................................................................................... 3396
WeldWorksheetCreateControlForCurveBodies() ..................................................................... 3396
WeldWorksheetDeleteEntry(IEnumerable<int>) .................................................................... 3396
WeldWorksheetExport(string) ............................................................................................... 3396
WeldWorksheetImport(string) ............................................................................................... 3397
WeldWorksheetNumEntries() ................................................................................................ 3397
WeldWorksheetStatus(int) ..................................................................................................... 3397
Ansys.ACT.Automation.Mechanical.ImportedLoads Namespace .................................................. 3399
ImportedBodyForceDensity ........................................................................................................ 3400
DataModelObjectCategory ................................................................................................... 3403
InternalObject ...................................................................................................................... 3403
GetActivateAtLoadStep(uint) ................................................................................................ 3403
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3403
ImportedBodyTemperature ......................................................................................................... 3404
ApplyToInitialMesh ............................................................................................................... 3407
DataModelObjectCategory ................................................................................................... 3407
InternalObject ...................................................................................................................... 3407
LoadVectorAssignment ......................................................................................................... 3407
LoadVectorNumber .............................................................................................................. 3408
GetActivateAtLoadStep(uint) ................................................................................................ 3408
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3408
ImportedConvection ................................................................................................................... 3408
DataModelObjectCategory ................................................................................................... 3412
DisplayConnectionLines ........................................................................................................ 3412
FluidFlow .............................................................................................................................. 3412
FluidFlowLocation ................................................................................................................ 3412
InternalObject ...................................................................................................................... 3412
GetActivateAtLoadStep(uint) ................................................................................................ 3413
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3413
ImportedCutBoundaryRemoteConstraint .................................................................................... 3413
DataModelObjectCategory ................................................................................................... 3416
InternalObject ...................................................................................................................... 3417
GetActivateAtLoadStep(uint) ................................................................................................ 3417
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3417
ImportedCutBoundaryRemoteForce ............................................................................................ 3417
DataModelObjectCategory ................................................................................................... 3421
InternalObject ...................................................................................................................... 3421
GetActivateAtLoadStep(uint) ................................................................................................ 3421
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3421
ImportedDisplacement ............................................................................................................... 3422
ApplyToInitialMesh ............................................................................................................... 3425

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

DataModelObjectCategory ................................................................................................... 3425


DisplacementType ................................................................................................................ 3425
InternalObject ...................................................................................................................... 3425
GetActivateAtLoadStep(uint) ................................................................................................ 3425
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3426
ImportedElementOrientation ...................................................................................................... 3426
DataModelObjectCategory ................................................................................................... 3429
InternalObject ...................................................................................................................... 3429
ImportedFiberRatio .................................................................................................................... 3429
DataModelObjectCategory ................................................................................................... 3432
InternalObject ...................................................................................................................... 3433
ImportedForce ............................................................................................................................ 3433
DataModelObjectCategory ................................................................................................... 3436
InternalObject ...................................................................................................................... 3436
ImportedHeatFlux ....................................................................................................................... 3436
DataModelObjectCategory ................................................................................................... 3439
InternalObject ...................................................................................................................... 3439
ImportedHeatGeneration ............................................................................................................ 3440
DataModelObjectCategory ................................................................................................... 3443
InternalObject ...................................................................................................................... 3443
ImportedInitialStrain ................................................................................................................... 3443
DataModelObjectCategory ................................................................................................... 3446
InternalObject ...................................................................................................................... 3446
ImportedInitialStress ................................................................................................................... 3446
DataModelObjectCategory ................................................................................................... 3449
InternalObject ...................................................................................................................... 3449
ImportedLoad ............................................................................................................................ 3450
Algorithm ............................................................................................................................. 3452
ApplyAs ................................................................................................................................ 3452
BoundingBoxTolerance ......................................................................................................... 3452
Children ............................................................................................................................... 3452
Comments ............................................................................................................................ 3452
CreateNameSelectionForMappedNodes ................................................................................ 3452
CreateNameSelectionForOutsideNodes ................................................................................. 3453
CreateNameSelectionForUnmappedNodes ........................................................................... 3453
DataModelObjectCategory ................................................................................................... 3453
DisplayInteriorPoints ............................................................................................................. 3453
DisplayProjectionPlane ......................................................................................................... 3453
DisplaySourcePointIds .......................................................................................................... 3453
DisplaySourcePoints ............................................................................................................. 3454
ExtrapolationTolerancePercent .............................................................................................. 3454
Figures ................................................................................................................................. 3454
Images ................................................................................................................................. 3454
InternalObject ...................................................................................................................... 3454
Interpolation ........................................................................................................................ 3454
KrigingCorrelationFunction ................................................................................................... 3455
KrigingPolynom .................................................................................................................... 3455
Limit ..................................................................................................................................... 3455
Location ............................................................................................................................... 3455
MappedNodesName ............................................................................................................. 3455
Mapping ............................................................................................................................... 3455

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxxv
ACT API Reference Guide

MappingControl ................................................................................................................... 3456


MaxOutsideDistance ............................................................................................................. 3456
Method ................................................................................................................................ 3456
NumberOfPoints ................................................................................................................... 3456
OrientationRealignment ....................................................................................................... 3456
OutsideDistanceCheck .......................................................................................................... 3456
OutsideNodesName .............................................................................................................. 3457
OutsideOption ...................................................................................................................... 3457
Pinball .................................................................................................................................. 3457
Projection ............................................................................................................................. 3457
RigidBodyTransformationType .............................................................................................. 3457
RigidTransformSourceCoordinateSystem ............................................................................... 3457
RigidTransformTargetCoordinateSystem ............................................................................... 3458
SharedRefBody ..................................................................................................................... 3458
ShellThicknessFactor ............................................................................................................. 3458
SourceMaximum ................................................................................................................... 3458
SourceMinimum ................................................................................................................... 3458
Suppressed ........................................................................................................................... 3458
UnmappedNodesName ........................................................................................................ 3459
VariableType ......................................................................................................................... 3459
Weighting ............................................................................................................................. 3459
AddComment() ..................................................................................................................... 3459
AddFigure() .......................................................................................................................... 3459
AddImage(string) .................................................................................................................. 3459
AddMappingValidation() ....................................................................................................... 3460
ClearGeneratedData() ........................................................................................................... 3460
Delete() ................................................................................................................................ 3460
ExportToTextFile(string) ........................................................................................................ 3460
GetActivateAtLoadStep(uint) ................................................................................................ 3461
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3461
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3461
Import() ................................................................................................................................ 3462
ImportLoad() ........................................................................................................................ 3462
ReloadConfiguration() ........................................................................................................... 3462
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3462
ImportedLoadGroup ................................................................................................................... 3463
Children ............................................................................................................................... 3465
Comments ............................................................................................................................ 3465
DataModelObjectCategory ................................................................................................... 3465
DeleteMappedDataFilesAfterImport ...................................................................................... 3465
Figures ................................................................................................................................. 3465
FilesDirectory ....................................................................................................................... 3466
Images ................................................................................................................................. 3466
InternalObject ...................................................................................................................... 3466
ResultFile .............................................................................................................................. 3466
ResultFileTimestamp ............................................................................................................. 3466
ResultFileUnitSystem ............................................................................................................ 3466
Source .................................................................................................................................. 3467
SourceDimension ................................................................................................................. 3467
Suppressed ........................................................................................................................... 3467
TransferStep ......................................................................................................................... 3467

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

TransferTemperaturesDuringSolve ........................................................................................ 3467


AddComment() ..................................................................................................................... 3467
AddFigure() .......................................................................................................................... 3468
AddImage(string) .................................................................................................................. 3468
AddImportedBodyForceDensity() .......................................................................................... 3468
AddImportedBodyTemperature() .......................................................................................... 3468
AddImportedCFDPressure() .................................................................................................. 3468
AddImportedConvection() .................................................................................................... 3469
AddImportedCutBoundaryConstraint() .................................................................................. 3469
AddImportedCutBoundaryRemoteConstraint() ...................................................................... 3469
AddImportedCutBoundaryRemoteForce() ............................................................................. 3469
AddImportedDisplacement() ................................................................................................. 3469
AddImportedElementOrientation() ....................................................................................... 3469
AddImportedFiberRatio() ...................................................................................................... 3470
AddImportedForce() ............................................................................................................. 3470
AddImportedHeatFlux() ........................................................................................................ 3470
AddImportedHeatGeneration() ............................................................................................. 3470
AddImportedInitialStrain() .................................................................................................... 3470
AddImportedInitialStress() .................................................................................................... 3470
AddImportedMaterialField() .................................................................................................. 3471
AddImportedPressure() ......................................................................................................... 3471
AddImportedSurfaceForceDensity() ...................................................................................... 3471
AddImportedTemperature() .................................................................................................. 3471
AddImportedThickness() ....................................................................................................... 3471
AddImportedTrace() .............................................................................................................. 3471
AddImportedVelocity() ......................................................................................................... 3472
AddImportedWarpWeftRatio() ............................................................................................... 3472
AddImportedYarnAngle() ...................................................................................................... 3472
ClearGeneratedData() ........................................................................................................... 3472
CreateBodyForceDensitiesAndSyncAnalysisSettings() ............................................................ 3472
CreateExternalLoadVelocitiesAndSyncAnalysisSettings() ........................................................ 3472
CreateSurfaceForceDensitiesAndSyncAnalysisSettings() ........................................................ 3473
Delete() ................................................................................................................................ 3473
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3473
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3473
GetExternalDataFiles() ........................................................................................................... 3474
ImportExternalDataFiles(ExternalDataFileCollection) ............................................................. 3474
ImportLoad() ........................................................................................................................ 3474
RefreshImportedLoad() ......................................................................................................... 3475
ReloadExternalDataFiles() ..................................................................................................... 3475
SetResultFile(string, WBUnitSystemType) ............................................................................... 3475
ImportedMaterialField ................................................................................................................ 3475
DataModelObjectCategory ................................................................................................... 3478
InternalObject ...................................................................................................................... 3479
ImportedPressure ....................................................................................................................... 3479
AppliedBy ............................................................................................................................. 3482
DataModelObjectCategory ................................................................................................... 3482
InternalObject ...................................................................................................................... 3482
LoadVectorAssignment ......................................................................................................... 3482
LoadVectorNumber .............................................................................................................. 3483
LoadVectorNumberImaginary ............................................................................................... 3483

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxxvii
ACT API Reference Guide

ImportedSurfaceForceDensity ..................................................................................................... 3483


DataModelObjectCategory ................................................................................................... 3486
InternalObject ...................................................................................................................... 3486
GetActivateAtLoadStep(uint) ................................................................................................ 3486
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3487
ImportedTemperature ................................................................................................................ 3487
DataModelObjectCategory ................................................................................................... 3490
InternalObject ...................................................................................................................... 3490
GetActivateAtLoadStep(uint) ................................................................................................ 3490
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3491
ImportedThickness ..................................................................................................................... 3491
DataModelObjectCategory ................................................................................................... 3494
InternalObject ...................................................................................................................... 3494
ImportedTrace ............................................................................................................................ 3494
DataModelObjectCategory ................................................................................................... 3498
InternalObject ...................................................................................................................... 3498
Layers ................................................................................................................................... 3498
Vias ...................................................................................................................................... 3498
GetActivateAtLoadStep(uint) ................................................................................................ 3498
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3499
ImportedVelocity ........................................................................................................................ 3499
CutoffFrequency ................................................................................................................... 3502
DataModelObjectCategory ................................................................................................... 3502
InternalObject ...................................................................................................................... 3503
MappedData ........................................................................................................................ 3503
MaximumTimeRange ............................................................................................................ 3503
MinimumTimeRange ............................................................................................................ 3503
SourceTimeDefinitionType .................................................................................................... 3503
WindowType ........................................................................................................................ 3503
GetActivateAtLoadStep(uint) ................................................................................................ 3504
SetActivateAtLoadStep(uint, bool) ......................................................................................... 3504
ImportedWarpWeftRatio ............................................................................................................. 3504
DataModelObjectCategory ................................................................................................... 3507
InternalObject ...................................................................................................................... 3507
ImportedYarnAngle .................................................................................................................... 3508
DataModelObjectCategory ................................................................................................... 3511
InternalObject ...................................................................................................................... 3511
Ansys.ACT.Automation.Mechanical.ConstructionLines Namespace ............................................. 3513
ConstructionLine ........................................................................................................................ 3513
Comments ............................................................................................................................ 3514
DataModelObjectCategory ................................................................................................... 3515
Edges ................................................................................................................................... 3515
Figures ................................................................................................................................. 3515
Images ................................................................................................................................. 3515
InternalObject ...................................................................................................................... 3515
Planes ................................................................................................................................... 3515
Points ................................................................................................................................... 3516
AddComment() ..................................................................................................................... 3516
AddFigure() .......................................................................................................................... 3516
AddImage(string) .................................................................................................................. 3516
AddToGeometry() ................................................................................................................. 3516

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

CreatePlanarPoints(Plane, IEnumerable<object>) .................................................................. 3517


CreatePlane(object) .............................................................................................................. 3517
CreatePoints(IEnumerable<object>) ...................................................................................... 3517
CreateStraightLines(IEnumerable<Point>) ............................................................................. 3518
CreateStraightLines(IEnumerable<Point>, IEnumerable<IEnumerable<object>>) .................. 3518
DeleteEdges(IEnumerable<IEdge>) ....................................................................................... 3518
DeletePlane(Plane, bool) ....................................................................................................... 3519
FlipEdges(IEnumerable<IEdge>) ........................................................................................... 3519
GetPartFromGeometry() ....................................................................................................... 3519
Redo() .................................................................................................................................. 3519
RemoveFromGeometry() ....................................................................................................... 3520
Undo() .................................................................................................................................. 3520
UpdateGeometry() ................................................................................................................ 3520
Ansys.ACT.Automation.Mechanical.Connections Namespace ....................................................... 3521
AMBondConnection ................................................................................................................... 3521
Children ............................................................................................................................... 3522
Comments ............................................................................................................................ 3523
ContactBodies ...................................................................................................................... 3523
ContactType ......................................................................................................................... 3523
DataModelObjectCategory ................................................................................................... 3523
Figures ................................................................................................................................. 3523
Images ................................................................................................................................. 3523
InternalObject ...................................................................................................................... 3524
SourceLocation ..................................................................................................................... 3524
Suppressed ........................................................................................................................... 3524
TargetBodies ......................................................................................................................... 3524
TargetLocation ...................................................................................................................... 3524
AddCommandSnippet() ........................................................................................................ 3524
AddComment() ..................................................................................................................... 3525
AddFigure() .......................................................................................................................... 3525
AddImage(string) .................................................................................................................. 3525
Delete() ................................................................................................................................ 3525
FlipContactTarget() ............................................................................................................... 3525
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3526
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3526
RenameBasedOnDefinition() ................................................................................................. 3526
SearchConnectionsForDuplicatePairs() .................................................................................. 3527
Beam .......................................................................................................................................... 3527
BeamElementAPDLName ...................................................................................................... 3528
Children ............................................................................................................................... 3528
Comments ............................................................................................................................ 3529
CrossSection ......................................................................................................................... 3529
DataModelObjectCategory ................................................................................................... 3529
Figures ................................................................................................................................. 3529
Images ................................................................................................................................. 3529
InternalObject ...................................................................................................................... 3529
Material ................................................................................................................................ 3530
MobileAppliedBy .................................................................................................................. 3530
MobileBeamMaterial ............................................................................................................. 3530
MobileBeamRadius ............................................................................................................... 3530
MobileBehavior .................................................................................................................... 3530

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxxix
ACT API Reference Guide

MobileBody .......................................................................................................................... 3530


MobileCoordinateSystem ...................................................................................................... 3531
MobileLocation ..................................................................................................................... 3531
MobileNodeId ....................................................................................................................... 3531
MobilePinballRegion ............................................................................................................. 3531
MobileXCoordinate ............................................................................................................... 3531
MobileYCoordinate ............................................................................................................... 3531
MobileZCoordinate ............................................................................................................... 3532
Radius .................................................................................................................................. 3532
ReferenceAppliedBy ............................................................................................................. 3532
ReferenceBeamMaterial ........................................................................................................ 3532
ReferenceBeamRadius .......................................................................................................... 3532
ReferenceBehavior ................................................................................................................ 3532
ReferenceBody ..................................................................................................................... 3533
ReferenceCoordinateSystem ................................................................................................. 3533
ReferenceLocation ................................................................................................................ 3533
ReferenceLocationPoint ........................................................................................................ 3533
ReferenceNodeId .................................................................................................................. 3533
ReferencePinballRegion ........................................................................................................ 3533
ReferenceXCoordinate .......................................................................................................... 3534
ReferenceYCoordinate .......................................................................................................... 3534
ReferenceZCoordinate .......................................................................................................... 3534
Scope ................................................................................................................................... 3534
Suppressed ........................................................................................................................... 3534
Visible .................................................................................................................................. 3534
AddCommandSnippet() ........................................................................................................ 3535
AddComment() ..................................................................................................................... 3535
AddFigure() .......................................................................................................................... 3535
AddImage(string) .................................................................................................................. 3535
Delete() ................................................................................................................................ 3535
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3536
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3536
PromoteToNamedSelection() ................................................................................................ 3536
PromoteToRemotePoint() ...................................................................................................... 3537
RenameBasedOnDefinition() ................................................................................................. 3537
Bearing ....................................................................................................................................... 3537
AnsBCType ........................................................................................................................... 3539
Children ............................................................................................................................... 3539
Comments ............................................................................................................................ 3539
ConnectionType ................................................................................................................... 3539
DampingC11 ........................................................................................................................ 3539
DampingC12 ........................................................................................................................ 3539
DampingC21 ........................................................................................................................ 3540
DampingC22 ........................................................................................................................ 3540
DataModelObjectCategory ................................................................................................... 3540
Figures ................................................................................................................................. 3540
Images ................................................................................................................................. 3540
InternalObject ...................................................................................................................... 3540
MobileBeamMaterial ............................................................................................................. 3541
MobileBeamRadius ............................................................................................................... 3541
MobileBehavior .................................................................................................................... 3541

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxxx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

MobileBody .......................................................................................................................... 3541


MobileCoordinateSystem ...................................................................................................... 3541
MobileLocation ..................................................................................................................... 3541
MobilePinballSize ................................................................................................................. 3542
MobileXCoordinate ............................................................................................................... 3542
MobileYCoordinate ............................................................................................................... 3542
MobileZCoordinate ............................................................................................................... 3542
ReferenceBeamMaterial ........................................................................................................ 3542
ReferenceBeamRadius .......................................................................................................... 3542
ReferenceBehavior ................................................................................................................ 3543
ReferenceBodyName ............................................................................................................ 3543
ReferenceCoordinateSystem ................................................................................................. 3543
ReferenceLocation ................................................................................................................ 3543
ReferencePinballRegion ........................................................................................................ 3543
ReferenceRotationPlane ........................................................................................................ 3543
ReferenceSet ***OBSOLETE*** Use 'ReferenceLocation' property instead. ............................... 3544
ReferenceXCoordinate .......................................................................................................... 3544
ReferenceYCoordinate .......................................................................................................... 3544
ReferenceZCoordinate .......................................................................................................... 3544
StiffnessK11 .......................................................................................................................... 3544
StiffnessK12 .......................................................................................................................... 3544
StiffnessK21 .......................................................................................................................... 3545
StiffnessK22 .......................................................................................................................... 3545
Suppressed ........................................................................................................................... 3545
AddCommandSnippet() ........................................................................................................ 3545
AddComment() ..................................................................................................................... 3545
AddFigure() .......................................................................................................................... 3545
AddImage(string) .................................................................................................................. 3546
Delete() ................................................................................................................................ 3546
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3546
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3547
PromoteToNamedSelection() ................................................................................................ 3547
PromoteToRemotePoint() ...................................................................................................... 3547
RenameBasedOnDefinition() ................................................................................................. 3547
BodyInteraction .......................................................................................................................... 3548
Breakable ............................................................................................................................. 3549
Children ............................................................................................................................... 3549
Comments ............................................................................................................................ 3549
ContactType ......................................................................................................................... 3549
DataModelObjectCategory ................................................................................................... 3549
DecayConstant ..................................................................................................................... 3549
DynamicCoefficient .............................................................................................................. 3550
Figures ................................................................................................................................. 3550
FrictionCoefficient ................................................................................................................ 3550
Images ................................................................................................................................. 3550
InternalObject ...................................................................................................................... 3550
Location ............................................................................................................................... 3550
MaximumOffset .................................................................................................................... 3551
NormalForceExponent .......................................................................................................... 3551
NormalForceLimit ................................................................................................................. 3551
NormalStressExponent ......................................................................................................... 3551

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. clxxxi
ACT API Reference Guide

NormalStressLimit ................................................................................................................ 3551


ShearForceExponent ............................................................................................................. 3551
ShearForceLimit .................................................................................................................... 3552
ShearStressExponent ............................................................................................................ 3552
ShearStressLimit ................................................................................................................... 3552
Suppressed ........................................................................................................................... 3552
AddComment() ..................................................................................................................... 3552
AddFigure() .......................................................................................................................... 3552
AddImage(string) .................................................................................................................. 3553
Delete() ................................................................................................................................ 3553
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3553
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3554
BodyInteractions ........................................................................................................................ 3554
BodySelfContact ................................................................................................................... 3555
Children ............................................................................................................................... 3555
Comments ............................................................................................................................ 3555
ContactDetection ................................................................................................................. 3556
DataModelObjectCategory ................................................................................................... 3556
EdgeOnEdgeContact ............................................................................................................ 3556
ElementSelfContact .............................................................................................................. 3556
Figures ................................................................................................................................. 3556
Formulation .......................................................................................................................... 3556
Images ................................................................................................................................. 3557
InternalObject ...................................................................................................................... 3557
LimitingTimestepVelocity ...................................................................................................... 3557
ManualContactTreatment ..................................................................................................... 3557
NodalShellThickness ............................................................................................................. 3557
PinballFactor ......................................................................................................................... 3557
ShellThicknessFactor ............................................................................................................. 3558
SlidingContact ...................................................................................................................... 3558
TimestepSafetyFactor ........................................................................................................... 3558
Tolerance .............................................................................................................................. 3558
AddBodyInteraction() ............................................................................................................ 3558
AddComment() ..................................................................................................................... 3558
AddFigure() .......................................................................................................................... 3559
AddImage(string) .................................................................................................................. 3559
Delete() ................................................................................................................................ 3559
GetChildren<ChildrenType>(bool, IList<ChildrenType>) ........................................................ 3559
GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>) ............................... 3560
ConnectionGroup ....................................................................................................................... 3560
ActiveConnections ................................................................................................................ 3562
AutomaticFixedJoints ........................................................................................................... 3562
Children ............................................................................................................................... 3562
Comments ............................................................................................................................ 3562
Connections ......................................................................................................................... 3563
ConnectionType ................................................................................................................... 3563
CylindricalFaces .................................................................................................................... 3563
DataModelObjectCategory ................................................................................................... 3563
EdgeEdge ............................................................................................................................. 3563
EdgeOverlapTolerance .......................................................................................................... 3563
FaceAngleTolerance .............................................................................................................. 3564

Release 2025 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
clxxxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT API Reference Guide

FaceEdge .............................................................................................................................. 3564


FaceFace ............................................................................................................................... 3564
FaceFaceDetectionAngleTolerence ........................................................................................ 3564
FaceOverlapTolerance ........................................................................................................... 3564
Figures ................................................................................................................................. 3564
GroupBy ............................................................................................................................... 3565
Images ................................................................................................................................. 3565
InternalObject ...................................................................................................................... 3565
Location ............................................................................................................................... 3565
MinimumDistancePercentage ............................................................................................... 3565
MinimumDistanceValue ........................................................................................................ 3565
Priority ................................................................................................................................. 3566
RevoluteJoints ...................................................................................................................... 3566
Search